README

Chromatix Digital Agency 在 phpcs 上为自定义标准提供的可分享配置。

主要基于 WordPress 编码标准，但也包含我们的一些自定义标准。最显著的是，使用两个空格而不是制表符。抱歉。

此配置仍在开发中。如果您有任何改进建议或对配置做出的任何决定有异议，请随时提交问题。

在 WordPress 之外编写 PHP 代码？我们仍然使用 WordPress 标准，但显然不需要使用 WordPress 特定的函数。请参阅 phpcs-config-chromatix-no-wordpress。

安装

全局安装以在任何项目中使用

composer global require chromatix/phpcs-config-chromatix

局部安装到单个项目

composer require chromatix/phpcs-config-chromatix

您还需要以相同的方式安装 phpcs，并将您的 phpcs installed_paths 设置如下

vendor/bin/phpcs --config-set installed_paths ../../chromatix,../../wp-coding-standards/wpcs

最好在您的 composer.json 的 post-install-cmd 脚本中完成此操作；请参阅此包的 composer.json，以获取跨平台方式的一个示例（它可能看起来有点复杂，但不幸的是，这是必需的...至少到目前为止，在我们的测试中是这样的！）。

用法

将此添加到您的 phpcs.xml 文件中

<?xml version="1.0"?>
<ruleset>
  <rule ref="phpcs-config-chromatix"/>
</ruleset>

然后

使用全局？

运行 phpcs *.php

使用局部？

运行 vendor/bin/phpcs *.php

或者，您可能发现将脚本添加到您的 composer.json 中很有用

"scripts": {
  "lint": "find . -type d \\( -name '.git' -o -name 'vendor' -o -name 'node_modules' \\) -prune -o -type f -name '*.php' -print | xargs vendor/bin/phpcs"
}

然后您只需运行 composer lint。

另请参阅

许可证

MIT.

chromatix / phpcs-config-chromatix

维护者

详细信息

README

安装

用法

另请参阅

许可证