meom/phpcs-composer

维护者

详细信息

github.com/MEOM/phpcs-composer

源代码

问题

安装数量: 9,377

依赖者: 4

建议者: 0

安全性: 0

星标: 0

关注者: 4

分支: 0

公开问题: 2

类型:phpcodesniffer-standard

dev-main 2023-12-14 19:43 UTC

Requires

MIT d9a29a9510d7fa47228a916102e4e9cadaedd28e

  • MEOM <tech.woop@meom.fi>

This package is auto-updated.

Last update: 2024-09-14 21:09:45 UTC

README

这是一个用于自定义 WPCS 和 PHPCompatibilityWP 规则集的独立 composer 包。

要求

  • PHP 7+
  • Composer 用于管理 PHP 依赖。

安装

使用 Composer 安装该包。

composer require --dev meom/phpcs-composer:dev-main

用法

使用以下命令检查 PHP 文件

./vendor/bin/phpcs .

或者指定 lint 主题文件夹的路径，例如

./vendor/bin/phpcs htdocs/wp-content/themes/theme-name

注意默认情况下不显示警告。您可以使用 --severity 标志进行更改，如下所示

./vendor/bin/phpcs --severity=1 htdocs/wp-content/themes/theme-name

使用 PHPCBF 命令修复问题

一些问题可以使用 phpcbf 命令修复

./vendor/bin/phpcbf .

或者指定修复主题文件夹的路径，例如

./vendor/bin/phpcbf htdocs/wp-content/themes/theme-name

注意默认情况下不修复警告。您也可以使用 --severity 标志修复警告，如下所示

./vendor/bin/phpcbf --severity=1 htdocs/wp-content/themes/theme-name

有关 自动修复 PHPCS 错误 的更多信息。

IDE 集成

PHPCS 的某些 IDE 集成未能注册 MEOM 默认规则集。为了纠正这个问题，请将 .phpcs.xml.dist 放在您的项目根目录下

<?xml version="1.0"?>
<ruleset name="Project Rules">
    <rule ref="MEOM-default" />
</ruleset>

注意这已在 Kala Stack 中添加。

VS Code

如果您全局未安装 PHP codesniffer，您可能需要

  1. 创建 .vscode 文件夹（位于项目根目录）。
  2. 在该文件夹中添加 settings.json 文件。
  3. 在文件中添加以下内容。
{
    "phpcs.executablePath": "./vendor/bin/phpcs"
}

备注：Windows 正在查找文件 ./vendor/bin/phpcs.bat。如果由于某些原因没有在 ./vendor/bin/ 中自动生成，请测试路径 ./vendor/squizlabs/php_codesniffer/bin/phpcs。

.bat 文件应在该文件夹中。