README

Installation

Standards can be installed with Composer dependency manager:

$ composer require gnistdesign/gdcs --dev

Usage

Basic usage

When the package is installed via Composer you can check your files with the coding standards via:

$ vendor/bin/phpcs --standard="GnistDesignWP" <path>

Where <path> is at least one file or directory to check, ex ..

Configuration File

To not have to pass all the arguments to the command line, and also make your own project customizations create a phpcs.xml.dist file that contains something like this:

<?xml version="1.0"?>
<ruleset name="MyCustomStandard">
  <description>A custom set of rules to check for a WordPress project</description>

  <!-- Exclude directories -->
  <exclude-pattern>/vendor/*</exclude-pattern>

  <!-- Text domain. -->
  <rule ref="WordPress.WP.I18n">
    <properties>
      <property name="text_domain" type="array">
        <element value="my-textdomain"/>
        <element value="library-textdomain"/>
      </property>
    </properties>
  </rule>

  <!-- Prefix. -->
  <rule ref="WordPress.NamingConventions.PrefixAllGlobals">
    <properties>
      <property name="prefixes" type="array">
        <element value="my_prefix"/>
      </property>
    </properties>
  </rule>

	 <!-- Include the Gnist Design Coding Standard for WordPress. -->
  <rule ref="GnistDesignWP" />
</ruleset>