shipmonk/phpstan-dev

Development utilities for PHPStan rules testing, extracted from shipmonk/phpstan-rules

Maintainers

Details

github.com/shipmonk-rnd/phpstan-dev

Source

Issues

Installs: 10 908

Dependents: 3

Suggesters: 0

Security: 0

Stars: 6

Watchers: 1

Forks: 1

Open Issues: 0

pkg:composer/shipmonk/phpstan-dev

0.1.3 2025-12-04 08:14 UTC

Requires

Requires (Dev)

Suggests

MIT d5b110c8f26cd0154b53038ad66703457f52146a

testingstatic analysisPHPStan

This package is auto-updated.

Last update: 2025-12-09 14:02:07 UTC

README

Inplace fixture asserts and autofix for PHPStan rules. No more manual line adjustments in tests when new code is added to rule fixtures.

Installation

composer require --dev shipmonk/phpstan-dev

Usage

<?php declare(strict_types = 1);

use PHPStan\Rules\Rule;

/**
 * @extends RuleTestCase<YourRule>
 */
class YourRuleTest extends \ShipMonk\PHPStanDev\RuleTestCase
{
    public function testRule(): void
    {
        $this->analyzeFiles([__DIR__ . '/Data/code.php']);
    }
}

Create test fixture at code.php:

<?php

$valid = 'This is valid code';
$invalid = something(); // error: Rule error message

Key Features

In-fixture error asserts of via // error:

Mark expected errors directly in test files via PHP comments:

<?php

$validCode = 'No error expected here';
$invalidCode = forbidden(); // error: Rule error message
$alsoInvalid = another(); // error: Rule error message // error: Same-line multi errors

Autofix

Automatically generate inplace error comments during development:

public function testRule(): void
{
    $this->analyzeFiles([...], autofix: true);
}

⚠️ Important: Remove autofix: true before committing - tests will fail if autofix is enabled.

Contributing

  • Check your code by composer check
  • Autofix coding-style by composer fix:cs
  • All functionality must be tested

License

MIT