Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benjaminkott/configuration-installer
Manage the pile of configuration files, which mostly have nothing to do with your application directly, through composer.
https://github.com/benjaminkott/configuration-installer
composer-plugin
Last synced: 3 months ago
JSON representation
Manage the pile of configuration files, which mostly have nothing to do with your application directly, through composer.
- Host: GitHub
- URL: https://github.com/benjaminkott/configuration-installer
- Owner: benjaminkott
- License: mit
- Created: 2020-05-26T11:49:39.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-09-20T18:57:33.000Z (over 1 year ago)
- Last Synced: 2024-09-22T17:37:15.462Z (4 months ago)
- Topics: composer-plugin
- Language: PHP
- Homepage:
- Size: 21.5 KB
- Stars: 4
- Watchers: 4
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Project Configuration Installer
Installer for Configuration Packages.
Examples:
- https://github.com/benjaminkott/config-commitmessage
- https://github.com/benjaminkott/config-typo3-editorconfig
- https://github.com/benjaminkott/config-typo3-stylelint
- https://github.com/benjaminkott/config-typo3-phpcsfixer
## Build your own configuration package
Adapt the `composer.json` of your **configuration package**.
1. Ensure the type is set to `project-configuration`.
1. Ensure `bk2k/configuration-installer` is required in any version.
```json
{
"type": "project-configuration",
"require": {
"bk2k/configuration-installer": "*"
}
}
```
### Add a manifest to your configuration package root.
The `manifest.json` file instructs the installer.
1. It defines which `files` should be copied to your project
1. It defines which `gitignore` entries will be added to your projects .gitignore file.
```json
{
"files": {
".php_cs.dist": ".php_cs.dist"
},
"gitignore": [
"/.php_cs.dist",
"/.php_cs.cache"
]
}
```