 |
VOOZH | about |
|
VOOZH | about |
This document provides instructions for setting up a local development environment for the ai-commit project. It covers system requirements, installation methods, development dependencies, and environment configuration necessary for contributing to or extending the codebase.
For information about running tests after setup, see Testing Framework. For information about code quality tools and linting, see Code Quality Tools. For building and packaging the application, see Build and Release Process.
The ai-commit project requires specific PHP versions and extensions to function correctly.
| Requirement | Version/Status | Purpose |
|---|---|---|
| PHP | >= 8.2 | Core language requirement |
ext-curl | Required | HTTP client for AI API requests |
ext-mbstring | Required | Multi-byte string handling |
Sources: composer.json58-61
The codebase is configured to support PHP 8.2 through 8.4, with testing performed across this range.
Sources: composer.json58-61 rector.php102
This method is suitable for end-users but not for development, as the PHAR is a compiled artifact.
Sources: README.md39-44
For development work, install the project using Composer to access the full source code and development tools.
Development Installation Workflow:
Sources: README.md46-51 composer.json186-190
The application relies on Laravel Zero as its foundation, with additional libraries for AI integration and text processing.
Key Dependencies:
| Package | Version | Purpose |
|---|---|---|
laravel-zero/framework | ^12.0 | CLI application framework |
laravel/framework | ^12.36 | Core Laravel components |
guzzlehttp/guzzle | ^7.10 | HTTP client for API requests |
laminas/laminas-text | ^2.12 | Text manipulation utilities |
laravel-zero/phar-updater | ^1.4 | Self-update functionality |
Sources: composer.json58-68
The project includes extensive development tooling for code quality, testing, and analysis.
Critical Development Tools:
| Tool | Version | Purpose |
|---|---|---|
pestphp/pest | ^3.8 || ^4.0 | Modern testing framework |
phpstan/phpstan | ^2.1 | Static analysis |
rector/rector | ^2.2 | Automated refactoring |
friendsofphp/php-cs-fixer | ^3.88 | Code style fixing |
larastan/larastan | ^3.7 | Laravel-specific PHPStan rules |
Sources: composer.json69-124
Essential Configuration Files:
| File | Purpose | Referenced By |
|---|---|---|
composer.json | Dependency management and scripts | Composer, CI/CD |
bootstrap/app.php | Application bootstrap and service registration | Laravel Zero |
phpunit.xml.dist | PHPUnit test configuration | Pest, CI tests |
rector.php | Code refactoring rules | Rector commands |
composer-dependency-analyser.php | Dependency analysis configuration | Composer scripts |
Sources: composer.json133-148 bootstrap/app.php1-117 phpunit.xml.dist1-43
Composer automatically runs several setup tasks after installation.
Post-Install Scripts:
The following scripts execute automatically after composer install:
@cghooks add --ignore-lock - Installs Git hooks for commit quality checks@cghooks update - Updates hook configurations@composer-bin-all-update - Updates binary plugin dependenciesPost-Update Scripts:
After composer update, additional tasks run:
@artisan vendor:publish --tag=laravel-assets --force - Publishes Laravel assets@artisan lang:update - Updates language files@cghooks update - Re-applies Git hooks@composer-bin-all-update - Updates tool dependencies@composer-diff - Shows dependency changesSources: composer.json186-197
The project uses brainmaestro/composer-git-hooks to enforce code quality before commits.
Hook Behavior:
composer checks before allowing commitscomposer checks after merging branchesThese hooks ensure code quality by running linting, testing, and static analysis automatically.
Sources: composer.json176-183
The application bootstrap process is defined in bootstrap/app.php and handles critical initialization.
Bootstrap Sequence:
Key Bootstrap Actions:
GeneratorManager registered as singletonConfigManager::load() called during bootSources: bootstrap/app.php36-116
The ConfigManager loads configuration from multiple sources during bootstrap.
Configuration Sources (in order of precedence):
config/ai-commit.php)~/.ai-commit/.ai-commit.json)./.ai-commit.json)Sources: bootstrap/app.php40-42
After installation, verify the environment is correctly configured.
The project includes comprehensive check scripts.
Sources: composer.json222-242
Verify all dependencies are correctly installed and compatible.
Sources: composer.json248-249 composer.json264
The project provides numerous Composer scripts for development tasks.
Testing Scripts:
| Script | Command | Purpose |
|---|---|---|
test / pest | composer test | Run full test suite with coverage |
test-bail | composer pest-bail | Stop on first failure |
test-coverage | composer pest-coverage | Generate HTML coverage report |
Code Quality Scripts:
| Script | Command | Purpose |
|---|---|---|
style-lint | composer style-lint | Check code style without fixing |
style-fix | composer style-fix | Fix code style issues |
phpstan | composer phpstan | Run static analysis |
rector-dry-run | composer rector-dry-run | Preview refactoring changes |
Utility Scripts:
| Script | Command | Purpose |
|---|---|---|
artisan | composer artisan | Run Artisan commands |
checks | composer checks | Run all quality checks |
lint | composer lint | PHP syntax checking |
Sources: composer.json185-439
PHPStan Configuration:
PHPStan is configured via phpstan.neon (not shown in provided files, but referenced by scripts).
Sources: composer.json342-343
Rector Configuration:
Rector is extensively configured in rector.php with PHP 8.2 as the target version.
Key Rector Settings:
app/, bootstrap/, resources/, tests/Sources: rector.php71-297
Dependency Analyzer Configuration:
The dependency analyzer is configured in composer-dependency-analyser.php.
Analyzed Paths:
app/bootstrap/config/resources/tests/Ignored Dependencies:
laminas/laminas-text - Unused but requiredlaravel-lang/common - Unused but requiredlaravel-zero/phar-updater - Unused but requiredSources: composer-dependency-analyser.php17-71
Problem: PHP version is below 8.2
Solution:
Problem: ext-curl or ext-mbstring not found
Solution:
Problem: Composer runs out of memory during installation
Solution:
Sources: composer.json270
Problem: Git hooks prevent commits after installation
Solution:
Sources: composer.json214-221
Problem: Cannot execute downloaded ai-commit file
Solution:
After completing the development environment setup:
Sources: README.md241-267 composer.json1-479
Refresh this wiki