Add Pantheon-WP coding standards for comment usage#19
Merged
jazzsequence merged 21 commits intomainfrom Jul 18, 2025
Merged
Conversation
we're redeclaring in Pantheon-WP with a higher severity
We need to redeclare because we're redeclaring the parent rulesets
Introduces the new `DisallowMultilineSlashCommentSniff` to improve comment consistency and readability. This sniff performs two main checks: - It flags consecutive single-line `//` comments, enforcing the use of `/* ... */` block syntax for multiline comments. - It issues a warning for any comment line that exceeds 80 characters to encourage better formatting.
so we can test things manually easier
so the severity level can be adjusted
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
1 participant
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 new sniff enforcing commenting guidelines.
Multiple consecutive
//comments reports aWARNINGinPantheon-WP-Minimumand anERRORinPantheon-WP.Long
/* ... */comments (> 80 columns) reports anERRORinPantheon-WP.Test framework has been updated to support passing the specific ruleset in to test the sniffs against those rules.
Composer scripts have been added to make it easier to test the sniffs and run the tests against specific rulesets.
fixes #1