feat: add ignore_single_line_comments option to phpdoc_type_annotations_only rule#428
Draft
MrPunyapal wants to merge 3 commits intolaravel:mainfrom
Draft
feat: add ignore_single_line_comments option to phpdoc_type_annotations_only rule#428MrPunyapal wants to merge 3 commits intolaravel:mainfrom
ignore_single_line_comments option to phpdoc_type_annotations_only rule#428MrPunyapal wants to merge 3 commits intolaravel:mainfrom
Conversation
|
Thanks for submitting a PR! Note that draft PRs are not reviewed. If you would like a review, please mark your pull request as ready for review in the GitHub user interface. Pull requests that are abandoned in draft may be closed due to inactivity. |
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 PR adds a configurable
ignore_single_line_commentsoption to thePint/phpdoc_type_annotations_onlyfixer.When enabled, single-line comments (
//and#) are preserved instead of being removed, while block comments (/* */) and docblocks without annotations are still processed as before.This is useful for teams that want to keep inline documentation and section dividers in their code but still strip prose from docblocks.
Usage
{ "rules": { "Pint/phpdoc_type_annotations_only": { "ignore_single_line_comments": true } } }Before (with
ignore_single_line_comments: true)After
Changes
app/Fixers/TypeAnnotationsOnlyFixer.php— ImplementsConfigurableFixerInterfacewithConfigurableFixerTrait, addsignore_single_line_commentsboolean option (default:false)tests/Feature/Fixers/PhpdocTypeAnnotationsOnlyFixerTest.php— Adds 12 new test cases covering the option in bothtrueandfalsemodesNotes
ignore_single_line_commentsdefaults tofalse//inside empty{}) are still handled correctly regardless of the setting@annotations are always preserved regardless of the setting