README

为您的 SilverStripe 项目提供一系列的定义和编码规范规则

安装

通过 Composer

composer require --dev jdolba/silverstripe-coding-standards ^0.1

使用方法

使用 composer 脚本的示例

将脚本添加到您的 composer.json 文件中

    "scripts": {
        "silverstripe-standards": [
            "@php-lint",
            "@phpcs"
        ],
        "php-lint": "parallel-lint app/src app/tests",
        "phpcs": "phpcs app/src app/tests --standard=vendor/jdolba/silverstripe-coding-standards/definitions/php/phpcs-ss4.xml --extensions=php --encoding=utf-8",
        "phpcbf": "phpcbf app/src app/tests --standard=vendor/jdolba/silverstripe-coding-standards/definitions/php/phpcs-ss4.xml --extensions=php --encoding=utf-8",
        "phpcs-fix": "@phpcbf"
    },

然后运行

composer silverstripe-standards

要修复您的规范违规，可以运行

composer phpcs-fix
# or
composer phpcbf

自定义规则

您也可以通过将 phpcs.xml 文件直接添加到项目根目录来自定义规则

cp vendor/jdolba/silverstripe-coding-standards/skeletons/phpcs.xml phpcs.xml

别忘了更改 composer 脚本中的路径（--standard=phpcs.xml）

.editorconfig

您可以使用预制的 .editorconfig 文件（见 https://editorconfig.org/）

cp vendor/jdolba/silverstripe-coding-standards/skeletons/.editorconfig .editorconfig

鸣谢

许可协议

MIT 许可协议 (MIT)。请参阅许可文件了解更多信息。

jdolba / silverstripe-coding-standards

维护者

详细信息