Repolode
slevomat

slevomat/coding-standard

基于 PHP_CodeSniffer 的 PHP 编码规范集合,提供大量检查规则,多数支持自动修复。

Star
1,478
Fork
197
未关闭 Issue
93
最近提交
前天

这是什么?

Slevomat Coding Standard 是 PHP_CodeSniffer 的一套编码规则,用于检查 PHP 源码是否符合规范。它包含大量独立的 sniff,分为三类:提升代码安全性与行为正确性的功能性规则、检测死代码的清理规则,以及保持代码风格统一的格式化规则。

规则覆盖现代 PHP 特性,包括 attributes、enum、联合类型、具名参数和构造函数属性提升等。标有 🔧 的规则支持通过 phpcbf 自动修复;部分规则还可以在代码中用 @phpcsSuppress 注解局部忽略。

项目通过 Composer 以开发依赖的方式安装。推荐在自己的 ruleset.xml 中只引用需要的规则,也可以引入完整规则集后再排除个别规则。

核心功能

  • 01覆盖数组、类、控制结构、函数、命名空间、类型提示等多个方面。
  • 02许多规则可通过 phpcbf 自动修复违规代码。
  • 03能检测未使用的变量、参数和 use 导入等死代码。
  • 04支持 attributes、enum、联合类型等现代 PHP 语法。
  • 05可以只启用部分规则,也可以排除个别规则。

适用场景

  • 在团队项目中统一 PHP 代码风格。
  • 在持续集成中发现未使用代码和潜在风险写法。
  • 借助 phpcbf 自动清理旧版 PHP 代码库。
  • 从规则集中挑选部分 sniff,组合成自定义编码规范。

快速上手

  1. 1

    使用 Composer 将该标准安装为开发依赖

    composer require --dev slevomat/coding-standard
  2. 2

    配置 PHP_CodeSniffer 使用该标准并对代码运行检查

使用前须知

  • 需要 PHP 和 Composer 环境,并依赖 PHP_CodeSniffer。

收录于专题

标签

#php#code-style#linting#phpcs#static-analysis#coding-standard#php7#php8#phpcodesniffer

常见问题

coding-standard 是什么?
基于 PHP_CodeSniffer 的 PHP 编码规范集合,提供大量检查规则,多数支持自动修复。 Slevomat Coding Standard 是 PHP_CodeSniffer 的一套编码规则,用于检查 PHP 源码是否符合规范。它包含大量独立的 sniff,分为三类:提升代码安全性与行为正确性的功能性规则、检测死代码的清理规则,以及保持代码风格统一的格式化规则。
coding-standard 可以免费使用吗?用的什么许可证?
coding-standard 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
coding-standard 还在维护吗?
活跃维护中。coding-standard 最近一次提交是在 2026年11月5日。
coding-standard 适合用来做什么?
在团队项目中统一 PHP 代码风格。 在持续集成中发现未使用代码和潜在风险写法。 借助 phpcbf 自动清理旧版 PHP 代码库。 从规则集中挑选部分 sniff,组合成自定义编码规范。
coding-standard 怎么安装和运行?
使用 Composer 将该标准安装为开发依赖: composer require --dev slevomat/coding-standard 配置 PHP_CodeSniffer 使用该标准并对代码运行检查
在哪里获取 coding-standard?
源代码和安装说明在 GitHub 上:https://github.com/slevomat/coding-standard

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目