Add basic PHPStan linter #638
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kasparsd
commented
Sep 18, 2024
| @@ -5,3 +5,4 @@ | |||
| /dist/ | |||
| /tests/logs/ | |||
| .phpunit.result.cache | |||
| phpstan.neon | |||
There was a problem hiding this comment.
Allow local overrides.
composer.json
Outdated
| "wp-coding-standards/wpcs": "^3.1", | ||
| "yoast/phpunit-polyfills": "^2.0" | ||
| }, | ||
| "scripts": { | ||
| "lint": "phpcs", | ||
| "lint-compat": "phpcs -p --standard=PHPCompatibilityWP --runtime-set testVersion 7.2- --extensions=php --ignore='tests/,dist/,includes/Yubico/,vendor/,node_modules/' .", | ||
| "lint-phpstan": "phpstan analyse --memory-limit=1G", |
There was a problem hiding this comment.
Running without bumping the memory limit can sometimes return passing checks when they actually didn't run.
szepeviktor
approved these changes
Sep 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Introduces phpstan with WordPress core stubs through szepeviktor/phpstan-wordpress.
Why?
Fixes #618.
Static analysis helps us uncover potential bugs and edge cases. Introducing the tooling didn't require a lot adjustments thanks to work already done in #619.
How?
Add the tooling as Composer development dependency and introduce additional lint scripts in
composer.jsonandpackage.json.Testing Instructions
composer installafter checking out this branch.composer lint-phpstanand confirm that[OK] No errorsis returned.Screenshots or screencast
Changelog Entry
Development: Introduce PHPstan tooling for development.