Home

Awesome

Code-Insight

CI codecov Scrutinizer Code Quality

Latest Stable Version Total Downloads License

Code-Insight is a tool for static analysis of other project source code.

Usage

For each analyzed project the .code-insight.json file needs to be placed at project root folder (e.g. where src folder is). Example configuration file:

{
    "finder": [
        {
            "name": "*.php",
            "in": ["src"]
        }
    ],
    "bc_checkers": ["class", "function", "constant"],
    "bc_ignore": [
        {
            "type": "constant.deleted",
            "element": "ADODB_DATE_VERSION",
            "why": "The ADODB DateTime library was removed."
        }
    ],
    "class_locator": "vendor/autoload.php"
}

Supported settings:

Commands

The bc command

...

The sync command

...

The report command

...

The missing-tests command

...

Installation

  1. download latest released PHAR file from https://github.com/console-helpers/code-insight/releases page.
  2. setup auto-completion by placing eval $(/path/to/code-insight.phar _completion --generate-hook -p code-insight.phar) in ~/.bashrc

Contributing

See CONTRIBUTING file.

License

Code-Insight is released under the BSD-3-Clause License. See the bundled LICENSE file for details.