Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/console-helpers/code-insight
A tool for analysing other project code bases.
https://github.com/console-helpers/code-insight
automation cli php qa static-analysis
Last synced: 2 months ago
JSON representation
A tool for analysing other project code bases.
- Host: GitHub
- URL: https://github.com/console-helpers/code-insight
- Owner: console-helpers
- License: bsd-3-clause
- Created: 2016-01-27T09:40:17.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-07-15T14:35:54.000Z (7 months ago)
- Last Synced: 2024-07-15T17:43:27.541Z (7 months ago)
- Topics: automation, cli, php, qa, static-analysis
- Language: PHP
- Homepage:
- Size: 236 KB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Code-Insight
[](https://github.com/console-helpers/code-insight/actions?query=workflow%3ACI)
[](https://codecov.io/gh/console-helpers/code-insight)
[](https://scrutinizer-ci.com/g/console-helpers/code-insight/?branch=master)
[](https://packagist.org/packages/console-helpers/code-insight)
[](https://packagist.org/packages/console-helpers/code-insight)
[](https://packagist.org/packages/console-helpers/code-insight)
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:
```json
{
"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:
* The `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](https://github.com/symfony/finder/blob/master/Finder.php) 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.
* The `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.
* The `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.
* The `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.
### 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](CONTRIBUTING.md) file.
## License
Code-Insight is released under the BSD-3-Clause License. See the bundled [LICENSE](LICENSE) file for details.