becklyn/yaml-parameters

Composer script handling the dist parameters file.

Maintainers

Details

github.com/Becklyn/YamlParameters

Homepage

Source

Issues

Installs: 972

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 2

Forks: 0

Open Issues: 0

pkg:composer/becklyn/yaml-parameters

1.0.1 2018-09-04 15:19 UTC

Requires

Requires (Dev)

BSD-3-Clause 4a7ecd5dc0e829cad4ae6d6cdbb9436a9a1fe198

This package is auto-updated.

Last update: 2025-10-07 07:30:01 UTC

README

Automates the installation workflow for parameters.yaml files.

Installation and Usage

Add the following code to your composer.json:

{
    "require": {
        "becklyn/yaml-parameters-handler": "^1.0"
    },
    "scripts": {
        "yaml-parameters": [
            "Becklyn\\YamlParameters\\Script::handle"
        ],
        "post-install-cmd": [
            "@yaml-parameters"
        ],
        "post-update-cmd": [
            "@yaml-parameters"
        ]
    },
    "extra": {
        "parameters": "config/parameters.yaml"
    }
}

The "extra"-parameter is optional, it defaults to config/parameters.yaml. The .dist file must be named like the target file, with additional .dist infix before the extension (the default is config/parameters.yaml -> config/parameters.dist.yaml)

  • All obsolete config will be removed without warning.
  • The merging of .dist parameters only works for scalars and arrays.