feat: implement DisallowVoidType sniff and related tests#2
Merged
Conversation
- Add `DisallowVoidTypeSniff` to disallow explicit `: void` return types. - Create documentation for the disallowed void type standard. - Add unit tests to verify detection of explicit void return types. - Update existing test files to remove explicit void return types. - Update README with the new sniff documentation.
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.
This pull request introduces a new PHPCS sniff,
DisallowVoidTypeSniff, to theyCodeTechstandard. The sniff enforces the rule that explicitvoidreturn type declarations are not allowed on functions, methods, or closures - absence of a return type already impliesvoid. The PR includes documentation, the implementation of the sniff, comprehensive tests, and updates to the test files and README.Sniff Implementation
DisallowVoidTypeSniffinyCodeTech/Sniffs/Types/DisallowVoidTypeSniff.php, which detects and auto-fixes explicit: voidreturn types in function, method, and closure signatures.Testing and Test Coverage
DisallowVoidTypeUnitTest.inc) and its fixed counterpart to verify detection and auto-fixing of explicitvoidreturn types, ensuring the sniff works as intended.DisallowVoidTypeUnitTest.php) to assert that the sniff flags the correct lines and does not produce warnings.Documentation Updates
voidreturn types should now be flagged and auto-fixed, and to specify what should and should not be fixed.These changes collectively add a new rule to the coding standard, improve documentation, and ensure robust automated testing for the new behaviour.
~ Summary partly generated by Copilot