使用 Homebrew, dnf 安装 php-code-sniffer

项目链接

• 主页
• 软件包管理器页面

命令和别名

• phpcbf
• phpcs

项目历史

PHP_CodeSniffer originated at Squiz as a tokenizer-based coding-standard checker and fixer. It developed built-in standards, an extensible sniff architecture, machine-readable reports, and project rulesets.

Maintenance subsequently continued under the PHPCSStandards organization, whose official repository explicitly identifies the project as the continuation of the abandoned Squizlabs package.

采用历史

PHP_CodeSniffer became a standard PHP development tool because coding policies can be represented as reusable standards and project rulesets, then applied consistently from terminals, editors, hooks, and continuous-integration jobs.

The PHPCSStandards repository describes itself as the official continuation of the package created by Squizlabs. It retains the established Composer package and the long-standing `phpcs` and `phpcbf` commands.

使用方式

Run `phpcs` against files or directories to report coding-standard violations, selecting a built-in, external, or project-defined standard as needed.

Run `phpcbf` to repair fixable violations. When no standard is supplied, PHP_CodeSniffer searches the current directory and its parents for `.phpcs.xml`, `phpcs.xml`, `.phpcs.xml.dist`, or `phpcs.xml.dist`, in that precedence order.

为什么软件包爱好者会关心

The package supplies two complementary executables: `phpcs` reports violations, while `phpcbf` automatically corrects violations for which a safe fixer exists.

Its discoverable project rulesets and installable external standards let one engine enforce PHP-FIG, framework, organization, or repository-specific conventions.

时间线

• 2000s: PHP_CodeSniffer begins in the Squiz ecosystem.
• 2010s: Composer installation and project rulesets become established distribution and configuration workflows.
• 2020s: PHPCSStandards becomes the official continuation of the Squizlabs project.

Related projects

• PHP CS Fixer overlaps with PHP_CodeSniffer's automatic-repair workflow but is centered on configurable source rewriting.
• Composer is an officially documented installation method for both global and project-local PHP_CodeSniffer use.

来源

• https://github.com/PHPCSStandards/PHP_CodeSniffer
• https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki
• https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/About-Standards-for-PHP_CodeSniffer
• https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Advanced-Usage
• https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Usage