finetic/coding-standard

Finetic PHP CodeSniffer 编码标准

维护者

详情

github.com/finetic/coding-standard

源代码

问题

安装次数: 3,655

依赖项: 0

建议者: 0

安全: 0

星标: 2

关注者: 0

分支: 1

开放问题: 1

类型:phpcodesniffer-standard

v2.0.0 2023-12-21 08:29 UTC

Requires

Requires (Dev)

MIT 4d1932f0782b3cd46f90688efda0dd2e1dad9f5e

This package is auto-updated.

Last update: 2024-09-05 16:32:21 UTC

README

通过 Finetic 规则扩展默认的 PHP_CodeSniffer

注意：向此包添加新的 phpcs-rules 必须导致主版本更新！

安装

要求此包

composer require --dev finetic/coding-standard

设置

在项目的根目录下创建一个 phpcs.xml 或 phpcs.xml.dist-文件，并包含默认的 Finetic 规则集

<?xml version="1.0" encoding="UTF-8"?>
<ruleset name="phpcs-for-your-project">
    <!-- include root folder of project -->
    <file>.</file>

    <!-- exclude paths -->
    <exclude-pattern>./src/Migrations</exclude-pattern>
    <exclude-pattern>./vendor</exclude-pattern>

    <!-- include all rules in the Finetic ruleset -->
    <rule ref="Finetic"/>
</ruleset>

更改规则集的名称，修改排除的路径和/或包含针对您项目的自定义规则集。

使用方法

由于您现在在项目的根目录下有一个 phpcs.xml 文件，您可以运行默认的 phpcs 命令：vendor/bin/phpcs。

更多信息

有关如何使用 PHP CodeSniffer 的更多信息，请查看 PHP CodeSniffer 仓库。

贡献

如果您想贡献，请创建一个带有 每个合并请求一个 sniff 的合并请求。请在描述中提供关于嗅探器的示例，包括良好的和较差的代码片段。