如何在composer.json中定义项目的代码规范（如PSR-12）？-composer-PHP中文网

如何在composer.json中定义项目的代码规范（如PSR-12）？

冰火之心

发布： 2025-11-16 17:37:02

原创

315人浏览过

答案：通过 Composer 配置开发依赖和脚本集成 PHP CS Fixer 或 PHP_CodeSniffer，可在项目中实现 PSR-12 代码规范检查与修复，提升代码一致性。

如何在composer.json中定义项目的代码规范（如psr-12）？

要在 composer.json 中定义项目的代码规范（如 PSR-12），Composer 本身不直接执行代码规范检查，但你可以通过配置脚本或开发依赖来集成代码规范工具。常用方式是结合 PHP_CodeSniffer 或 PHP CS Fixer 来实现。

推荐使用 PHP CS Fixer 或 PHP_CodeSniffer。以 PHP CS Fixer 为例：

composer require --dev friendsofphp/php-cs-fixer

如果你更喜欢 PHP_CodeSniffer：

composer require --dev squizlabs/php_codesniffer

在项目根目录创建配置文件，例如使用 PHP CS Fixer 时，创建 .php-cs-fixer.php：

// .php-cs-fixer.php
$finder = PhpCsFixer\Finder::create()
->in(__DIR__ . '/src')
->in(__DIR__ . '/tests');

return PhpCsFixer\Config::create()
->setRules(['@PSR12' => true])
->setFinder($finder);

如果使用 PHP_CodeSniffer，可在 phpcs.xml 中定义：

<?xml version="1.0"?>
<ruleset>
  <rule ref="PSR12"/>
  <file>src/</file>
  <file>tests/</file>
</ruleset>

将代码规范检查和修复命令加入 scripts 字段，方便团队统一调用：

如知AI笔记

如知笔记——支持markdown的在线笔记，支持ai智能写作、AI搜索，支持DeepseekR1满血大模型

"scripts": {
  "cs:check": "php-cs-fixer fix --dry-run --verbose",
  "cs:fix": "php-cs-fixer fix",
  "lint": "phpcs"
}

这样开发者可以通过以下命令检查代码：

composer run cs:check

自动修复不符合规范的代码：

composer run cs:fix

将这些脚本加入持续集成流程，确保提交的代码符合 PSR-12 规范。例如在 GitHub Actions 中添加步骤：

- name: Check code style
run: composer run cs:check

基本上就这些。Composer 不直接管理代码规范，但通过 dev 依赖和脚本，可以很好地集成 PSR-12 等标准，提升项目代码一致性。

以上就是如何在composer.json中定义项目的代码规范（如PSR-12）？的详细内容，更多请关注php中文网其它相关文章！

大家都在看：