{"id":22666875,"url":"https://github.com/console-helpers/code-insight","last_synced_at":"2025-04-12T10:12:45.248Z","repository":{"id":54555785,"uuid":"50497150","full_name":"console-helpers/code-insight","owner":"console-helpers","description":"A tool for analysing other project code bases.","archived":false,"fork":false,"pushed_at":"2024-12-17T08:19:26.000Z","size":210,"stargazers_count":5,"open_issues_count":10,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-12T10:12:33.742Z","etag":null,"topics":["automation","cli","php","qa","static-analysis"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/console-helpers.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-01-27T09:40:17.000Z","updated_at":"2025-01-23T23:45:36.000Z","dependencies_parsed_at":"2024-07-07T19:23:38.937Z","dependency_job_id":"d7b61d49-d2f4-4840-95fb-20bf007becb6","html_url":"https://github.com/console-helpers/code-insight","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/console-helpers%2Fcode-insight","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/console-helpers%2Fcode-insight/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/console-helpers%2Fcode-insight/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/console-helpers%2Fcode-insight/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/console-helpers","download_url":"https://codeload.github.com/console-helpers/code-insight/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248550634,"owners_count":21122934,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","cli","php","qa","static-analysis"],"created_at":"2024-12-09T14:32:07.596Z","updated_at":"2025-04-12T10:12:45.226Z","avatar_url":"https://github.com/console-helpers.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Code-Insight\n\n[![CI](https://github.com/console-helpers/code-insight/workflows/CI/badge.svg)](https://github.com/console-helpers/code-insight/actions?query=workflow%3ACI)\n[![codecov](https://codecov.io/gh/console-helpers/code-insight/branch/master/graph/badge.svg)](https://codecov.io/gh/console-helpers/code-insight)\n[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/console-helpers/code-insight/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/console-helpers/code-insight/?branch=master)\n\n\n[![Latest Stable Version](https://poser.pugx.org/console-helpers/code-insight/v/stable)](https://packagist.org/packages/console-helpers/code-insight)\n[![Total Downloads](https://poser.pugx.org/console-helpers/code-insight/downloads)](https://packagist.org/packages/console-helpers/code-insight)\n[![License](https://poser.pugx.org/console-helpers/code-insight/license)](https://packagist.org/packages/console-helpers/code-insight)\n\nCode-Insight is a tool for static analysis of other project source code.\n\n## Usage\n\nFor 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:\n\n```json\n{\n    \"finder\": [\n        {\n            \"name\": \"*.php\",\n            \"in\": [\"src\"]\n        }\n    ],\n    \"bc_checkers\": [\"class\", \"function\", \"constant\"],\n    \"bc_ignore\": [\n        {\n            \"type\": \"constant.deleted\",\n            \"element\": \"ADODB_DATE_VERSION\",\n            \"why\": \"The ADODB DateTime library was removed.\"\n        }\n    ],\n    \"class_locator\": \"vendor/autoload.php\"\n}\n```\n\nSupported settings:\n\n* 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.\n* 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.\n* 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.\n* 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.\n\n### Commands\n\n#### The `bc` command\n\n...\n\n#### The `sync` command\n\n...\n\n#### The `report` command\n\n...\n\n#### The `missing-tests` command\n\n...\n\n## Installation\n\n1. download latest released PHAR file from https://github.com/console-helpers/code-insight/releases page.\n2. setup auto-completion by placing `eval $(/path/to/code-insight.phar _completion --generate-hook -p code-insight.phar)` in `~/.bashrc`\n\n## Contributing\n\nSee [CONTRIBUTING](CONTRIBUTING.md) file.\n\n## License\n\nCode-Insight is released under the BSD-3-Clause License. See the bundled [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconsole-helpers%2Fcode-insight","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconsole-helpers%2Fcode-insight","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconsole-helpers%2Fcode-insight/lists"}