phpcs.xml

<?xml version="1.0"?>
<ruleset name="govcms">
  <description>PHPCS Standard for GovCMS PaaS, based on Drupal standards.
  </description>

  <rule ref="Drupal"/>
  <rule ref="DrupalPractice"/>

  <arg name="extensions" value="inc,info.yml,install,module,php,profile,test,theme"/>
  <arg name="colors"/>
  <arg value="sp"/>

  <file>tests</file>
  <file>web/profiles/custom</file>
  <file>web/modules/custom</file>
  <file>web/themes/custom</file>

  <!-- Exclude theme assets. -->
  <exclude-pattern>web\/themes\/custom\/.*\/build\/.*</exclude-pattern>
  <exclude-pattern>web\/themes\/custom\/.*\/fonts\/.*</exclude-pattern>
  <exclude-pattern>web\/themes\/custom\/.*\/images\/.*</exclude-pattern>

  <!--Force short array syntax.-->
  <rule ref="Generic.Arrays.DisallowLongArraySyntax.Found">
    <type>warning</type>
  </rule>

  <!--Allow global variables in settings file.-->
  <rule ref="DrupalPractice.CodeAnalysis.VariableAnalysis.UndefinedVariable">
    <exclude-pattern>settings\.php</exclude-pattern>
  </rule>

  <!--Allow section separators in settings.php file.-->
  <rule ref="DrupalPractice.Commenting.CommentEmptyLine.SpacingAfter">
    <exclude-pattern>settings\.php</exclude-pattern>
  </rule>
  <rule ref="Drupal.Commenting.InlineComment.InvalidEndChar">
    <exclude-pattern>settings\.php</exclude-pattern>
  </rule>
  <rule ref="Drupal.Commenting.InlineComment.NoSpaceBefore">
    <exclude-pattern>settings\.php</exclude-pattern>
  </rule>
  <rule ref="Drupal.Commenting.InlineComment.SpacingAfter">
    <exclude-pattern>settings\.php</exclude-pattern>
  </rule>

  <!--Allow arrays with and without specified keys in install files.-->
  <rule ref="Squiz.Arrays.ArrayDeclaration.KeySpecified">
    <exclude-pattern>*\.install</exclude-pattern>
  </rule>
  <rule ref="Squiz.Arrays.ArrayDeclaration.NoKeySpecified">
    <exclude-pattern>*\.install</exclude-pattern>
  </rule>

  <!--Allow version in custom modules.-->
  <rule ref="Drupal.InfoFiles.AutoAddedKeys.Version">
    <exclude-pattern>custom/*\.info\.yml</exclude-pattern>
  </rule>

  <!--Allow uncommented functions in tests as they usually provide enough
  information from their names.-->
  <rule ref="Drupal.Commenting.DocComment.MissingShort">
    <exclude-pattern>tests/behat/bootstrap/*\.php</exclude-pattern>
    <exclude-pattern>tests/unit/*.Test\.php</exclude-pattern>
    <exclude-pattern>tests/unit/*.TestCase\.php</exclude-pattern>
  </rule>
  <rule ref="Drupal.Commenting.FunctionComment.Missing">
    <exclude-pattern>tests/unit/*.Test\.php</exclude-pattern>
    <exclude-pattern>tests/unit/*.TestCase\.php</exclude-pattern>
  </rule>
</ruleset>