Code-Insight is a tool for static analysis of other project source code.
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:
finder
(array) setting is a list of JSON objects. Each object key is a name, and each value an argument for the methods in the Symfony\Component\Finder\Finder class. If an array of values is provided for a single key, the method will be called once per value in the array. Note that the paths specified for the in
method are relative to project base path.bc_checkers
(array) setting is a list of BC checker names. Possible BC checkers are: class
, function
, constant
, inportal_class
. If setting isn't specified, then default value of ['class', 'function', 'constant']
is used.bc_ignore
(array) setting is a list of JSON objects. Each object represents a rule, that prevents a particular BC break or BC break group from being reported. The actual objects to specify in here can be found in output of bc
command, when executed with --format=json
option.class_locator
(string) setting is a path to Composer's autoload.php
file or file, that returns closure accepting FQCN in 1st argument and returning absolute path with that class declaration....
...
...
Themissing-tests
command
...
eval $(/path/to/code-insight.phar _completion --generate-hook -p code-insight.phar)
in ~/.bashrc
See CONTRIBUTING file.
Code-Insight is released under the BSD-3-Clause License. See the bundled LICENSE file for details.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4