Composer怎么通过脚本运行代码风格检查

小敏吖_2252

小敏吖_2252

2026-11-14

342人浏览

原创

在composer.json的scripts中添加如"cs:check": "phpcs --standard=PSR12 src/ tests/"即可调用PHP_CodeSniffer,前提是已通过composer require --dev squizlabs/php_codesniffer安装且vendor/bin/phpcs可执行。

composer怎么通过脚本运行代码风格检查

Composer 脚本里怎么调用 PHP_CodeSniffer

直接在 composer.json 的 "scripts" 里加一条命令就行,但得注意执行路径和依赖是否就绪。PHP_CodeSniffer(简称 PHPCS)本身不内置在 Composer 中,必须先装好,否则脚本会报 command not found。

常见写法:

"scripts": {
  "cs:check": "phpcs --standard=PSR12 src/ tests/"
}

这里 phpcs 是可执行命令,不是 PHP 函数;--standard=PSR12 指定规则集;src/ tests/ 是要检查的目录。如果项目没全局安装 PHPCS,就得确保它作为 dev 依赖存在:

  • composer require --dev squizlabs/php_codesniffer
  • 安装后,phpcs 命令会出现在 vendor/bin/phpcs,Composer 脚本默认把 vendor/bin 加入 PATH,所以可以直接写 phpcs

为什么 run-script 后提示 Class 'PHP_CodeSnifferRuleset' not found

这是 autoloader 没加载到 PHPCS 自身类,典型于用 php -f vendor/squizlabs/php_codesniffer/autoload.php 手动引入时路径写错,或 PHPCS 版本与 PHP 版本不兼容(比如 PHPCS 4.x 要求 PHP ≥7.4)。

更稳妥的做法是别手动 require,而是走 Composer 提供的 bin 包机制:

  • 确认 vendor/bin/phpcs 文件存在且可执行(Linux/macOS 下 chmod +x 有时是必须的)
  • 不要在脚本里写 php vendor/squizlabs/php_codesniffer/autoload.php 这类路径引用
  • 若用 Windows,确保 .bat 文件没被杀毒软件误删 —— vendor/bin/phpcs.bat 缺失会导致同样错误

怎么让 cs:check 只检查改动的文件(Git 集成)

PHPCS 本身不读 Git 状态,得靠 shell 命令组合。Composer 脚本支持内联 shell,但要注意跨平台兼容性 —— Windows cmd 对管道和反引号支持弱,建议统一用 bash 兼容写法,并限制在 CI 或开发机上运行。

Academic Composer Upload
Academic Composer Upload

辅助学术写作,包括查找资料、生成大纲、引用扩写及润色风格,同时确保引用规范。

下载

示例(只检查当前分支相对于 main 的新增/修改 PHP 文件):

"cs:staged": "git diff --cached --name-only --diff-filter=AM | grep '\.php$' | xargs -r phpcs --standard=PSR12",
"cs:unstaged": "git status -s | awk '$1 ~ /^[MA]$/ && $2 ~ /\.php$/ {print $2}' | xargs -r phpcs --standard=PSR12"

注意点:

  • xargs -r 在无输入时不执行 phpcs,避免报错
  • grep '\.php$' 中的双反斜杠是 JSON 字符串转义需要,实际生效的是单个 .
  • CI 环境中推荐用 git diff origin/main...HEAD 替代 main,避免分支名硬编码

PHP-CS-Fixer 和 PHPCS 能不能一起跑

能,但别混用同一套配置。PHPCS 是检查器(linter),PHP-CS-Fixer 是修复器(fixer),它们规则虽有重叠(如空格、括号),但实现逻辑不同。强行用 PHPCS 报错 + CS-Fixer 自动修,容易出现“修了又报”或“越修越错”。

建议分工明确:

  • cs:check:只用 PHPCS,保持只读、只反馈
  • cs:fix:用 PHP-CS-Fixer,且加 --dry-run --diff 先预览,再决定是否加 --force
  • 两者共用同一标准?PSR-12 可以,但需分别配置:phpcs --standard=PSR12 vs php-cs-fixer fix --rules=@PSR12

最常被忽略的是:PHPCS 的 --report=checkstyle 输出能被 CI 工具解析,而 PHP-CS-Fixer 默认输出是 human-readable 文本,集成进 Git hook 或 CI 时得额外处理格式。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

