feat(checker): add runtime fatal-error prevention check#1320
Open
faisalahammad wants to merge 1 commit into
Open
feat(checker): add runtime fatal-error prevention check#1320faisalahammad wants to merge 1 commit into
faisalahammad wants to merge 1 commit into
Conversation
- Implement RuntimeFatalErrorPreventionSniff to parse and analyze common runtime fatal patterns. - Register check in Default_Check_Repository and ruleset. - Add comprehensive PHPUnit and sniff unit tests. Fixes WordPress#1273
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
This file contains hidden or 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
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.
Summary
Adds a new static check
Runtime_Fatal_Error_Prevention_Checkand corresponding PHPCS sniffRuntimeFatalErrorPreventionSniffto analyze plugins for high-risk coding patterns that commonly trigger runtime fatal errors. These include unguarded imports, direct/unguarded class instantiations or function calls of optional components, dynamic callback definitions that might be missing, and incorrect class method hook attachments.Fixes #1273
Changes
phpcs-rulesets/plugin-check.ruleset.xml
Before:
After:
Why: Registers the new custom PHPCS sniff under the core plugin-check ruleset to run as part of the PHPCS static checks.
includes/Checker/Default_Check_Repository.php
Before:
After:
Why: Registers the new
Runtime_Fatal_Error_Prevention_Checkstatic check class into the default check repository so it gets run automatically during plugin checks.Testing
Test 1: Run Sniff Unit Tests
./vendor/bin/phpunit phpcs-sniffs/PluginCheck/Tests/CodeAnalysis/RuntimeFatalErrorPreventionUnitTest.phpResult: Works as expected (All tests pass)
Test 2: Run Plugin Check PHPUnit Integration Tests
npm run wp-env:start:testsnpm run test-php -- --filter=Runtime_Fatal_Error_Prevention_Check_TestsResult: Works as expected (All tests pass)