coderg33k / typed-config-generator
Typed Classes for your Laravel configs!
Requires
- php: ^8.2
- illuminate/support: ^9.0|^10.0
- thecodingmachine/safe: ^2.5
Requires (Dev)
- dg/bypass-finals: ^1.5
- ergebnis/phpstan-rules: ^2.1
- nunomaduro/larastan: ^2.6
- orchestra/testbench: ^7.0|^8.0
- phpstan/phpstan: ^1.10
- phpstan/phpstan-deprecation-rules: ^1.1
- phpstan/phpstan-phpunit: ^1.3
- phpstan/phpstan-strict-rules: ^1.5
- phpunit/phpunit: ^9.0|^10.4
- rregeer/phpunit-coverage-check: ^0.3.1
- slevomat/coding-standard: ^8.14
- squizlabs/php_codesniffer: ^3.7
- thecodingmachine/phpstan-strict-rules: ^1.0
README
Are you a PHPStan lovin' strict programmer?! Say no more! This package will generate typed config classes for you based on your config files.
We all struggle with the mixed return type of the config() helper function. This package will stop your struggle and leave all your (unnecessary?) type checks behind you!
Installation
Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.
Step 1: Download the module
Open a command console, enter your project directory and execute:
$ composer require coderg33k/typed-config-generator
Step 2: using the module
By running the command php artisan coderg33k:generate the package will generate a typed config class for each config file in your config directory.
The command has a set of options to tweak the output.
Run php artisan coderg33k:generate --help to see the options.
| Option | Description |
|---|---|
--all |
Don't get a prompt and generate a class for all configs |
--no-strict |
Don't add strict typing to the generated classes |
--no-final |
Don't make the generated classes final |
--no-readonly |
Don't make the generated properties readonly |
--package= |
A string that represents a package, like laravel or spatie to generate the classes for |
--config=* |
A comma separated list of configs to generate classes for |
Testing
This package uses PHPUnit for unit and integration tests.
It can be run standalone by composer phpunit or within the complete checkup by composer checkup
Changelog
See the project changelog
Contributing
Contributions are always welcome. Please see CONTRIBUTING.md and CODE_OF_CONDUCT.md for details.
License
The MIT License (MIT). Please see License File for more information.