 |
VOOZH | about |
|
VOOZH | about |
This page documents the static analysis, code style, automated refactoring, and dependency analysis tools used in the ai-commit project. It covers configuration details and how to run each tool. For information about the test suite itself, see Testing Framework. For CI integration of these tools, see CI/CD Workflows.
The project enforces quality through four primary tools:
| Tool | Package | Config File | Purpose |
|---|---|---|---|
| PHP-CS-Fixer | friendsofphp/php-cs-fixer | .php-cs-fixer.php | Code style formatting |
| PHPStan | phpstan/phpstan | phpstan.neon | Static type analysis |
| Rector | rector/rector | rector.php | Automated refactoring |
| composer-dependency-analyser | shipmonk/composer-dependency-analyser | composer-dependency-analyser.php | Dependency usage audit |
All four are invoked together by the checks Composer script, which also runs linting, magic number detection (phpmnd), and structural checks via rector/swiss-knife.
Tool relationships diagram:
Sources: composer.json222-242
Config file: .php-cs-fixer.php
The configuration uses ergebnis/php-cs-fixer-config as its foundation, specifically the Php82 preset from Ergebnis\PhpCsFixer\Config\RuleSet\Php82. It is instantiated via Ergebnis\PhpCsFixer\Config\Factory::fromRuleSet().
Every scanned PHP file is checked for the MIT license header. The header is generated dynamically using Ergebnis\License\Type\MIT with the year range starting from 2023, owner guanguans<ityaozm@gmail.com>, and URL https://github.com/guanguans/ai-commit. The generated LICENSE file is also saved on each run.
All non-deprecated fixers from PhpCsFixerCustomFixers\Fixers that are not already part of the Php82 rule set are automatically registered as additional fixers.
The following PHP migration rule sets are explicitly enabled on top of the Php82 base:
| Rule Set | Risky Variant |
|---|---|
@PHP70Migration | @PHP70Migration:risky |
@PHP71Migration | @PHP71Migration:risky |
@PHP73Migration | — |
@PHP74Migration | @PHP74Migration:risky |
@PHP80Migration | @PHP80Migration:risky |
@PHP81Migration | — |
@PHP82Migration | — |
Selected custom rule behaviours:
| Rule | Setting |
|---|---|
concat_space | spacing: none |
final_class | false |
native_function_invocation | @compiler_optimized + is_scalar, scope all |
phpdoc_align | left-aligned, spacing 1 |
phpdoc_line_span | const/property: single; method: multi |
php_unit_data_provider_name | prefix provide, suffix Cases |
static_lambda | false |
static_private_method | false (Pest compatibility) |
PHP-CS-Fixer scans:
app/, bootstrap/, config/, resources/, tests/.php files (excluding IDE helper files and .phpstorm.meta.php)ai-commit and composer-updater bin filesExcluded directories: __snapshots__, cache/, Fixtures/, lang/
Cache is stored at .build/php-cs-fixer/.php-cs-fixer.cache.
composer style-lint # dry-run check
composer style-fix # apply fixes
Config file: phpstan.neon
level: max
Analyzed paths: app/, bootstrap/, config/, resources/lang/
Temp output is written to .build/phpstan/. The editor URL format is configured for PhpStorm deep links.
The configuration composes a large set of PHPStan extensions:
Sources: phpstan.neon1-28
Additional dev-require extensions that are active via phpstan/extension-installer:
larastan/larastanphpstan/phpstan-deprecation-rulesphpstan/phpstan-mockeryphpstan/phpstan-strict-rulesphpstan/phpstan-webmozart-assertshipmonk/phpstan-baseline-per-identifiertomasvotruba/cognitive-complexitytomasvotruba/type-coveragerector/type-perfectpb30/phpstan-composer-analysisyamadashy/phpstan-friendly-formatterSources: composer.json95-123
All type coverage thresholds are set to 100%:
| Coverage Target | Required |
|---|---|
declare | 100% |
param_type | 100% |
return_type | 100% |
constant_type | 100% |
property_type | 100% |
| Scope | Limit |
|---|---|
| Class | 42 |
| Function/method | 8 |
| Dependency tree | 150 |
treatPhpDocTypesAsCertain is set to false.
| Setting | Value |
|---|---|
narrow_param | true |
narrow_return | true |
null_over_false | true |
no_mixed | false |
no_mixed_property | true |
no_mixed_caller | false |
The spaze/phpstan-disallowed-calls package is loaded with four built-in profiles (dangerous, execution, insecure, loose calls).
Additionally, a custom project rule disallows env_explode() with message: use config() instead.
exec() calls in app/Commands/ThanksCommand.php and app/ConfigManager.php are explicitly allowed via ignoreErrors.
phpstan.neon5-8 phpstan.neon77-112
PHPStan baselines are split per identifier under the baselines/ directory. The entry point baselines/loader.neon includes per-identifier baseline files. Currently the project has 1 baseline error (method.notFound).
composer phpstan # run analysis
composer phpstan-baseline # regenerate single baseline
composer phpstan-split-baseline # split baseline per identifier
Config file: rector.php
Rector targets PHP 8.2 (PhpVersion::PHP_82) and runs on:
app/, bootstrap/, resources/, tests/.php files (glob {*,.*}.php)ai-commit and composer-updater bin filesCache is stored at .build/rector/. Parallel execution is enabled.
Skipped paths: **.blade.php, **/__snapshots__/*, **/Fixtures/*, bootstrap/providers.php, and rector.php itself.
Sources: rector.php100-132
| Rule Class | Purpose |
|---|---|
AddSeeTestAnnotationRector | Adds @see annotations linking test classes |
ArraySpreadInsteadOfArrayMergeRector | Replaces array_merge with spread operator |
JsonThrowOnErrorRector | Adds JSON_THROW_ON_ERROR to json_* calls |
SimplifyListIndexRector | Simplifies list index access |
SortAssociativeArrayByKeyRector | Sorts associative arrays by key |
StaticArrowFunctionRector | Makes arrow functions static |
StaticClosureRector | Makes closures static |
All instantiable RectorLaravel\Rector rules | All applicable Laravel-specific rules |
Several rules have specific configuration applied:
AddNoinspectionsDocCommentToDeclareRector: injects PhpStorm noinspection hints for several common warningsNewExceptionToNewAnonymousExtendsExceptionImplementsRector: exceptions implement ThrowableContractRemoveNamespaceRector: removes Tests namespace from test filesRemoveAnnotationRector: strips inheritDoc, phpstan-ignore, phpstan-ignore-next-line, psalm-suppressRenameClassRector: renames Carbon\Carbon to Illuminate\Support\CarbonStaticCallToFuncCallRector: rewrites Str::of() calls to str()RenameFunctionRector: renames faker → fake, test → it, and several app helpers to namespaced form (App\Support\classes, App\Support\make)ChangeMethodVisibilityRector: changes private trait methods (except final) to protectedNotable rules that are disabled project-wide:
| Skipped Rule | Reason |
|---|---|
DisallowedEmptyRuleFixerRector | — |
FunctionLikeToFirstClassCallableRector | — |
EncapsedStringsToSprintfRector | — |
ExplicitBoolCompareRector | — |
ContainerBindConcreteWithClosureOnlyRector | Laravel-specific |
ThrowIfRector | Laravel-specific |
StaticArrowFunctionRector | Skipped in tests/ |
StaticClosureRector | Skipped in tests/ |
SortAssociativeArrayByKeyRector | Skipped in app/, bootstrap/, resources/, tests/ |
CompleteDynamicPropertiesRector | Skipped in app/Clients/AbstractClient.php |
JsonThrowOnErrorRector | Skipped in app/Generators/ |
ReplaceFakerInstanceWithHelperRector | — |
composer rector # apply refactorings
composer rector-dry-run # preview changes without applying
composer rector-list-rules # list all active rules
Config file: composer-dependency-analyser.php
This tool (package shipmonk/composer-dependency-analyser) verifies that:
require / require-dev dependenciesScanned paths (production + dev): app/, bootstrap/, config/, resources/, tests/
Excluded from scan: tests/ directory
composer-dependency-analyser.php18-31
Unused dependencies (packages present in require but with no detected direct class usage):
| Package | Reason |
|---|---|
laminas/laminas-text | Used indirectly |
laravel-lang/common | Language files only |
laravel-zero/phar-updater | Runtime usage pattern |
Shadow dependencies (used classes whose package is not in direct require):
| Package |
|---|
composer/xdebug-handler |
guzzlehttp/psr7 |
laravel-lang/config |
laravel-lang/locale-list |
laravel-lang/routes |
laravel-zero/foundation |
nunomaduro/laravel-console-summary |
psr/http-message |
psr/log |
symfony/console |
symfony/process |
Dev-dependency-in-prod:
| Package | Notes |
|---|---|
intonate/tinker-zero | Optional development tool |
composer-dependency-analyser.php32-71
composer composer-dependency-analyser
The rector/swiss-knife tool (sk scripts) provides several structural validation commands run as part of checks:
| Script | Command | What it checks |
|---|---|---|
sk-check-conflicts | sk check-conflicts app/ bootstrap/ config/ resources/ tests/ | Git merge conflict markers left in code |
sk-check-commented-code | sk check-commented-code ... --line-limit=6 | Commented-out code blocks (max 6 lines) |
sk-finalize-classes-dry-run | sk finalize-classes app/ --dry-run | Classes that can be marked final |
sk-spot-lazy-traits | sk spot-lazy-traits app/ | Traits used by only one class |
Sources: composer.json384-398
The composer checks script orchestrates all tools in order:
Sources: composer.json222-242
Git hooks (via brainmaestro/composer-git-hooks) run composer checks automatically on pre-commit and post-merge. See Development Environment Setup for hook installation details.
Refresh this wiki