README

在 trayto.com 的 PHP 项目中使用的常见编码规范工具、规则

底层使用 symplify/easy-coding-standard (ECS)。请遵循那里的配置说明。使用的是 Phar 版本，因此不应与项目依赖项发生冲突。

进一步阅读

安装说明

composer require --dev trayto-com/php-coding-standards

使用方法

您可以直接在 CLI 中使用 ECS，但我们建议自定义默认规则

vendor/bin/ecs check src tests --config vendor/trayto-com/php-coding-standards/definitions/ecs-default.php

运行 PHP Parallel Lint

vendor/bin/parallel-lint --exclude temp --exclude vendor .

提示：在运行任何其他标准检查或测试之前运行代码检查器，以便在代码中发生拼写错误时快速失败

自定义 ECS 规则和自定义使用

建议为项目创建自己的配置，并定义 EasyCodingStandard 的缓存文件夹。

在项目根目录中创建 php 文件，例如 ecs.php

<?php declare(strict_types=1);

use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

return static function (ContainerConfigurator $configurator): void {
    // make sure you import correct file
	$configurator->import(__DIR__ . '/vendor/trayto-com/php-coding-standards/definitions/ecs-default.php');

	$services = $configurator->services();
	// ... customise your services

	$parameters = $configurator->parameters();
	// .. customise your parameters

	$parameters->set(
		Option::CACHE_DIRECTORY,
		__DIR__ . '/temp/ecs'
	);
};

trayto-com / php-coding-standards

维护者

详细信息

README

安装说明

使用方法

自定义 ECS 规则和自定义使用