trusted97 / whitecat

v1.0.0 2024-12-06 15:10 UTC

Requires

• php: ^8.2
• ext-json: *
• symfony/console: ^7.0
• symfony/filesystem: ^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.65
• phpstan/phpstan: ^2.0
• phpunit/phpunit: ^11
• symfony/var-dumper: ^7.0

MIT

• Gianluca Benucci

• dev
• developer-experience
• cli-library

Published on Packagist.org on 2024-12-06 15:06 UTC

README

Developer toolbox for avoid boring setup during development

Whitecat is a developer toolbox of cli command. Each command is thought for avoid boring setup in developing of PHP: Packages, Library, Composer Plugin or everything you're building!

Table of Contents

• Install
  • Usage
    • Docker setup
    • Github init
    • GitHub Workflow
    • GitHub Issue
    • GitHub Pull
    • PHP CS Fixer
    • PHPStan
    • PHPUnit
• Contributing
• License

Install

composer require --dev trusted97/whitecat

Usage

List the commands available in Whitecat:

vendor/bin/whitecat list

Every generator command writes to the current working directory by default. To target another project without changing directories, pass --working-dir:

vendor/bin/whitecat phpunit:init --working-dir=/path/to/project

Commands that depend on Composer tooling validate the target project's composer.json first and print the exact composer require --dev ... command when a dependency is missing.

Docker setup

This command setup basic docker environment for your library

vendor/bin/whitecat docker:setup

Github Init

This command setup basic .github directory and related files for your library

vendor/bin/whitecat github:init

GitHub Workflows

This command setup basic workflows for GitHub through actions

vendor/bin/whitecat github:workflow

GitHub Issue

This command setup basic issue template for your library

vendor/bin/whitecat github:issue

GitHub Pull

This command setup basic pull request template for your library

vendor/bin/whitecat github:pull

PHP CS Fixer

This command setup a basic PHP CS Fixer config file and check if in composer is installed

vendor/bin/whitecat php-cs-fixer:init

PHPStan

This command setup a basic PHPStan config file with starting level of 6 and check if in composer is installed

vendor/bin/whitecat phpstan:init

PHPUnit

This command setup a basic PHPUnit config file and check if in composer is installed

vendor/bin/whitecat phpunit:init

Compatibility

Repository Branch	PHP Compatibility	Status	Docs
1.x	^8.2	New features and bug fixes	Documentation 1.x

Contributing

Any questions, bug reports or suggestions for improvement are very welcome. See the contributing file for details on how to contribute.

License

Whitecat is licensed under the MIT license. See the LICENSE file for more information.