prestashop / header-stamp
重写文件头以添加许可证或使它们保持最新状态
v2.3
2023-03-23 14:44 UTC
Requires
- php: ^8.0 || ^7.2
- nikic/php-parser: ^4.10
- symfony/console: ^3.4 || ~4.0 || ~5.0 || ~6.0
- symfony/finder: ^3.4 || ~4.0 || ~5.0 || ~6.0
Requires (Dev)
- phpstan/phpstan: ^0.12.83
- prestashop/php-dev-tools: 1.*
README
更新当前文件夹的文件头。此工具提取了原本在 PrestaShop 核心中可用的命令。
安装
此项目可以通过 Composer(PHP 包管理器)下载。我们建议将其放在依赖关系的 require-dev
部分中,因为它在生产环境中不是必需的。
composer require --dev prestashop/header-stamp
用法
如果通过 Composer 安装,应用程序在其二进制文件夹中可用
php vendor/bin/header-stamp
默认行为是在当前文件夹中找到的所有兼容文件中应用 OSL 许可证。
⚠️ Header Stamp 将扫描和处理所有兼容文件,包括如果您未指定目标,则包括 node_modules
或 vendor
。使用 --exclude
以避免修改依赖文件。
php vendor/bin/header-stamp --exclude=vendor,node_modules
可用选项
--license=LICENSE License file to apply [default: "assets/osl3.txt"]
--exclude=EXCLUDE Comma-separated list of folders and files to exclude from the update [default: ""]
--extensions=EXTENSIONS Comma-separated list of file extensions to update [default: "php,js,css,scss,tpl,html.twig,json,vue"]
--target=PATH Folder to work in [default: Current directory]
--dry-run Dry-run mode does not modify files
--display-report Whether or not to display a report
开发
使用 composer 安装依赖项。为此项目配置了两个 CI 工具:php-cs-fixer 和 phpstan
composer install
php vendor/bin/php-cs-fixer fix --no-interaction --dry-run --diff
php phpstan analyse tests/phpstan/phpstan.neon
在向项目提交更改之前,可以使用以下命令运行测试
php tests/integration/runner/run.php