Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jimchenwyu/composer-config-plugin
Composer plugin for config assembling. Fork from https://github.com/hiqdev/composer-config-plugin
https://github.com/jimchenwyu/composer-config-plugin
assembling composer config php55 plugin
Last synced: 17 days ago
JSON representation
Composer plugin for config assembling. Fork from https://github.com/hiqdev/composer-config-plugin
- Host: GitHub
- URL: https://github.com/jimchenwyu/composer-config-plugin
- Owner: JimChenWYU
- License: bsd-3-clause
- Created: 2019-06-10T02:17:23.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-06-11T05:47:28.000Z (over 5 years ago)
- Last Synced: 2024-11-14T13:12:02.044Z (3 months ago)
- Topics: assembling, composer, config, php55, plugin
- Language: PHP
- Size: 209 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Composer Config Plugin
Composer plugin for config assembling. Fork from https://github.com/hiqdev/composer-config-plugin
[](https://packagist.org/packages/jimchen/composer-config-plugin)
[](https://travis-ci.org/JimChenWYU/composer-config-plugin)
[](https://scrutinizer-ci.com/g/JimChenWYU/composer-config-plugin/)
[](https://scrutinizer-ci.com/g/JimChenWYU/composer-config-plugin/)
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.
How it works?
- Scans installed packages for `config-plugin` extra option in their
`composer.json`
- Loads `.env` files to set `$_ENV` variables
- Requires `defines` 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/hiqdev/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/
## Requirement
+ PHP >= 5.5
+ Composer
**Notice**: If your php version is larger than or equal to 7.0, please use [hiqdev/composer-config-plugin](https://github.com/hiqdev/composer-config-plugin) instead.
## Installation
```sh
composer require "jimchen/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": {
"params": [
"config/params.php",
"?config/params-local.php"
],
"common": "config/common.php",
"web": [
"$common",
"config/web.php"
],
"other": "config/other.php"
}
},
```
`?` marks optional files. Absence of files not marked with it will cause exception.
`$common` is inclusion - `common` config will be merged into `web`.
Define your configs like the following:
```php
return [
'components' => [
'db' => [
'class' => \my\Db::class,
'name' => $params['db.name'],
'password' => $params['db.password'],
],
],
];
```
To load assembled configs in your application use `require`:
```php
$config = require hiqdev\composer\config\Builder::pathHasDefault('web', __DIR__ . '/../web.php');
```
### 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 rebuildign from your application, you can do it like the following:
```php
// Don't do it in production, assembling takes it's time
if (ENVIRONMENT === 'dev') {
hiqdev\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 `dotenv`
- Constants from `defines`
- 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 list of configs and files that plugin has detected and uses
to build configs. It is located in `vendor/hiqdev/composer-config-plugin/output/__files.php`.
- You can see the assembled configs in
`vendor/hiqdev/composer-config-plugin-output` directory.
## 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?
Anonymous functions must be used in multiline form only:
```php
return [
'works' => function () {
return 'value';
},
// this will not work
'noway' => function () { return 'value'; },
];
```
## 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-2018, Jim Chen