Example WordPress-Theme phpcs.xml.dist file

[grappler]

An example phpcs.xml.dist could be useful for the theme author that they can place in their theme directory and have the IDE's automatically register it.

<?xml version="1.0"?>
<ruleset name="Theme Name">

 <!--
    The name attribute of the ruleset tag is displayed
    when running PHP_CodeSniffer with the -v command line
    argument. The description tag below is not displayed anywhere
    except in this file, so it can contain information for
    developers who may change this file in the future.
 -->
 <description>A custom coding standard for your theme.</description>

 <!--
    Include all sniffs in the WordPress-Theme standard. Note that the
    path to the standard does not have to be specified as the
    PEAR standard exists inside the PHP_CodeSniffer install
    directory.
 -->
 <rule ref="WordPress-Theme" />

 <!--
    You can hard-code ignore patterns directly into your
    custom standard so you don't have to specify the
    patterns on the command line.

    The following two tags are equivalent to the command line argument:
    --ignore=*/tests/*,*/data/*
 -->
 <exclude-pattern>*/tests/*</exclude-pattern>
 <exclude-pattern>*/node_modules/*</exclude-pattern>

</ruleset>

[dingo-d]

I think by having forked this to a separate repo we can actually do this, so I'll close this one 🙂

[jrfnl]

Reopened: while this file can now be added, it hasn't been added yet.

I think it would be a good idea for such an example ruleset to be added + instructions on how to use it in the readme.

[dingo-d]

Will add this after 0.2.0.