composer脚本 composer

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.12.25

364

5

Composer 安装与快速入门指南
Composer 安装与快速入门指南

面向 PHP 开发新手,详细介绍 Composer 的下载安装方式(本地安装与全局安装)、国内镜像源(阿里云/腾讯云)加速配置、composer.json 与 composer.lock 文件的作用解析、require/install/update 等核心命令的使用方法,帮助开发者快速掌握 PHP 依赖管理的基本工作流。

2026.04.10

623

36

Composer 依赖管理与版本控制实战
Composer 依赖管理与版本控制实战

深入讲解 Composer 的依赖管理机制,涵盖语义化版本号规范、版本约束符(^、~、*、>=)的区别与最佳实践、composer.lock 在团队协作中的锁定策略、依赖冲突的排查与解决方法、require-dev 与生产依赖的分离管理、平台依赖检查(platform-check)等进阶内容,帮助开发者在项目中精准控制依赖版本、避免"依赖地狱"。

2026.04.10

387

29

Composer 自定义包开发与发布教程合集
Composer 自定义包开发与发布教程合集

以实际项目为导向,讲解如何从零创建一个符合规范的 Composer 包,涵盖 composer.json 元信息配置、PSR-4 自动加载规则设置、命名空间规划、单元测试集成、README 与 LICENSE 编写规范,以及将包提交到 Packagist 公共仓库或搭建 Satis/Private Packagist 私有仓库的完整发布流程,帮助开发者将可复用代码封装为标准化的 Composer 包。

2026.04.10

409

15

Composer 自动加载机制与性能优化
Composer 自动加载机制与性能优化

系统剖析 Composer 的自动加载体系,讲解 PSR-0 与 PSR-4 自动加载标准的区别与演进、classmap 与 files 加载方式的适用场景、autoload_real.php 源码级加载流程解析,同时介绍 composer dump-autoload -o 优化加载映射、APCu 缓存加速、authoritative-classmap 配置等生产环境性能优化手段,帮助开发者深入理解自动加载原理并提升项目启动速度。

2026.04.13

360

21

Composer 在主流 PHP 框架中的应用实践
Composer 在主流 PHP 框架中的应用实践

结合 Laravel、ThinkPHP、Symfony 等主流 PHP 框架的实际场景,讲解 Composer 在框架项目中的典型应用,包括通过 create-project 初始化框架项目、安装与管理第三方扩展包、scripts 钩子(post-install/post-update)自动执行部署任务、自定义 Installer 插件开发、多项目共享 vendor 依赖的 Monorepo 工作流管理,帮助开发者在真实框架项目中充分发

2026.04.13

563

14

Composer 镜像源配置与网络问题排查
Composer 镜像源配置与网络问题排查

针对国内开发者常遇到的 Composer 网络问题,详细讲解阿里云、腾讯云、华为云等国内镜像源的全局与项目级切换方法、多镜像源优先级配置策略、composer config 命令行快速设置技巧,同时涵盖 SSL 证书错误、连接超时、下载中断等常见网络报错的排查与修复方案,以及利用 artifact / path 仓库实现完全离线环境下的依赖安装。

2026.04.14

371

24

Composer Scripts 脚本与自动化工作流
Composer Scripts 脚本与自动化工作流

系统讲解 Composer Scripts 机制的完整用法,涵盖 pre-install、post-update、post-autoload-dump 等内置事件钩子的触发时机与应用场景、自定义脚本命令的定义与参数传递、调用外部 Shell 命令与 PHP 静态方法、多脚本串联执行与条件判断,以及结合代码检查(PHPStan/PHP-CS-Fixer)、数据库迁移、缓存清理等任务构建一键部署自动化工作流。

2026.04.14

450

18

Composer 私有仓库搭建与企业级管理
Composer 私有仓库搭建与企业级管理

面向团队与企业开发场景,讲解如何使用 Satis 搭建轻量级静态私有仓库、通过 Toran Proxy / Private Packagist 构建功能完善的企业级私有包管理平台,涵盖 Git/SVN 仓库类型接入、Token 鉴权与访问权限控制、Webhook 自动触发包更新、内网部署方案以及与 GitLab CI/CD 流水线的集成配置,帮助企业安全高效地管理内部 PHP 组件资产。

2026.04.14

480

26

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpMyAdmin 安装文档
phpMyAdmin 安装文档

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习