README

此仓库提供了一组由shlink PHP项目使用的PHP_CodeSniffer规则。

使用方法

首先，使用composer安装此包

composer require shlinkio/php-coding-standard --dev

然后，更新您的phpcs.xml文件，添加一个引用到Shlinkio的规则。

<?xml version="1.0"?>
<ruleset name="Coding standard">
    <description>Coding standard</description>

    <!-- display progress -->
    <arg value="p" />
    <arg name="colors" />

    <!-- inherit rules from: -->
    <rule ref="Shlinkio" />

    <!-- [...] -->
</ruleset>

规则

此规则集扩展了PSR-12规则，并包括以下内容：

不允许使用长数组语法 [array(...)]。
确保字符串连接运算符周围有空格。
不允许多余的空格。
不允许使用未使用的use语句。
要求use语句按字母顺序排序。
要求使用严格的比较运算符 (=== 和 !==) 而不是 == 和 !=)。
要求在多行数组的每个元素后使用逗号。
要求在多行函数调用中的每个元素后使用逗号。
要求在多行函数声明中的每个元素后使用逗号。
强制所有全局命名空间类、函数和常量必须显式导入。
要求注释为单行，以单行形式书写 [/* @var SomeType **/]。
要求所有类常量都有可见性修饰符 (public、protected 或 private)。
要求具有默认null值的函数参数定义为可空类型 (?string $foo = 'foo')。
要求尽可能在函数参数上使用原生类型提示。
要求尽可能在函数上使用原生返回类型提示。
要求尽可能在属性上使用原生类型提示。
要求在异常变量未使用时使用非捕获捕获。
格式化无空格的联合类型 (foo|bar) 并强制null类型在可空类型后出现 (foo|bar|null)。

shlinkio / php-coding-standard

维护者

详细信息

README

使用方法

规则