README

Themosis 编码标准

Themosis CS 是 Themosis 在其项目和库中使用的编码标准。

该包提供了一套 PHP Code Sniffer 规则，允许任何人使用我们的编码标准格式化他们的代码库。

该 Themosis 规则集在 WordPress-Core 规则集的基础上进行了改进

排除 WordPress 类名规则
排除 WordPress 文件名规则
允许数组短语法
允许三元短语法
强制严格类型声明

规则列表可能会随时间变化...

用法

首先使用 Composer 安装该包，以及像这样使用 dealerdirect/phpcodesniffer-composer-installer 插件

composer require --dev themosis/cs dealerdirect/phpcodesniffer-composer-installer

Composer 可能会要求“允许” dealerdirect/phpcodesniffer-composer-installer 插件。选择 yes 允许。

该附加插件将自动使 PHPCS 规则集在您的项目中可用。安装后，您应该有 phpcs 和 phpcbf 二进制文件安装，您可以通过运行 php vendor/bin/phpcs -i 从命令行列出可用的规则集。

添加 Themosis 规则集

一旦您的项目中安装了这些包，在项目根目录创建一个 phpcs.xml.dist 文件，并添加以下内容

<?xml version="1.0"?>
<ruleset name="My Application">
    <!-- Files -->
    <file>./src</file>
    <file>./tests</file>

    <!-- Code Rules -->
    <rule ref="Themosis"/>
</ruleset>

这是一个基本规则集，用于您的项目。PHP Code Sniffer 库使用一个 xml 配置文件。在运行 phpcs 命令时，它将自动在执行前加载规则集。

上述文件将应用 Themosis 规则集到 src 和 tests 目录下存储的文件。

themosis / cs

维护者

详情

README

Themosis 编码标准

用法

添加 Themosis 规则集

更多信息