psalm/plugin-laravel

Laravel的Psalm插件

安装次数: 3,528,197

依赖者: 313

建议者: 1

安全: 0

星星: 299

关注者: 9

分支: 69

开放问题: 17

类型:psalm-plugin

v2.11.0 2024-03-19 21:40 UTC

README

该包正在寻找维护者

⚠️ 这是一个深入了解Laravel并与其他高级开发者协作的绝佳机会。目前,该包几乎完全由@alies-dev维护,他正在寻找开发者来组建一个团队,不断改进这个包和整个Psalm生态系统。

一些实施想法

  • 完全支持自定义模型查询构建器(中等)
  • 添加一个选项,仅依赖模型@property声明
  • 去除对barryvdh/laravel-ide-helper的依赖,并使属性类型更准确
  • 支持迁移的.sql文件(以查找属性及其类型的信息)

Packagist version Packagist downloads Type coverage Tests Tests

概述

Psalm插件将静态分析和类型支持带到使用Laravel的项目中。我们的目标是尽可能多地发现类型相关的错误,从而提高开发者的生产力和应用程序的健康状况。无需编写测试即可发现错误!

Screenshot

版本和依赖项

维护版本

有关支持的PHP、Laravel和Psalm版本的详细信息,请参阅发行版

快速入门

步骤1:安装

composer require --dev psalm/plugin-laravel

步骤2:配置

如果您之前没有在该项目中使用Psalm,则需要创建一个Psalm配置

./vendor/bin/psalm --init

步骤3:启用插件

./vendor/bin/psalm-plugin enable psalm/plugin-laravel

步骤4:运行 🚀

运行您通常的Psalm命令

./vendor/bin/psalm

您可以使用XML配置和/或CLI参数来自定义Psalm配置。

建议:使用基线文件并将errorLevel至少增加到4:这样可以捕获更多问题。逐步将errorLevel设置为1,并充分利用Psalm和此插件 🚀。

工作原理

在底层,它只是运行https://github.com/barryvdh/laravel-ide-helper并将生成的占位符传递给Psalm,Psalm可以读取PhpStorm元占位符。

它还解析它找到的任何数据库迁移,以尝试理解数据库模型中的属性类型。

Psalm-Laravel-Plugin或Larastan?

两者都是!在同一个项目中使用这两个工具是完全可以的:它们使用不同的方法分析代码,因此您可以找到更多的错误!Psalm和PHPStan使用几乎相同的语法注释,因此您不应该有任何冲突。