PHPStan static analysis

Note

This is a fork of OhMyMndy/vscode-phpstan created in order to avoid forcing the analysis level if there is a phpstan.neon or phpstan.neon.dist file present - as in that case, we want to control everything through that file, including the analysis level.

This is just a hack, there's a lot of other stuff not up-to-date here (e.g. dependencies), the lock file is not in sync with the main package.json, and I'm just gonna leave it like this for now because the hack solves my immediate problem of having to manually configure the extension for each individual project, rather than having the extension provide sane behavior by default.

Furthermore, diagnostics are cleared when a file is closed, with the goal of only displaying diagnostics for currently opened files.

Note

Because calvinbaart/vscode-phpstan seems not supported anymore, I have continued development through this fork

What is this

PHPStan is a static analysis tool for PHP. This extension integrates the output of PHPStan in VSCode allowing the developer to find errors quicker.

Installation

PHPStan is required to use this extension. By default the plugin will search the global vendor folder and the workspace vendor folders. The COMPOSER_HOME environment variable can be set to change where the plugin searches. This path can be manually set using the phpstan.path setting.

PHPStan can be installed globally using:

composer global require phpstan/phpstan

or locally using:

composer require --dev phpstan/phpstan

Commands

PHPStan includes an explorer-context command called "PHPStan: Scan for Errors". This command works on both directories and files.

Configuration

vscode-phpstan-extension provides the following configuration properties and defaults:

"phpstan.enabled": true,
"phpstan.path": null,
"phpstan.level": "max",
"phpstan.memoryLimit": "2048M",
"phpstan.projectFile": null,
"phpstan.excludeFiles": [],
"phpstan.options": []

<workspacefolder>/phpstan.neon and <workspacefolder>/phpstan.neon.dist will be used when phpstan.projectFile is set to null. phpstan.options can be used to pass extra parameters to the phpstan commandline call.