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 更灵活):
    <?php
    return (new PhpCsFixer\Config())
        ->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 都自动验一遍。

SekoTalk
SekoTalk

商汤科技推出的AI对口型视频创作工具

下载

立即学习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 要真实执行、贡献指南要有人读——质量保障不是加个工具,而是建一套可落地的小闭环。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

161

2023.12.25

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

453

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

331

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

phpstorm怎么导出项目
phpstorm怎么导出项目

phpstorm提供导出项目功能,步骤如下:打开phpstorm项目转到“项目”菜单选择“导出项目”选择导出格式指定导出位置选择导出范围勾选“包括依赖项”框(可选)单击“导出”完成导出。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

385

2024.04.08

phpStorm怎么运行
phpStorm怎么运行

本专题整合了phpstorm运行教程,阅读专题下面的文章了解更多相关内容。

89

2025.09.18

phpstorm开发环境搭建教程
phpstorm开发环境搭建教程

本专题整合了phpstorm开发环境搭建和运行项目教程,阅读专题下面的文章了解更多详细教程。

78

2025.09.18

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

44

2026.03.06

热门下载

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

精品课程

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

共137课时 | 13.1万人学习

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

共6课时 | 11.3万人学习

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

共13课时 | 1.0万人学习

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

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