ghostwriter/psalm-plugin

Provides a plugin for Psalm

0.2.0 2023-08-27 13:19 UTC

Requires

• php: >=8.1

Requires (Dev)

• ghostwriter/coding-standard: dev-main
• ghostwriter/psalm-plugin-tester: ^0.2 || ^0.3 || ^1.0
• psr/container: ^1.1 || ^2.0
• vimeo/psalm: ^5.0 || ^6.0

Replaces

• ghostwriter/example-psalm-plugin: *
• ghostwriter/phpunit-psalm-plugin: *

BSD-3-Clause

• Nathanael Esayeas

• static analysis
• dev
• psalm
• psalm-plugin
• ghostwriter

README

Provides an ALL-IN-ONE plugin for Psalm

Usage

composer require ghostwriter/psalm-plugin --dev
vendor/bin/psalm-plugin enable ghostwriter/psalm-plugin

vendor/bin/psalm

Feature

• PHP Standards Recommendations
  • Cache
  • Container
    • Resolve return type for the get method.
  • Clock
  • Event Dispatcher
  • Link
  • Log
  • Http
• PHPUnit
  • Suppress MissingThrowsDocblock for classes that extending TestCase
  • Suppress UnusedClass for classes that extending TestCase
  • Suppress PropertyNotSetInConstructor for classes that extending TestCase
    • Using assertPreConditions method
    • Using setUp method
    • Using setUpBeforeClass method
    • Using @before docblock
    • Using @beforeClass docblock
    • Using #[Before] attribute
    • Using #[BeforeClass] attribute
    • Using #[PreCondition] attribute
• Privatization
  • Finalize every class that has no children (!isAbstract && !isAnonymous)
  • Finalize every class method on an abstract class if possible (!isAbstract && !isPrivate)
  • Change protected class method to private if possible
  • Change protected class property to private if possible
• Strict Types
• [Request a Feature]

Changelog

Please see CHANGELOG.md for more information on what has changed recently.

Security

If you discover any security-related issues, please use Security Advisories instead of using the issue tracker.

Credits

• Nathanael Esayeas
• All Contributors

License

The BSD-3-Clause. Please see License File for more information.