How trusted97/whitecat works
Whitecat is a PHP developer-toolbox CLI that generates setup files in the current or specified project directory. A user selects a registered command; the command delegates to a generator service, which creates directories and copies bundled templates, optionally checking Composer dependencies for PHP tooling. The documented capabilities include Docker setup, GitHub repository files, issue and pull-request templates, workflows, PHP CS Fixer, PHPStan, and PHPUnit. Service/helper relationships are supported by the source index and excerpts; unsampled generator details are not expanded beyond documented capabilities.
Main entry points: WhitecatApplicationFactory.php Command application · FileCopyHelper.php File copy · DirectoryPath.php Path constants · PhpUnitService.php PHPUnit setup
Components 25
CLI entry
- Command application
src/Console/WhitecatApplicationFactory.php - Base command
src/Command/AbstractWhitecatCommand.php - Docker command
src/Command/DockerSetupCommand.php - GitHub init command
src/Command/GithubInitCommand.php - Issue command
src/Command/GithubIssueCommand.php - Pull request command
src/Command/GithubPullCommand.php - Workflow command
src/Command/GithubWorkflowCommand.php - CS Fixer command
src/Command/PhpCsFixerCommand.php - PHPStan command
src/Command/PhpStanCommand.php - PHPUnit command
src/Command/PhpUnitCommand.php
GitHub generators
- GitHub init generator
src/Service/GithubInitService.php - Issue templates
src/Service/GithubIssueService.php - Pull templates
src/Service/GithubPullService.php - Workflow generator
src/Service/GithubWorkflowService.php
Project setup
- Docker setup
src/Service/DockerSetupService.php - CS Fixer setup
src/Service/PhpCsFixerService.php - PHPStan setup
src/Service/PhpStanService.php - PHPUnit setup
src/Service/PhpUnitService.php
Shared internals
- File copy
src/Helper/FileCopyHelper.php - Directory copy
src/Helper/DirectoryCopyHelper.php - Composer package check
src/Helper/ComposerPackageChecker.php - Composer reader
src/Helper/ComposerHelper.php - Invalid Composer error
src/Exception/InvalidComposerException.php - Path constants
src/Enums/DirectoryPath.php
Other components
- Project developer
Connections 40
- Project developer → Command application: runs CLI
README.md - Command application → Docker command: registers
src/Console/WhitecatApplicationFactory.php - Command application → GitHub init command: registers
src/Console/WhitecatApplicationFactory.php - Command application → Issue command: registers
src/Console/WhitecatApplicationFactory.php - Command application → Pull request command: registers
src/Console/WhitecatApplicationFactory.php - Command application → Workflow command: registers
src/Console/WhitecatApplicationFactory.php - Command application → CS Fixer command: registers
src/Console/WhitecatApplicationFactory.php - Command application → PHPStan command: registers
src/Console/WhitecatApplicationFactory.php - Command application → PHPUnit command: registers
src/Console/WhitecatApplicationFactory.php - Docker command → Docker setup: delegates
src/Command/DockerSetupCommand.php - GitHub init command → GitHub init generator: delegates
src/Command/GithubInitCommand.php - Issue command → Issue templates: delegates
src/Command/GithubIssueCommand.php - Pull request command → Pull templates: delegates
src/Command/GithubPullCommand.php - Workflow command → Workflow generator: delegates
src/Command/GithubWorkflowCommand.php - CS Fixer command → CS Fixer setup: delegates
src/Command/PhpCsFixerCommand.php - PHPStan command → PHPStan setup: delegates
src/Command/PhpStanCommand.php - PHPUnit command → PHPUnit setup: delegates
src/Command/PhpUnitCommand.php - GitHub init generator → File copy: copies files
src/Service/GithubInitService.php - Issue templates → File copy: copies templates
src/Service/GithubIssueService.php - Pull templates → File copy: copies templates
src/Service/GithubPullService.php - Workflow generator → File copy: copies workflows
src/Service/GithubWorkflowService.php - Docker setup → File copy: copies compose
src/Service/DockerSetupService.php - Docker setup → Directory copy: copies directory
src/Service/DockerSetupService.php - CS Fixer setup → File copy: copies config
src/Service/PhpCsFixerService.php - PHPStan setup → File copy: copies config
src/Service/PhpStanService.php - PHPUnit setup → File copy: copies config
src/Service/PhpUnitService.php - PHPUnit setup → Directory copy: copies directory
src/Service/PhpUnitService.php - CS Fixer setup → Composer package check: checks package
src/Service/PhpCsFixerService.php - PHPStan setup → Composer package check: checks package
src/Service/PhpStanService.php - PHPUnit setup → Composer package check: checks package
src/Service/PhpUnitService.php - Composer package check → Composer reader: reads manifest
src/Helper/ComposerPackageChecker.php - Composer reader → Invalid Composer error: throws
src/Helper/ComposerHelper.php - GitHub init generator → Path constants: uses paths
src/Service/GithubInitService.php - Issue templates → Path constants: uses paths
src/Service/GithubIssueService.php - Pull templates → Path constants: uses paths
src/Service/GithubPullService.php - Workflow generator → Path constants: uses paths
src/Service/GithubWorkflowService.php - Docker setup → Path constants: uses paths
src/Service/DockerSetupService.php - CS Fixer setup → Path constants: uses paths
src/Service/PhpCsFixerService.php - PHPStan setup → Path constants: uses paths
src/Service/PhpStanService.php - PHPUnit setup → Path constants: uses paths
src/Service/PhpUnitService.php