PHPCS: Add XML based sniff documentation #146
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
Check that the XML sniff documentation files are well-formed and will not cause parse errors, i.e. have matching open/close tags.
Includes documentation on the error codes inherited from the upstream `Squiz.Commenting.FileComment` sniff.
Documents the error codes inherited from the upstream `Squiz.WhiteSpace.FunctionSpacing` sniff: * with the property values as set in the Yoast version; * with the limitation to OO structures as set in the Yoast version.
Merged
|
FYI: There is a PR open in PHPCS itself to add a script which can check if sniffs are "feature complete", i.e. that each sniff is accompanied by unit tests as well as documentation. Once that upstream PR has been merged, we can add a check to one of the Travis builds against PHPCS |
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.
PHP_CodeSniffer offers a build-in mechanism to offer documentation for sniffs.
This build-in mechanism works from the command-line and can generate text, markdown or HTML documentation.
This PR adds the XML documents to provide this documentation for all YoastCS native sniffs.
It also adds an additional check in one of the travis builds to make sure that the XML documents added are valid XML.
To test this PR, view the documentation added by it, by:
vendor/bin/phpcs --generator=Text --standard=Yoast --sniffs=Yoast.Commenting.CodeCoverageIgnoreDeprecated,Yoast.Commenting.CoversTag,Yoast.Commenting.Filecomment,Yoast.Commenting.TestsHaveCoversTag,Yoast.ControlStructures.IfElseDeclaration,Yoast.Files.FileName,Yoast.Files.TestDoubles,Yoast.Namespaces.NamespaceDeclaration,Yoast.WhiteSpace.FunctionSpacing,Yoast.Yoast.AlternativeFunctionsThis will show only the docs of the Yoast native sniffs.
If you'd run
vendor/bin/phpcs --generator=Text --standard=Yoast, you not only receive the docs of the Yoast native sniffs, but also the (available) docs for all sniffs included from other standards, such as WPCS and PHPCS upstream.