opositatest/coding-standards

基于 OpositaTest 方法的编码标准

v0.1.5 2023-01-24 15:14 UTC

This package is auto-updated.

Last update: 2024-09-24 18:51:11 UTC


README

基于 Opositates 方法的编码标准。

它基于 LIN3S/CS 的想法。

为什么?

创建此包是为了集中管理 Opositatest 项目的所有代码风格检查,以便以简单的方式安装所有工具并提高可维护性。这是一个灵活且可定制的解决方案,用于自动化与编码标准相关的所有操作。

  • 检查 Composer json 是否有更改,锁文件也必须提交。
  • 使用完全可定制的 PHP-CS-Fixer 修复 PHP 代码。
  • 使用 PHPMD 检查杂乱。

此库非常专注于用作 pre-commit 钩子。检查器仅验证将要提交的文件。

入门指南

推荐且最合适的安装方式是通过 Composer。确保工具已安装在本系统上,并执行以下命令

$ composer require opositatest/coding-standards --dev

然后您需要使用以下代码更新 composer.json

"scripts": {
    "opos-cs-scripts": [
        "Opositatest\\CodingStandards\\Composer\\Hooks::buildDistFile",
        "Incenteev\\ParameterHandler\\ScriptHandler::buildParameters",
        "Opositatest\\CodingStandards\\Composer\\Hooks::addHooks",
        "Opositatest\\CodingStandards\\Composer\\Hooks::addFiles"
    ]
},
"extra": {
    "incenteev-parameters": {
        "file": ".opos_cs.yml",
        "dist-file": ".opos_cs.yml.dist"
    },
    "scripts-dev": {
        "post-install-cmd": [
            "@opos-cs-scripts"
        ],
        "post-update-cmd": [
            "@opos-cs-scripts"
        ]
    }
}

记住:由 Composer 动态生成 .opos_cs.yml 文件。最佳实践建议仅在 .gitignore 中跟踪 .dist 文件,忽略 .opos_cs.yml