README

ProjektMOTOR 的编码规范，通过几个有用的规则丰富了 symfony 编码规范。

我们在 ProjektMOTOR 喜欢干净的代码。因此，我们有一个基于 symfony 编码规范的内部 PHP 编码规范，用于我们所有的项目。我们使用 PHP CodeSniffer 和优秀的 djoos 的 Symfony PHP CodeSniffer 编码规范 以及一些 Slevomat 编码规范 的 sniffs，这两者都根据我们的需求进行了调整。

编码规范的目标

• 使用现有的标准（PSR-1，PSR-2，Symfony）。
• 编码规范可以在不同的项目中使用。
• 避免重复（包括代码、CVS 历史和文档之间的重复）。
• 确保不同开发环境下的代码质量（例如，不同的 IDE）。

安装

如果您使用 Composer，可以使用以下命令在项目中安装 ProjektMOTOR 编码规范：

composer require --dev projektmotor/symfony-coding-standard

可选：要自动安装编码规范，请编辑您的 composer 脚本

    scripts: {
        "post-install-cmd": [
            "@auto-scripts"
        ],
        "post-update-cmd": [
            "@auto-scripts"
        ],
        "auto-scripts": {
            "phpcs --config-set installed_paths vendor/projektmotor/symfony-coding-standard/ProjektMOTORCodingStandard/": "script",
        }
    }

使用方法

只需在项目的根目录中创建一个 phpcs.xml.dist 文件，内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<ruleset name="projektmotor-coding-standard">
    <rule ref="vendor/projektmotor/symfony-coding-standard/ProjektMOTORCodingStandard/ruleset.xml">
        <!-- If the standard is too hard, you can exclude some rules like this: -->
        <!-- <exclude name="Generic.Arrays.DisallowLongArraySyntax.Found" /> -->
        <!-- <exclude name="Generic.Files.LineLength.TooLong" /> -->
    </rule>
    
    <!-- Exclude project specific files if you want -->
    <!-- <exclude-pattern>WakkaFormatter</exclude-pattern> -->
</ruleset>

然后您可以通过以下方式执行 CodeSniffer：

vendor/bin/phpcs -s -p --colors src/