README

This package defines customized Code Sniffer rules for Drupal projects. It is primarily based on drupal/coder, with some sniffs excluded and others downgraded to warnings. Some additional sniffs not provided in drupal/coder have also been added.

Installing the ruleset

Use Composer to install the ruleset and its dependencies as a package:

composer require --dev interactivestrategies/drupal-cs

Making the IS rules the default for your project

Add a phpcs.xml.dist file in your project with content like this:

<?xml version="1.0" encoding="UTF-8"?> <ruleset name="an_is_project"> <file>./dist/modules/custom</file> <file>./dist/profiles/custom</file> <file>./dist/themes/custom</file> <rule ref="ISDrupal"/> </ruleset> 

The tag(s) define what paths the rules should be applied to/within.