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#'

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

相关专题

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

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

1699

2023.09.01

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

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

1123

2023.10.11

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

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

1032

2023.10.11

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

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

948

2023.10.23

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

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

1396

2023.10.23

html怎么上传
html怎么上传

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

1228

2023.11.03

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

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

1438

2023.11.09

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

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

1302

2023.11.13

笔记本电脑卡反应很慢处理方法汇总
笔记本电脑卡反应很慢处理方法汇总

本专题整合了笔记本电脑卡反应慢解决方法,阅读专题下面的文章了解更多详细内容。

1

2025.12.25

热门下载

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

精品课程

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

共86课时 | 3.4万人学习

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

共28课时 | 2.3万人学习

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

共93课时 | 6.6万人学习

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

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