Psalm Plugin Api Laravel Package

Product Decisions This Supports

• Developer Productivity & Code Quality: Enables seamless integration of custom static analysis rules into the Psalm ecosystem, reducing manual review effort and catching edge cases early in the SDLC.
• Scalability of Tooling: Facilitates modular, maintainable static analysis by allowing teams to build domain-specific plugins (e.g., business logic validation, framework-specific rules) without forking Psalm.
• Build vs. Buy: Justifies building custom analysis tools over buying third-party solutions when domain-specific needs exceed off-the-shelf offerings (e.g., proprietary frameworks, niche business logic).
• Roadmap Alignment: Supports long-term adoption of Psalm as a core tool in the tech stack by providing extensibility for future-proofing (e.g., integrating with new PHP versions or frameworks).
• Use Cases:
  • Enforcing team-specific coding standards (e.g., legacy codebase constraints).
  • Validating complex business logic (e.g., financial calculations, API contracts).
  • Framework-agnostic rule engines for microservices or monoliths.

When to Consider This Package

• Adopt if:
  • Your team uses Psalm for static analysis and needs to extend its functionality beyond built-in rules.
  • You have recurring edge cases that require custom validation (e.g., type safety for legacy code, framework-specific quirks).
  • You prioritize maintainability over one-off scripts (e.g., avoiding duplicated logic in CI/CD pipelines).
  • Your stack includes PHP 8.0+ (Psalm’s minimum supported version).
• Look elsewhere if:
  • You lack Psalm expertise or need a simpler solution (e.g., PHPStan plugins or basic linting tools).
  • Your use case is one-time (e.g., a single audit) rather than ongoing analysis.
  • You’re constrained by budget/time for plugin development (evaluate pre-built Psalm plugins or commercial tools first).
  • Your team prefers dynamic analysis (e.g., unit tests, property-based testing) over static checks.

How to Pitch It (Stakeholders)

For Executives: "This package lets us supercharge Psalm—our existing static analysis tool—by building custom rules tailored to our business needs. For example, we could automate validation of our payment processing logic or enforce stricter type safety in legacy systems without rewriting tests. It’s a low-risk investment: we only pay for development time, not licensing fees, and it future-proofs our codebase as we scale. Think of it as ‘open-source insurance’ for code quality."

For Engineering: *"The psalm/psalm-plugin-api gives us a stable way to write Psalm plugins without hacking the core. Key benefits:

• Reuse Psalm’s infrastructure: Leverage its type system, error reporting, and CI integration.
• Modularity: Plugins can be shared across projects or open-sourced.
• Performance: Runs alongside Psalm’s existing analysis (no overhead if unused). Example pitch: ‘Instead of manually reviewing this PR for null edge cases in the Order class, let’s build a plugin to auto-detect them—saving 2 hours per review.’* Ask: ‘What’s the top 1–2 pain points in our codebase that Psalm could solve if we had custom rules?’"*