0

0

composer如何给项目添加代码质量工具

裘德小鎮的故事

裘德小鎮的故事

发布时间:2025-09-20 18:16:01

|

989人浏览过

|

来源于php中文网

原创

通过Composer集成代码质量工具可统一版本管理和团队协作,并便于CI/CD集成。首先选择PHPStan、Psalm、PHP_CodeSniffer、PHPMD、ECS等工具,使用composer require --dev安装。接着创建对应配置文件:phpstan.neon、phpcs.xml、phpmd.xml、.php-cs-fixer.dist.php,定义分析规则、代码风格和检查路径。然后在composer.json中添加scripts,如"phpstan": "phpstan analyse"等,方便调用。最后将这些命令写入CI/CD流程(如GitHub Actions),在每次提交时自动执行检查。自定义代码风格可通过修改phpcs.xml继承或调整规则实现;报错需根据提示修复问题,若为误报可在配置中谨慎忽略。

composer如何给项目添加代码质量工具

Composer 添加代码质量工具,本质上就是通过 Composer 管理代码质量工具的依赖,并配置相应的执行脚本,让这些工具能够集成到你的项目中。这样做的好处是版本控制统一,方便团队协作,也能更容易地在 CI/CD 流程中执行代码质量检查。

首先,你需要选择合适的代码质量工具。常见的 PHP 代码质量工具包括:

  • PHPStan: 静态分析工具,可以发现代码中的潜在错误。
  • Psalm: 另一个静态分析工具,功能类似 PHPStan。
  • PHP_CodeSniffer: 检查代码风格是否符合 PSR 标准或其他自定义标准。
  • PHPMD: 检测代码中的潜在问题,如过度复杂的方法、未使用的代码等。
  • EasyCodingStandard (ECS): 基于 PHP_CodeSniffer 和 PHP-CS-Fixer 的工具,可以自动修复代码风格问题。

接下来,使用 Composer 安装这些工具。

composer require --dev phpstan/phpstan
composer require --dev squizlabs/php_codesniffer
composer require --dev phpmd/phpmd
composer require --dev friendsofphp/php-cs-fixer

安装完成后,你需要配置这些工具。

PHPStan 配置:

在项目根目录下创建

phpstan.neon
文件,配置 PHPStan 的分析级别和要分析的文件目录。

parameters:
    level: 5
    paths:
        - src
        - tests

PHP_CodeSniffer 配置:

创建

phpcs.xml
文件,配置代码风格标准。



    My project coding standard

    

PHPMD 配置:

创建

phpmd.xml
文件,配置要使用的规则集。



    
        My custom ruleset.
    

    
    
    

PHP-CS-Fixer 配置:

创建

.php-cs-fixer.dist.php
文件,配置代码风格修复规则。

maven使用方法 中文WORD版
maven使用方法 中文WORD版

本文档主要讲述的是maven使用方法;Maven是基于项目对象模型的(pom),可以通过一小段描述信息来管理项目的构建,报告和文档的软件项目管理工具。Maven将你的注意力从昨夜基层转移到项目管理层。Maven项目已经能够知道 如何构建和捆绑代码,运行测试,生成文档并宿主项目网页。希望本文档会给有需要的朋友带来帮助;感兴趣的朋友可以过来看看

下载
in(__DIR__ . '/src')
    ->in(__DIR__ . '/tests');

$config = new Config();
return $config->setRules([
        '@PSR12' => true,
        'strict_param' => true,
        'array_syntax' => ['syntax' => 'short'],
    ])
    ->setFinder($finder);

最后,在

composer.json
文件中添加 scripts,方便执行这些工具。

{
    "scripts": {
        "phpstan": "phpstan analyse",
        "phpcs": "phpcs",
        "phpmd": "phpmd src text phpmd.xml",
        "phpcbf": "phpcbf",
        "php-cs-fixer": "php-cs-fixer fix"
    }
}

