0

0

如何为你的Composer包添加PHPStan或PHP-CS-Fixer支持?(质量保障)

冰火之心

冰火之心

发布时间:2026-01-13 11:16:39

|

280人浏览过

|

来源于php中文网

原创

Composer 包中集成 PHPStan 和 PHP-CS-Fixer 需配置可复现的静态分析与代码格式化:PHPStan 通过 phpstan.neon 设定分析路径与等级,绑定 composer script;PHP-CS-Fixer 用 .php-cs-fixer.php 定义规则并集成至开发流程。

如何为你的composer包添加phpstan或php-cs-fixer支持?(质量保障)

直接在 Composer 包里集成 PHPStan 和 PHP-CS-Fixer,不是加个依赖就完事——关键是要让它们真正跑起来、可复现、易维护,且不干扰用户使用。

PHPStan:静态分析要覆盖你的代码边界

PHPStan 能帮你提前发现类型错误、未定义方法、死代码等问题。对开源包尤其重要,因为调用方式不可控。

  • 安装时加 --dev:运行 composer require --dev phpstan/phpstan
  • 在项目根目录加 phpstan.neon(或 phpstan.neon.dist),内容至少包含:
    parameters:
      level: 6
      paths:
        - src
      excludePaths:
        - tests/_support
    
  • composer.jsonscripts 里加一行:"phpstan": "phpstan analyse --configuration=phpstan.neon",之后就能用 composer phpstan 快速检查
  • 如果包支持多 PHP 版本,建议在 GitHub Actions 中用 phpstan/phpstan-shim 避免依赖冲突

PHP-CS-Fixer:格式统一靠规则,不是靠人盯

代码风格一致是协作基础,尤其当别人给你提 PR 时,别让空格和换行成为合并障碍。

  • 安装:composer require --dev friendsofphp/php-cs-fixer
  • 配置文件 .php-cs-fixer.php(推荐用 PHP 数组写法,比 JSON 更灵活):
    setRules([
            '@PSR12' => true,
            'array_syntax' => ['syntax' => 'short'],
            'declare_strict_types' => true,
            'no_unused_imports' => true,
        ])
        ->addFinder(PhpCsFixer\Finder::create()->in(['src', 'tests']));
    
  • composer.json 中添加脚本:"cs-fix": "php-cs-fixer fix --dry-run --verbose"(CI 用)和 "cs-fix-write": "php-cs-fixer fix"(本地修)
  • CI 中建议先用 --dry-run 失败即退出,避免格式问题偷偷过 CI

CI 自动化:把质量检查变成每次提交的守门员

光本地能跑没用,得让 GitHub Actions 或 GitLab CI 每次 PR 都自动验一遍。

Figma Slides
Figma Slides

Figma Slides 是 Figma 发布的PPT制作和演示文稿生成工具,可以帮助创建、设计、定制和分享演示文稿

下载

立即学习PHP免费学习笔记(深入)”;

  • .github/workflows/test.yml 中加两个 job:
    • phpstan:用官方 PHPStan action 或直接 run: composer phpstan,PHP 版本建议和最低支持版本一致
    • cs-check:运行 composer cs-fix,失败说明有格式问题
  • 加上 cache: composercache: ~/.composer 加速重复构建
  • 如果包带测试,把 PHPStan 和 CS Fixer 放在 test job 之前,早发现问题早修复

文档与约定:让协作者一眼知道怎么参与质量共建

再好的工具,没人用等于没装。在 CONTRIBUTING.md 里写清楚三件事:

  • 运行命令:composer phpstancomposer cs-fix-write
  • CI 会检查什么(比如 “PHPStan level 6 不允许任何 error”)
  • 如何本地预检:make check(可选封装脚本)或推荐 IDE 插件(如 PHPStorm + PHP-CS-Fixer 插件)

基本上就这些。不复杂但容易忽略的是:配置文件要提交进仓库、CI 要真实执行、贡献指南要有人读——质量保障不是加个工具,而是建一套可落地的小闭环。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2490

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1587

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1483

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

952

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1414

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1234

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1445

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1305

2023.11.13

php与html混编教程大全
php与html混编教程大全

本专题整合了php和html混编相关教程,阅读专题下面的文章了解更多详细内容。

3

2026.01.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.6万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 6.9万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号