开源项目 `symplify/coding-standard` 使用教程

开源项目 symplify/coding-standard 使用教程

coding-standardCoding Standard rules for PHP projects with focus on Clean Architecture项目地址:https://gitcode.com/gh_mirrors/cod/coding-standard

1. 项目的目录结构及介绍

symplify/coding-standard 是一个用于 PHP 代码规范检查的开源项目。以下是其主要目录结构及其功能介绍：

symplify/coding-standard/
├── bin/
│   └── coding-standard
├── config/
│   ├── coding-standard.neon
│   └── services.neon
├── src/
│   ├── Rules/
│   └── Sniffs/
├── tests/
│   ├── Rules/
│   └── Sniffs/
├── .gitignore
├── composer.json
├── LICENSE
└── README.md

• bin/: 包含可执行文件，如 coding-standard 脚本。
• config/: 包含项目的配置文件，如 coding-standard.neon 和 services.neon。
• src/: 包含项目的源代码，分为 Rules 和 Sniffs 两个主要部分。
• tests/: 包含项目的测试代码，同样分为 Rules 和 Sniffs 两个部分。
• .gitignore: Git 忽略文件列表。
• composer.json: Composer 依赖管理文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，名为 coding-standard。这个文件是一个可执行脚本，用于启动代码规范检查。以下是启动文件的基本内容和功能：

#!/usr/bin/env php
<?php

if (file_exists(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
} else {
    echo "You must set up the project dependencies, run the following commands:\n";
    echo "composer install\n";
    exit(1);
}

use Symfony\Component\Console\Application;
use Symplify\CodingStandard\Console\CodingStandardConsoleApplication;

$application = new Application('Symplify Coding Standard', '1.0.0');
$application->add(new CodingStandardConsoleApplication());
$application->run();

• #!/usr/bin/env php: 指定脚本解释器。
• require_once DIR . '/../vendor/autoload.php': 引入 Composer 自动加载文件。
• use Symfony\Component\Console\Application: 引入 Symfony 控制台应用类。
• use Symplify\CodingStandard\Console\CodingStandardConsoleApplication: 引入项目自定义的控制台应用类。
• $application = new Application('Symplify Coding Standard', '1.0.0'): 创建一个新的控制台应用实例。
• $application->add(new CodingStandardConsoleApplication()): 添加自定义的控制台应用类。
• $application->run(): 运行控制台应用。

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 目录下，包括 coding-standard.neon 和 services.neon。以下是这两个配置文件的基本内容和功能：

coding-standard.neon

parameters:
    exclude_checkers:
        - 'Symplify\CodingStandard\Fixer\LineLength\LineLengthFixer'

services:
    Symplify\CodingStandard\Fixer\LineLength\LineLengthFixer: ~

• parameters: 定义配置参数，如 exclude_checkers 用于排除某些检查器。
• services: 定义服务，如 Symplify\CodingStandard\Fixer\LineLength\LineLengthFixer 是一个具体的代码规范检查器。

services.neon

services:
    Symplify\CodingStandard\Sniffs\LineLengthSniff: ~
    Symplify\CodingStandard\Rules\CheckClassNamespaceAndFileNameRule: ~

• services: 定义服务，如 Symplify\CodingStandard\Sniffs\LineLengthSniff 和 Symplify\CodingStandard\Rules\CheckClassNamespaceAndFileNameRule 是具体的代码规范检查器。

以上是 symplify/coding-standard

coding-standardCoding Standard rules for PHP projects with focus on Clean Architecture项目地址:https://gitcode.com/gh_mirrors/cod/coding-standard