Skip to content

Rewrite README: what the plugin does and why to use it #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alies-dev wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Rewrite README: what the plugin does and why to use it #161

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99461a2
Rewrite README to explain what the plugin does and why to use it
alies-dev Jun 21, 2026
486052b
Use neutral tagline wording
alies-dev Jun 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
# phpunit-psalm-plugin
# psalm-plugin-phpunit

A PHPUnit plugin for [Psalm](https://github.com/vimeo/psalm) (requires Psalm v4+).
A [Psalm](https://github.com/vimeo/psalm) plugin for PHPUnit (requires Psalm v4+).

Installation:
## What it does

Psalm does not understand PHPUnit conventions on its own. This plugin makes Psalm aware of them, so static analysis of your test suite stops flooding you with false positives.

## Features

* **Silences false `MissingConstructor`** on stateful test cases. Properties initialized in `setUp()` or a `@before` / `#[Before]` method are recognized as initialized.
* **Validates data providers.** It checks that a referenced provider exists, returns an `iterable` (array, generator, or object), and that each dataset shape matches the parameters of the test method it feeds (types, count, optional offsets, variadic params, defaults).
* **Reports broken providers.** Missing providers, wrong return types, mismatched dataset types, and providers returning `null` are flagged before the suite ever runs.
* **Fixes unused-code detection for tests.** Test methods, providers referenced from docblocks or attributes, and `TestCase` descendants are no longer reported as unused, while genuinely dead test helpers still are.
* **Types `prophesize()`.** `$this->prophesize(Foo::class)` is inferred as `ObjectProphecy<Foo>`, so calls on the prophecy are type-checked.

## Installation

```
composer require --dev psalm/plugin-phpunit
Expand Down
Loading