README

该目录中的 src/ruleset.xml 文件是 PDGA 编码标准的规则集。

添加到存储库

编辑 composer.json，添加以下部分

  "scripts": {
    "sniff": "bin/codesniffer phpcs",
    "format": "bin/codesniffer phpcbf",
    "format-verbose": "bin/codesniffer phpcbf -v"
  },

    "repositories":[
        {
            "type": "vcs",
            "url": "https://github.com/PDGA/coding-standards.git"
        }
    ],

  "require-dev": {
    "pdga/coding-standards": "^1.0"
  }

注意：如果任何部分已存在，请将新信息添加到其下/内部。

从该存储库运行 composer install 以进行安装。
将 example/script 复制到该存储库中的 bin/codesniffer，并修改脚本以使用适当的容器。

在存储库中使用

一旦设置好存储库的 composer.json 文件并运行 composer install 安装新依赖项，您可以使用 composer run 运行并选择 sniff、format 或 format-verbose。

运行单元测试

从根目录运行 bin/phpunit。

VSCode 插件设置

克隆主存储库

git clone https://github.com/PDGA/coding-standards.git

cd coding-standards && ./bin/composer install

插件

使用此插件设置 VSCode: https://marketplace.visualstudio.com/items?itemName=ValeryanM.vscode-phpsab

将以下 JSON 配置添加到您的 settings.json 文件中，通常在

Windows %APPDATA%\Code\User\settings.json
macOS $HOME/Library/Application\ Support/Code/User/settings.json
Linux $HOME/.config/Code/User/settings.json

注意：您必须更改克隆 coding-standards 的路径。

因此，如果您将其安装在 ~/Code/coding-standards，Mac 上的完整路径将是 /Users/<username>/Code/coding-standards

    "phpsab.snifferEnable": true,
    "phpsab.snifferMode": "onType",
    "phpsab.snifferArguments": ["-n", "--ignore=tests/*"],
    "phpsab.fixerArguments": ["-n", "--ignore=tests/*"],
    "phpsab.executablePathCBF": "<full path to repo>/coding-standards/vendor/bin/phpcbf",
    "phpsab.executablePathCS": "<full path to repo>/coding-standards/vendor/bin/phpcs",
    "phpsab.standard": "<full path to repo>/coding-standards/src/ruleset.xml",
    "phpsab.autoRulesetSearch": false,

调试 Codesniffer 插件配置

要启用调试，请将以下内容添加到 settings.json

    "phpsab.debug": true,

然后在 vscode 中打开 Terminal -> New Terminal，打开后单击 'OUTPUT'，然后从下拉菜单中选择 PHP Sniffer & Beautifier。

特定于存储库或 VSC 工作区的配置

打开该工作区的 .code-workspace 文件并添加

禁用

    "phpsab.snifferEnable": false,

这将覆盖该工作区的设置，关闭文件。

规则

    "phpsab.standard": "<full path to repo>/coding-standards/src/<different ruleset>.xml",

PhpStorm PHP_CodeSniffer 设置

PhpStorm 支持将 PHP_CodeSniffer 配置为每个项目的质量工具。

请按照以下说明进行操作： PhpStorm 设置

为运行在 Docker 图像上的项目进行配置

设置说明将使用本地 PHP 解释器和本地文件路径进行 CodeSniffer 配置。当为在 Docker 图像中运行的项目设置时，有一些需要注意的事项。由于 Composer 命令应在图像上运行而不是本地，因此您需要从图像的角度进行所有配置。

使用 Docker 图像中的解释器。（例如，使用 pdga-api-php 解释器而不是 System PHP）
使用 Docker 图像中的文件路径（例如，使用类似于 /var/www/html/vendor/squizlabs/php_codesniffer/bin/phpcs 的路径作为 PHP_CodeSniffer 路径）。

pdga / coding-standards

维护者

详情