如何使用Psalm或PHPStan进行静态分析_将静态分析工具集成到Composer scripts

1次阅读

集成Psalm和phpStan可提升PHP项目代码质量,通过composer安装并初始化生成配置文件,将分析命令添加到composer.json的scripts中,如”analyze”: [“psalm”, “phpstan analyse”],支持单独或同时运行工具,结合CI/CD流程在每次提交时自动检查,防止错误合入主分支,还可配合ide插件和git钩子实现实时提示与预提交校验,显著增强开发体验。

如何使用Psalm或PHPStan进行静态分析_将静态分析工具集成到Composer scripts

在PHP项目中集成静态分析工具如Psalm或PHPStan,能有效发现潜在错误、类型问题和代码坏味道。将它们作为Composer脚本的一部分,可以确保团队成员在开发、测试或部署时自动执行检查,提升代码质量。

安装Psalm或PHPStan

通过Composer安装任一工具:

composer require –dev vimeo/psalm
composer require –dev phpstan/phpstan

安装完成后,初始化工具以生成配置文件

  • Psalm:运行 ./vendor/bin/psalm –init,它会扫描项目并生成psalm.xml
  • PHPStan:创建phpstan.neon文件,例如:

parameters: level: 5 paths:

  • src

添加静态分析到Composer Scripts

打开composer.json,在“scripts”部分添加命令:

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

“scripts”: { “analyze”: [ “psalm”, “phpstan analyse” ], “analyze:psalm”: “psalm”, “analyze:phpstan”: “phpstan analyse” }

现在可以通过以下命令运行分析:

如何使用Psalm或PHPStan进行静态分析_将静态分析工具集成到Composer scripts

Fotor AI Image Upscaler

Fotor推出的AI图片放大工具

如何使用Psalm或PHPStan进行静态分析_将静态分析工具集成到Composer scripts 73

查看详情 如何使用Psalm或PHPStan进行静态分析_将静态分析工具集成到Composer scripts

  • composer analyze:同时运行两个工具
  • composer analyze:psalm:仅运行Psalm
  • composer analyze:phpstan:仅运行PHPStan

在CI/CD中使用分析脚本

将静态分析加入持续集成流程,比如github Actions:

  • name: Run Static Analysis run: | composer analyze

这样每次提交代码时都会自动检查,防止低级错误合入主分支。

提升开发体验的小技巧

结合IDE插件或Git钩子进一步增强效果:

  • phpstorm 中安装 PHPStan 或 Psalm 插件,实时提示问题
  • 使用 composer install 后自动设置 Git pre-commit 钩子,运行 composer analyze:phpstan
  • 为本地开发提供快捷命令,比如 composer check 包含分析、CS检查和测试

基本上就这些。集成静态分析不复杂但容易忽略,用好 Composer scripts 能让整个过程无缝融入日常开发。

以上就是如何使用Psalm或PHPStan进行静态分析_将静态分析

text=ZqhQzanResources