helsingborg-stad / builder
执行构建命令和清理文件
v1.0.4
2022-06-30 07:03 UTC
Requires
- php: >=7.4.0
- composer-plugin-api: ^2.3
Requires (Dev)
- composer/composer: ^2.3
- php-parallel-lint/php-parallel-lint: ~1.3.1
- phpunit/phpunit: ^9.5.0
- squizlabs/php_codesniffer: ^3.6
README
Builder
摘要
此Composer插件将检查从同一composer.json文件安装的Composer包的构建和清理配置。此插件的主要用途是在构建管道和本地开发环境中。
要求
安装
composer require helsingborg-stad/builder
构建命令
任何需要构建的Composer包,以下内容应包含在composer.json文件中。
{ "extra": { "builder": { "commands": [ "npm ci", "npm run build", ] } } }
清理
在需要清理的依赖包之后构建的任何文件都应包含在composer.json文件中,如下所示。
{ "extra": { "builder": { "removables": [ ".git", ".gitignore" ] } } }
管道命令示例
在生产环境中运行构建时,应在安装之前启用清理配置。
此功能应谨慎使用,因为它会从您的系统中删除文件,并且设置不应提交,而应在管道构建期间添加。
composer config extra.builder.cleanup true
composer install
此内容将添加到composer.json中
"extra": { "builder": { "cleanup": "true" } }
运行测试
composer install
composer run test
路线图
查看开放问题以获取提议的功能列表(以及已知问题)。
贡献
贡献使开源社区成为一个如此令人惊叹的学习、灵感和创造的地方。您所做的任何贡献都非常受欢迎。
- 分支项目
- 创建您的功能分支(
git checkout -b feature/AmazingFeature
) - 提交您的更改(
git commit -m 'Add some AmazingFeature'
) - 推送到分支(
git push origin feature/AmazingFeature
) - 打开拉取请求
许可证
在MIT许可证下分发。