Skip to content

Commit 5e36c19

Browse files
phpstan-botclaude
authored andcommitted
Document console output statuses in README
Add a "Console output" section describing the per-package status messages (installed, not supported, ignored) that the plugin reports after composer install/update. These behaviors exist in Plugin.php but were not documented. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent bfa982b commit 5e36c19

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,14 @@ Add `phpstan` key in the extension `composer.json`'s `extra` section:
7272
}
7373
```
7474

75+
## Console output
76+
77+
After each `composer install` or `composer update`, the plugin reports per-package status when the configuration changes:
78+
79+
- **installed** — the extension was successfully registered.
80+
- **not supported** — a package has `phpstan` in its name but is not configured as a PHPStan extension (missing the `phpstan-extension` type and `extra.phpstan` key). This may indicate the package requires manual `includes` configuration.
81+
- **ignored** — the extension was skipped due to the ignore list (see below).
82+
7583
## Ignoring a particular extension
7684

7785
You may want to disable auto-installation of a particular extension to handle installation manually. Ignore an extension by adding an `extra.phpstan/extension-installer.ignore` array in `composer.json` that specifies a list of packages to ignore:

0 commit comments

Comments
 (0)