https://github.com/swordev/phpstan-vscode

PHPStan extension for VSCode
https://github.com/swordev/phpstan-vscode

php phpstan phpstan-vscode vscode-extension

Last synced: 6 months ago
JSON representation

PHPStan extension for VSCode

• Host: GitHub
• URL: https://github.com/swordev/phpstan-vscode
• Owner: swordev
• License: mit
• Created: 2020-11-02T16:24:06.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-05-27T09:09:11.000Z (over 2 years ago)
• Last Synced: 2025-06-17T09:05:34.914Z (8 months ago)
• Topics: php, phpstan, phpstan-vscode, vscode-extension
• Language: TypeScript
• Homepage:
• Size: 283 KB
• Stars: 14
• Watchers: 0
• Forks: 7
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# phpstan-vscode

[![version]](https://marketplace.visualstudio.com/items?itemName=swordev.phpstan) [![ci]](https://github.com/swordev/phpstan-vscode/actions/workflows/ci.yml) [![downloads]](https://marketplace.visualstudio.com/items?itemName=swordev.phpstan)

[ci]: https://img.shields.io/github/workflow/status/swordev/phpstan-vscode/CI?label=CI

[version]: https://img.shields.io/visual-studio-marketplace/v/swordev.phpstan?logo=

[downloads]: https://img.shields.io/visual-studio-marketplace/d/swordev.phpstan

[PHPStan](https://phpstan.org) 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

- Runs PHPStan analyse on every PHP file change.

- Shows all PHPStan problems of the whole project.

- Parses the PHPStan config file for configuring the extension.

- Commands:

  - `phpstan.showOutput`: show output.

  - `phpstan.analyse`: analyse.

  - `phpstan.analyseCurrentPath`: analyse current path.

    - Also available in the explorer context menu.

  - `phpstan.stopAnalyse`: stop analyse.

  - `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](https://marketplace.visualstudio.com/items?itemName=swordev.phpstan).

2. Provide a [phpstan.neon](https://phpstan.org/config-reference#neon-format) file on the project root dir.

3. Install PHPStan on the project.

```sh

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 `.

3. Make your changes and check them: `pnpm changeset`.

4. Commit your changes: `git commit -m ''`.

5. Push to the original branch: `git push origin `.

6. Create the pull request.

Alternatively see the GitHub documentation on [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).

## License

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