bk2k/configuration-installer

Configuration Installer

0.1.2 2023-08-07 09:50 UTC

Requires

• php: ^7.3 || ^8.0
• composer-plugin-api: ^1.1 || ^2.0

Requires (Dev)

• composer/composer: ^1.10 || ^2.0@dev
• friendsofphp/php-cs-fixer: ^2.16 || ^3.0@dev
• overtrue/phplint: ^2.0
• phpunit/phpunit: ^9.2

MIT

• Benjamin Kott

README

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.
2. Ensure bk2k/configuration-installer is required in any version.

{
    "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
2. It defines which gitignore entries will be added to your projects .gitignore file.

{
    "files": {
        ".php_cs.dist": ".php_cs.dist"
    },
    "gitignore": [
        "/.php_cs.dist",
        "/.php_cs.cache"
    ]
}