https://github.com/yiisoft/composer-config-plugin
Composer plugin for config assembling
https://github.com/yiisoft/composer-config-plugin
composer-plugin configuration-management hacktoberfest
Last synced: 3 months ago
JSON representation
Composer plugin for config assembling
- Host: GitHub
- URL: https://github.com/yiisoft/composer-config-plugin
- Owner: yiisoft
- License: bsd-3-clause
- Archived: true
- Created: 2020-03-22T09:25:47.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-07-06T05:06:01.000Z (almost 3 years ago)
- Last Synced: 2024-04-15T03:05:33.886Z (about 1 year ago)
- Topics: composer-plugin, configuration-management, hacktoberfest
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 493 KB
- Stars: 31
- Watchers: 12
- Forks: 15
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Composer Config Plugin
Composer plugin for config assembling.
> ⚠️ The plugin is no longer supported in favor of [yiisoft/config](https://github.com/yiisoft/config).
[](https://packagist.org/packages/yiisoft/composer-config-plugin)
[](https://packagist.org/packages/yiisoft/composer-config-plugin)
[](https://github.com/yiisoft/composer-config-plugin/actions)
[](https://scrutinizer-ci.com/g/yiisoft/composer-config-plugin/?branch=master)
[](https://scrutinizer-ci.com/g/yiisoft/composer-config-plugin/?branch=master)
This [Composer] plugin provides assembling
of configurations distributed with composer packages.
It allows putting configuration needed to use a package right inside of
the package thus implementing a plugin system. The package becomes a plugin
holding both the code and its configuration.
### Documentation
- [English](docs/en/README.md)
- [Russian](docs/ru/README.md)
## How it works?
- Scans installed packages for `config-plugin` extra option in their
`composer.json`.
- Loads `.env` files to set `$_ENV` variables.
- Requires `constants` files to set constants.
- Requires `params` files.
- Requires config files.
- Options collected during earlier steps could and should be used in later
steps, e.g. `$_ENV` should be used for constants and parameters, which
in turn should be used for configs.
- File processing order is crucial to achieve expected behavior: options
in root package have priority over options from included packages. It is described
below in **File processing order** section.
- Collected configs are written as PHP files in
`vendor/yiisoft/composer-config-plugin-output`
directory along with information needed to rebuild configs on demand.
- Then assembled configs are ready to be loaded into application using `require`.
**Read more** about the general idea behind this plugin in [English] or
[Russian].
[composer]: https://getcomposer.org/
[English]: https://hiqdev.com/pages/articles/app-organization
[Russian]: https://habrahabr.ru/post/329286/
## Installation
```sh
composer require "yiisoft/composer-config-plugin"
```
Out of the box this plugin supports configs in PHP and JSON formats.
To enable additional formats require:
- [vlucas/phpdotenv] - for `.env` files.
- [symfony/yaml] - for YAML files, `.yml` and `.yaml`.
[vlucas/phpdotenv]: https://github.com/vlucas/phpdotenv
[symfony/yaml]: https://github.com/symfony/yaml
## Usage
List your config files in `composer.json` like the following:
```json
"extra": {
"config-plugin-output-dir": "path/relative-to-composer-json",
"config-plugin": {
"envs": "db.env",
"params": [
"config/params.php",
"?config/params-local.php"
],
"common": "config/common.php",
"web": [
"$common",
"config/web.php"
"../src/Modules/*/config/web.php"
],
"other": "config/other.php"
}
},
```
### Markers
- `?` - marks optional files. Absence of files not marked with it will cause exception.
```
"params": [
"params.php",
"?params-local.php"
]
```
It's okay if `params-local.php` will not found, but it's not okay if `params.php` will be absent.
- `*` - marks wildcard path. It means zero or more matches by wildcard mask.
```
"web": [
"../src/Modules/*/config/web.php"
]
```
It will collect all `web.php` in any subfolders of `src/Modules/` in `config` folder.
- `$` - reference to another config.
```
"params": [
"params.php",
"?params-local.php"
],
"params-console": [
"$params",
"params-console.php"
],
"params-web": [
"$params",
"params-web.php"
]
```
Output files `params-console.php` and `params-web.php` will contain `params.php` and `params-local.php`.
***
Define your configs like the following:
```php
[
'db' => [
'class' => \my\Db::class,
'name' => $params['db.name'],
'password' => $params['db.password'],
],
],
];
```
A special variable `$params` is read from `params` config.
To load assembled configs in your application use `require`:
```php
$config = require Yiisoft\Composer\Config\Builder::path('web');
```
### Using sub-configs
In some cases it is convenient to extract part of your config into another file. For example, we want to extract database
configuration into `db.php`. To do it add the config to `composer.json`:
```json
"extra": {
"config-plugin-output-dir": "path/relative-to-composer-json",
"config-plugin": {
"envs": "db.env",
"params": [
"config/params.php",
"?config/params-local.php"
],
"common": "config/common.php",
"web": [
"$common",
"config/web.php"
],
"other": "config/other.php",
"db": "config/db.php"
}
},
```
Create `db.php`:
```php
\my\Db::class,
'name' => $params['db.name'],
'password' => $params['db.password'],
];
```
Then in the config use `Builder::require()`:
```php
[
'db' => Builder::require('db'),
],
];
```
### Refreshing config
Plugin uses composer `POST_AUTOLOAD_DUMP` event i.e. composer runs this plugin on `install`, `update` and `dump-autoload`
commands. As the result configs are ready to be used right after package installation or update.
When you make changes to any of configs you may want to reassemble configs manually. In order to do it run:
```sh
composer dump-autoload
```
Above can be shortened to `composer du`.
If you need to force config rebuilding from your application, you can do it like the following:
```php
// Don't do it in production, assembling takes it's time
if (getenv('APP_ENV') === 'dev') {
Yiisoft\Composer\Config\Builder::rebuild();
}
```
### File processing order
Config files are processed in proper order to achieve naturally expected
behavior:
- Options in outer packages override options from inner packages.
- Plugin respects the order your configs are listed in `composer.json` with.
- Different types of options are processed in the following order:
- Environment variables from `envs`.
- Constants from `constants`.
- Parameters from `params`.
- Configs are processed last of all.
### Debugging
There are several ways to debug config building internals.
- Plugin can show detected package dependencies hierarchy by running:
```sh
composer dump-autoload --verbose
```
Above can be shortened to `composer du -v`.
- You can see the assembled configs in the output directory which is
`vendor/yiisoft/composer-config-plugin-output` by default and can be configured
with `config-plugin-output-dir` extra option in `composer.json`.
## Known issues
This plugin treats configs as simple PHP arrays. No specific
structure or semantics are expected and handled.
It is simple and straightforward, but I'm in doubt...
What about errors and typos?
I think about adding config validation rules provided together with
plugins. Will it solve all the problems?
## License
This project is released under the terms of the BSD-3-Clause [license](LICENSE).
Read more [here](http://choosealicense.com/licenses/bsd-3-clause).
Copyright © 2016-2020, HiQDev (http://hiqdev.com/)
Copyright © 2020, Yiisoft (https://www.yiiframework.com/)