Skip to content

Add documentation for each sniff #1722

New issue
New issue
Open
Open
Add documentation for each sniff#1722
Labels
Status: Good first issueStatus: Help wantedType: Documentation
@jrfnl

Description

@jrfnl
jrfnl
opened on Jun 15, 2019

All sniffs should be accompanied by documentation in the form of a SniffNameStandard.xml file.
A SniffNameStandard.xml file contains a (short) description of each rule(s) the sniff checks and a code comparison for each check.

Examples can be found in the PHP_CodeSniffer repository:

The sniff documentation for the complete standard can be shown using the following command:

vendor/bin/phpcs --standard=WordPress --generator=Text

The sniff documentation for an individual sniff can be shown using the following command:

vendor/bin/phpcs --standard=WordPress --generator=Text --sniffs=WordPress.Category.SniffName

Aside from the text generator, there are also generators available for HTML and Markdown, which will allow us to use these documentation files to auto-generate documentation about the sniffs to be placed in, for instance, the wiki.

At this time, none of the WPCS native sniffs have this kind of documentation available.

This issue is intended to track progress for adding this documentation.

Adding this documentation is a focus-task for the WCEU contributor day 2019.
During the WCEU Contributor day Gary (@GaryJones ) and Juliette (@jrfnl) will be available to help contributors get set up and answer any questions they may have.

Process

  • When you start working on the documentation for one of these sniffs, please mention it in the WP Slack #core-coding-standards channel and mention your GitHub nickname (during the WCEU contributor day) or leave a comment in this issue (after WCEU Contributor day).
  • Gary or Juliette will update this issue to show you have claimed that sniff.

Creating the documentation

Preparation

For each sniff:

Note: where in the below text it says Category, replace this with the category (folder name) of the sniff. And where it says SniffName, replace it with the name of the sniff.

  • Create a new branch off develop and name it docs/sniffname. 
    git checkout -b "docs/sniffname" "develop"
  • Create the XML file and place it in the correct WordPress/Docs/Category/ directory.
    You may need to create the directory if it doesn't yet exist.
  • To verify what the sniff is checking for, look for addWarning() and/or addError() function calls in the sniff file in the WordPress/Sniffs/Category/ directory to see the error messages the sniff generates.
  • To get inspiration for code examples, open the sniff's WordPress/Tests/Category/SniffNameUnitTest.inc file.
    Correct code will generally be marked with // OK., incorrect code will be marked with // Bad or // Error.
    If the sniff generates several error messages and you are unsure which error applies to which code, you can run the following command to get a better understanding of which code triggers which error/warning: 
    vendor/bin/phpcs -s ./WordPress/Tests/Category/SniffNameUnitTest.inc --standard=WordPress --sniffs=WordPress.Category.SniffName
  • Important: Guidelines for the documentation and the code samples:
    • Keep it as simple as possible.
    • Don't use code which can be traced back to a specific project.
    • Each line within the code sample should be max 48 characters.
    • The title of a "good" code sample should start with Valid: .
      The title of a "bad" code sample should start with Invalid: .
    • To highlight the "good" and the "bad" bits in the code examples, surround those bits with <em> ...</em> tags.
      These will be removed automatically when using the text generator, but ensure highlighting of the code in Markdown/HTML.
    • Also note: The indentation in the XML file should use spaces only. Four spaces for each indent.
      This applies not only to the code samples, but throughout the file.
    • And aside from the issue which the sniff is about, the rest of the code in each code sample should follow the WP Coding Standards.
  • Once you've created the documentation, test it by running: 
    vendor/bin/phpcs --standard=WordPress --generator=Text --sniffs=WordPress.Category.SniffName
  • If all is OK, commit your changes to the branch you created, push the branch upstream to your fork and create a pull request in this repo.
    Please mention this issue in your pull request description Related to #1722 so your pull request will show up in this issue.
  • Gary and/or Juliette will review your PR and either approve and merge it or leave feedback on the pull request.
  • Once a PR has been merged, this issue should be updated and the sniff action item moved to the "Finished" list and marked as complete.

To Do

  • WordPress.DB.PreparedSQLPlaceholders
  • WordPress.Security.EscapeOutput
  • WordPress.Security.NonceVerification
  • WordPress.Security.PluginMenuSlug
  • WordPress.Security.ValidatedSanitizedInput
  • WordPress.Utils.I18nTextDomainFixer
  • WordPress.WP.GlobalVariablesOverride
  • WordPress.WP.I18n

Claimed

Finished

Not needed

Metadata

Metadata

Assignees

No one assigned

    Labels

    Status: Good first issueStatus: Help wantedType: Documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions