jasonwilliams/phpstan-vscode

PHPStan extension for VSCode

phpstan-vscode

PHPStan extension for VSCode.

Analyzes your PHP project manually or on every file change with PHPStan and shows the result in the VSCode problems tab.

Features

• Activates the extension if it detects phpstan.neon/phpstan.neon.dist file on the project root dir.
• Runs PHPStan analyse on every PHP file change.
• Shows all PHPStan problems of the whole project.
• Parses PHPStan config for file watching.
• Commands:
  • phpstan.showOutput: show output.
  • phpstan.analyse: analyse.
  • phpstan.analyseCurrentPath: analyse current path.
    • Also available in the explorer context menu.
  • phpstan.pauseFileWatcher: pause file watcher.
  • phpstan.resumeFileWatcher: resume file watcher.
  • phpstan.toggleFileWatcher: toggle file watcher.
  • phpstan.clearProblems: clear problems.
  • phpstan.clearCache: clear cache.

Usage

1. Install PHPStan extension.
2. Provide a phpstan.neon file on the project root dir.
3. Install PHPStan on the project.

composer require phpstan/phpstan --dev

Contributing

To contribute to the project, follow these steps:

1. Fork this repository.
2. Create a branch: git checkout -b <branch_name>.
3. Make your changes and check them: npm run prepare.
4. Commit your changes: git commit -m '<commit_message>'.
5. Push to the original branch: git push origin <branch_name>.
6. Create the pull request.

Alternatively see the GitHub documentation on creating a pull request.

License

Distributed under the MIT License. See LICENSE for more information.