jumptwentyfour/php-coding-standards

我们的PHP应用程序的编码规范。

维护者

详细信息

github.com/JumpTwentyFour/php-coding-standards

来源

问题

安装次数: 96,558

依赖者: 1

建议者: 0

安全: 0

星标: 4

关注者: 3

分支: 1

开放问题: 2

V3.0.0 2024-07-05 09:58 UTC

Requires

MIT a60f8b2c4817db004cb9ff48aea5a73a539abd67

phpstandardscode standards

This package is auto-updated.

Last update: 2024-09-05 10:29:47 UTC

README

在 Jump24，我们自豪于对编码规范进行严格控制，这就是我们构建此包的原因。

安装

要安装此包，只需使用composer

composer require jumptwentyfour/php-coding-standards

设置

安装完成后，您将能够访问我们的PHPStan配置文件，您可以轻松将其添加到您的 phpstan.neon

includes:
    - ./vendor/jumptwentyfour/php-coding-standards/phpstan.neon

运行

要运行代码规范检查，只需运行以下命令

./vendor/bin/ecs check

这将为您运行配置的代码规范检查，并提供有关您的代码位置以及需要实施哪些改进的反馈

扩展

这些编码规范是可扩展的，您只需在项目根目录下创建自己的 ecs.php

<?php

declare(strict_types=1);

use JumpTwentyFour\PhpCodingStandards\Support\ConfigHelper;
use Symplify\EasyCodingStandard\Config\ECSConfig;
use Symplify\EasyCodingStandard\ValueObject\Option;

return static function (ECSConfig $ecsConfig): void {
    $ecsConfig->import(__DIR__ . '/vendor/jumptwentyfour/php-coding-standards/ecs.php');

    $parameters = $ecsConfig->parameters();
    
    $parameters->set(Option::PATHS, [
        __DIR__ . '/app',
        __DIR__ . '/tests',
    ]);
    
    $ecsConfig->skip(array_merge(ConfigHelper::make($ecsConfig)->getParameter(Option::SKIP), [
        UnusedParameterSniff::class => [
            __DIR__ . '/app/Console/Kernel.php',
            __DIR__ . '/app/Exceptions/Handler.php',
        ],
        'Unused parameter $attributes.' => [
            __DIR__ . '/database/*.php',
        ],
        CamelCapsFunctionNameSniff::class => [
            '/tests/**',
        ],
    ]));
};