About plugin

The plugin helps Psalm to understand Laravel’s code (which uses a lot of magic) better. There are 2 main ways how it does it:

• easy: by providing stub files (you can find them in /stubs dir)
• medium+: using custom Handlers (see /src/Handlers dir)

Documentation

• Configuration — plugin XML config options and environment variables
• GitHub Actions — running Psalm in CI with GitHub Actions
• Upgrading to v4 — migration guide from v3
• Contribution:
  • Overview — how the plugin works, getting started, adding stubs and handlers
  • Architecture Decisions — key design decisions and rationale
  • Debugging with Xdebug — stepping through plugin code
  • Taint Analysis
  • Types — Psalm types and annotations (incl. internal/hidden)

Custom Issues

The plugin emits custom issues that Psalm does not have built-in. Each one links to detailed documentation with examples and fix guidance.

• NoEnvOutsideConfig
• InvalidConsoleArgumentName
• InvalidConsoleOptionName
• MissingTranslation
• MissingView
• ModelMakeDiscouraged
• OctaneIncompatibleBinding