README

此工具允许您在运行composer安装或更新时管理忽略的参数。当参数存储在单个顶级键（默认名为parameters）下的Yaml文件中时，它将正常工作。其他键将保持不变。

用法

在您的根composer.json文件中添加以下内容

{
    "require": {
        "incenteev/composer-parameter-handler": "~2.0"
    },
    "scripts": {
        "post-install-cmd": [
            "Incenteev\\ParameterHandler\\ScriptHandler::buildParameters"
        ],
        "post-update-cmd": [
            "Incenteev\\ParameterHandler\\ScriptHandler::buildParameters"
        ]
    },
    "extra": {
        "incenteev-parameters": {
            "file": "app/config/parameters.yml"
        }
    }
}

然后，Composer脚本将创建或更新app/config/parameters.yml，以匹配dist文件app/config/parameters.yml.dist的结构，并询问您缺少的参数。

默认情况下，假设dist文件与参数文件位于同一位置，文件名后缀为.dist。这可以在配置中更改。

{
    "extra": {
        "incenteev-parameters": {
            "file": "app/config/parameters.yml",
            "dist-file": "some/other/folder/to/other/parameters/file/parameters.yml.dist"
        }
    }
}

脚本处理程序将交互式地询问缺少的参数，使用dist文件的值作为默认值。所有提示值都被解析为内联Yaml，以便您轻松地定义true、false、null或数字。如果Composer以非交互式模式运行，则将使用dist文件的值作为缺少参数的值。

警告：此参数处理程序将覆盖您的参数.yml文件中的任何注释或空格，因此请小心处理。如果您想为参数文件提供格式和注释，应在dist版本中完成。

保留过时的参数

警告：此脚本将从parameters.yml中删除过时的参数，这些参数不在parameters.yml.dist中。如果您需要保留过时参数，可以在配置中使用keep-outdated参数。

{
    "extra": {
        "incenteev-parameters": {
            "keep-outdated": true
        }
    }
}

使用不同的顶级键

脚本处理程序在dist文件中查找parameters键。您可以通过配置中的parameter-key参数来更改此键。

{
    "extra": {
        "incenteev-parameters": {
            "parameter-key": "config"
        }
    }
}

使用环境变量设置参数

对于您的生产环境，在部署时可能无法使用交互式提示。在这种情况下，您可以通过环境变量来提供参数。这通过提供一个环境变量和它们应填充的参数之间的映射来实现。

{
    "extra": {
        "incenteev-parameters": {
            "env-map": {
                "my_first_param": "MY_FIRST_PARAM",
                "my_second_param": "MY_SECOND_PARAM"
            }
        }
    }
}

如果设置了环境变量，其值将始终替换现有参数文件中设置的值。

由于环境变量只能是字符串，因此它们也被解析为内联Yaml值，以便您轻松地指定null、false、true或数字。

重命名参数

如果您正在重命名一个参数，新键将根据常规程序设置（如果可能，提示，使用环境变量，使用默认值）。为了使参数处理程序使用（已废弃的）参数的值，指定一个rename-map。

{
    "extra": {
        "incenteev-parameters": {
            "rename-map": {
                "new_param_1": "old_param_1",
                "new_param_2": "old_param_2"
            }
        }
    }
}

这将创建新的参数new_param_1和new_param_2，同时分别使用old_param_1和old_param_2的值。除非您还从dist版本中删除了它们，否则它不会删除旧参数。

如果旧参数不再存在（可能是因为它已经被重命名并删除），则不会覆盖任何参数。一旦参数被重命名，您不需要从重命名映射中删除已废弃的参数。

管理多个忽略文件

参数处理程序可以管理多个忽略文件。要使用此功能，incenteev-parameters附加组件应包含一个包含多个配置的JSON数组，而不是配置对象。

{
    "extra": {
        "incenteev-parameters": [
            {
                "file": "app/config/parameters.yml",
                "env-map": {}
            },
            {
                "file": "app/config/databases.yml",
                "dist-file": "app/config/databases.dist.yml",
                "parameter-key": "config"
            }
        ]
    }
}

incenteev / composer-parameter-handler

维护者

详细信息