chez14 / phpcs

chez14项目PHP代码风格

维护者

详细信息

gitlab.com/chez14/phpcs

v1.0.3 2023-04-14 22:09 UTC

Requires

None

Requires (Dev)

squizlabs/php_codesniffer: ^3.6

Suggests

None

Provides

None

Conflicts

None

Replaces

None

MIT dc35f2aa1d94dba7f8a1313bb41bec970118f227

Chris "chez14" Qiang <chris.woop@christianto.net>

dev-master
v1.x-dev
v1.0.3
v1.0.2
v1.0.1
v1.0.0
v0.1.0
v0.0.0

This package is auto-updated.

Last update: 2024-09-15 01:09:56 UTC

README

基于PSR12的代码风格标准，包含chez14期望贡献者和维护者补充的额外内容。

只是为了确保每个人都为项目编写清晰的文档。

附加规则集

PEAR.Commenting.FunctionComment \ 确保对函数进行文档说明。这有助于在IDE中启用IntelliSense的人。
PEAR.Commenting.InlineComment \ 禁用Perl风格注释。对于chez14来说，这看起来很分散。

安装

确保您已安装CodeSniffer: https://github.com/squizlabs/PHP_CodeSniffer

将编码标准添加到您的项目中。

composer req --dev chez14/phpcs squizlabs/php_codesniffer

使phpcs使用此标准
- 通过创建一个新的phpcs配置文件
  - 添加 phpcs.xml
```
<?xml version="1.0"?>
<ruleset name="f3-ilgar">
    <description></description>
    <config name="installed_paths" value="../../chez14/phpcs/src/CHEZ14Standards"/>
    <rule ref="CHEZ14Standards" scope="path"></rule>
</ruleset>
```
    查看phpcs可接受的文件名: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#using-a-default-configuration-file \ 查看文档: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-Ruleset
- 通过命令行脚本
  - 将脚本添加到 composer.json
```
{
    "script": {
      "style": "phpcs --standard=./vendor/chez14/phpcs/src/CHEZ14Standards src/"
    }
}
```
    查看文档: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage#specifying-a-coding-standard

将代码扫描器脚本添加到Composer。

{
    "script": {
      "style": "phpcs src/",
      "style:fix": "phpcbf src/"
    }
}

许可