jumptwentyfour/cakephp-coding-standards

CakePHP应用的编码规范。

0.1.1 2023-04-05 07:55 UTC

This package is auto-updated.

Last update: 2024-09-05 10:49:02 UTC


README

CakePHP应用的编码规范。

设置

composer require jumptwentyfour/cakephp-coding-standards --dev

您还需要将以下内容添加到您的本地 phpstan.neon 文件的 includes 部分

- ./vendor/jumptwentyfour/cakephp-coding-standards/phpstan.neon

运行PHP Easy Coding Standard

vendor/bin/ecs check

扩展基础 ecs.php 文件

创建一个如以下示例的新的 ecs.php 文件:

<?php

declare(strict_types=1);

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

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

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