narrowspark / configurators
Automatic configurators for the narrowspark framework
Fund package maintenance!
prisis
Installs: 198
Dependents: 1
Suggesters: 0
Security: 0
Stars: 2
Watchers: 2
Forks: 2
Open Issues: 2
Type:automatic-configurator
Requires
- php: ^7.3
Requires (Dev)
- composer/composer: ^1.6.0 || ^1.7.1 || ^1.8.0 || ^1.9.0
- mockery/mockery: ^1.2.4
- narrowspark/automatic-common: ^0.13.0
- narrowspark/coding-standard: ^3.2.0
- narrowspark/testing-helper: ^8.0.2
- phpunit/phpunit: ^8.4.2
- slam/phpstan-extensions: ^3.6.1
This package is auto-updated.
Last update: 2023-03-26 08:28:26 UTC
README
Installation
composer require narrowspark/automatic narrowspark/configurators
Configurators
There are several types of tasks, which are called configurators:
options
, bootstrap
and providers
.
providers
Configurator
Turns on one or more service provider in the Narrowspark app by appending them to the serviceproviders.php
file.
Its value is an associative array where the key is the service provider class name and the value is an array of environments where it must be used.
The supported environments are local
, prod
, testing
and global
(which enables the service provider
in all environments):
{ "extra": { "automatic": { "providers": { "Viserio\\Component\\Routing\\Provider\\RoutingServiceProvider": [ "global" ], "Viserio\\Component\\Routing\\Provider\\RoutingDataCollectorServiceProvider": [ "testing" ] } } } }
The previous operation is transformed into the following PHP code:
// config/serviceproviders.php return [ /** > viserio/routing **/ \Viserio\Component\Routing\Provider\RoutingServiceProvider::class, /** viserio/routing < **/ ]; // config/testing/serviceproviders.php return [ /** > viserio/routing **/ \Viserio\Component\Routing\Provider\RoutingDataCollectorServiceProvider::class, /** viserio/routing < **/ ];
options
Configurator
Adds new config files to the config
folder provided from your root composer.json config-dir
name.
Note: the package name is taken to generate the file name.
This example creates a new view
config file in the packages
folder and packages/test
folder:
Note: the first array key is taken as environment key, like
global
ortest
in this example.
{ "extra": { "automatic": { "options": { "global": { "viserio": { "view": { "paths": null } } }, "test": { "viserio": { "view": { "paths": [ "./views/" ] } } } } } } }
bootstrap
Configurator
This example creates new bootstrap
configs for the console
and http
kernel:
you can choose between http
, console
and global
type to configure your kernel bootstraps,
with the possibility to configure bootstraps for your chosen environment.
Note: generates a new
bootstrap.php
file to theconfig
folder provided from your root composer.jsonconfig-dir
name, if the file doesn’t exists.
Note: the
global
type will configure both kernels.
{ "extra": { "automatic": { "bootstrap": { "Viserio\\Component\\Foundation\\Bootstrap\\LoadEnvironmentVariables": ["http"] } } } }
Contributing
If you would like to help take a look at the list of issues and check our Contributing guild.
Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Credits
License
The Narrowspark configurators is open-sourced software licensed under the MIT license