README

此仓库包含检查仓库是否遵循 PrestaShop 社区定义的标准以及提供一些配置文件的工具。

安装

composer require --dev prestashop/php-dev-tools

## Development dependencies runtimes
composer require --dev friendsofphp/php-cs-fixer
composer require --dev phpstan/phpstan
composer require --dev prestashop/header-stamp
composer require --dev prestashop/autoindex
composer require --dev squizlabs/php_codesniffer

当此项目成功添加到您的依赖项后，您可以在项目中启用每个审查工具。

版本指南

用法

添加到项目中的配置文件可以自由修改以匹配您的需求。

运行工具可以通过调用它们各自的二进制文件来完成

PHP CS Fixer

使用以下命令初始化配置

$ php vendor/bin/prestashop-coding-standards cs-fixer:init [--dest /path/to/my/project]

它将在项目的根目录下创建一个配置文件 .php-cs-fixer.dist.php。

升级说明：从 4.1.0 升级到较新版本时，您应该重新运行 init 脚本或将您的 .php_cs.dist 文件重命名为 .php-cs-fixer.dist.php，以匹配 cs-fixer 的新要求。

$ vendor/bin/php-cs-fixer fix

PHPStan

$ php vendor/bin/prestashop-coding-standards phpstan:init [--dest /path/to/my/project]

它将在 tests/phpstan 中创建一个默认文件 phpstan.neon，这是运行 phpstan 所必需的。默认的 phpstan 级别是最低的，但我们建议您更新此值以获得更多推荐。

$ _PS_ROOT_DIR_=<Path_to_PrestaShop> php vendor/bin/phpstan --configuration=tests/phpstan/phpstan.neon analyse <path1 [path2 [...]]>

Autoindex

将 index.php 文件应用到所有项目子目录中将有助于防止目录被 web 服务器列出。

$ vendor/bin/autoindex prestashop:add:index <path>

Header Stamp

您可以通过应用 header stamp 来更新您的许可头。

以下是一个示例调用，在 PrestaShop 模块上应用默认许可

$ vendor/bin/header-stamp --license=assets/afl.txt --exclude=vendor,node_modules

可用选项由 --help 提供。

prestashop / php-dev-tools

维护者

详细信息