现在,你可以使用

composer phpstan
,
composer phpcs
,
composer phpmd
,
composer phpcbf
,
composer php-cs-fixer
命令来执行相应的代码质量检查和修复。

如何在 CI/CD 流程中集成这些代码质量工具?

将这些命令添加到你的 CI/CD 配置文件中。例如,如果使用 GitHub Actions,可以在

.github/workflows/main.yml
文件中添加以下步骤:

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3

      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: '8.1'
          extensions: mbstring, intl

      - name: Install Dependencies
        run: composer install --no-interaction --no-progress --no-scripts

      - name: Run PHPStan
        run: composer phpstan

      - name: Run PHP_CodeSniffer
        run: composer phpcs

      - name: Run PHPMD
        run: composer phpmd

这样,每次提交代码时,CI/CD 流程都会自动执行代码质量检查,并报告结果。

如何自定义代码风格标准?

自定义代码风格标准,需要修改

phpcs.xml
文件。你可以选择继承现有的标准,然后添加或修改规则。例如,你可以继承 PSR12 标准,然后禁用某些规则:



    My project coding standard

    

    
        0
    

在这个例子中,我们禁用了

Generic.Arrays.DisallowLongArraySyntax
规则,允许使用长数组语法。

另外,你也可以完全自定义一套代码风格标准,但这需要花费更多的时间和精力。

如何处理代码质量工具的报错?

代码质量工具的报错通常意味着代码中存在问题。你需要仔细阅读报错信息,找到问题所在,并进行修复。

  • PHPStan 和 Psalm 的报错: 通常是类型错误、未定义的变量、未使用的变量等。
  • PHP_CodeSniffer 的报错: 通常是代码风格不符合标准。
  • PHPMD 的报错: 通常是代码过于复杂、存在潜在的性能问题等。

修复这些报错可以提高代码质量,减少潜在的 bug。如果某些报错是误报,你可以通过配置文件忽略这些报错。例如,在 PHPStan 中,可以使用

ignoreErrors
参数来忽略某些报错。

parameters:
    level: 5
    paths:
        - src
        - tests
    ignoreErrors:
        - '#Access to an undefined property#'

注意,忽略报错应该谨慎,只有在确认是误报的情况下才应该这样做。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

155

2023.12.25

json数据格式
json数据格式

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

420

2023.08.07

json是什么
json是什么

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

536

2023.08.23

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

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

312

2023.10.13

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

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

77

2025.09.10

require的用法
require的用法

require的用法有引入模块、导入类或方法、执行特定任务。想了解更多require的相关内容,可以阅读本专题下面的文章。

466

2023.11.27

pdf怎么转换成xml格式
pdf怎么转换成xml格式

将 pdf 转换为 xml 的方法:1. 使用在线转换器;2. 使用桌面软件(如 adobe acrobat、itext);3. 使用命令行工具(如 pdftoxml)。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1903

2024.04.01

xml怎么变成word
xml怎么变成word

步骤:1. 导入 xml 文件;2. 选择 xml 结构;3. 映射 xml 元素到 word 元素;4. 生成 word 文档。提示:确保 xml 文件结构良好,并预览 word 文档以验证转换是否成功。想了解更多xml的相关内容,可以阅读本专题下面的文章。

2093

2024.08.01

2026赚钱平台入口大全
2026赚钱平台入口大全

2026年最新赚钱平台入口汇总,涵盖任务众包、内容创作、电商运营、技能变现等多类正规渠道,助你轻松开启副业增收之路。阅读专题下面的文章了解更多详细内容。

30

2026.01.31

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二十四期_PHP8编程
第二十四期_PHP8编程

共86课时 | 3.4万人学习

成为PHP架构师-自制PHP框架
成为PHP架构师-自制PHP框架

共28课时 | 2.5万人学习

第二十三期_PHP编程
第二十三期_PHP编程

共93课时 | 7万人学习

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

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