phpstan / extension-installer
Composer plugin for automatic installation of PHPStan extensions
Installs: 54 892 639
Dependents: 6 286
Suggesters: 5
Security: 0
Stars: 419
Watchers: 6
Forks: 27
Open Issues: 4
Type:composer-plugin
Requires
- php: ^7.2 || ^8.0
- composer-plugin-api: ^2.0
- phpstan/phpstan: ^1.9.0 || ^2.0
Requires (Dev)
- composer/composer: ^2.0
- php-parallel-lint/php-parallel-lint: ^1.2.0
- phpstan/phpstan-strict-rules: ^0.11 || ^0.12 || ^1.0
README
Composer plugin for automatic installation of PHPStan extensions.
Motivation
diff --git a/phpstan.neon b/phpstan.neon index db4e3df32e..2ca30fa20a 100644 --- a/phpstan.neon +++ b/phpstan.neon @@ -1,12 +1,3 @@ -includes: - - vendor/phpstan/phpstan-doctrine/extension.neon - - vendor/phpstan/phpstan-doctrine/rules.neon - - vendor/phpstan/phpstan-nette/extension.neon - - vendor/phpstan/phpstan-nette/rules.neon - - vendor/phpstan/phpstan-phpunit/extension.neon - - vendor/phpstan/phpstan-phpunit/rules.neon - - vendor/phpstan/phpstan-strict-rules/rules.neon - parameters: autoload_directories: - %rootDir%/../../../build/SlevomatSniffs diff --git a/composer.json b/composer.json index 1b578dd624..f6ebf6e477 100644 --- a/composer.json +++ b/composer.json @@ -142,6 +142,7 @@ "jakub-onderka/php-parallel-lint": "1.0.0", "justinrainbow/json-schema": "5.2.8", "ondrejmirtes/mocktainer": "0.8", + "phpstan/extension-installer": "^1.0", "phpstan/phpstan": "^0.11.7", "phpstan/phpstan-doctrine": "^0.11.3", "phpstan/phpstan-nette": "^0.11.1",
Usage
composer require --dev phpstan/extension-installer
Starting from Composer 2.2.0 you'll get the following question:
phpstan/extension-installer contains a Composer plugin which is currently not in your allow-plugins config. See https://getcomposer.org/allow-plugins
Do you trust "phpstan/extension-installer" to execute code and wish to enable it now? (writes "allow-plugins" to composer.json) [y,n,d,?]
Answer with y
to allow the plugin.
Instructions for extension developers
It's best (but optional) to set the extension's composer package type to phpstan-extension
for this plugin to be able to recognize it and to be discoverable on Packagist.
Add phpstan
key in the extension composer.json
's extra
section:
{ "extra": { "phpstan": { "includes": [ "extension.neon" ] } } }
Ignoring a particular extension
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:
{ "extra": { "phpstan/extension-installer": { "ignore": [ "phpstan/phpstan-phpunit" ] } } }
Limitations
The extension installer depends on Composer script events, therefore you cannot use --no-scripts
flag.