phpcs.xml

<?xml version="1.0"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="PronovixDrupalQa"
         xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/3.4.1/phpcs.xsd">
  <file>./web/modules</file>
  <file>./web/themes</file>
  <!--  Prevent infinite recursion if PHPCS is running inside the container where the current folder is also symlinked
  to build/modules/drupal_module -->
  <config name="installed_paths" value="../../slevomat/coding-standard,../../drupal/coder/coder_sniffer"/>
  <arg name="extensions" value="inc,install,module,php,profile,test,theme"/>
  <exclude-pattern>*/sites/*</exclude-pattern>
  <exclude-pattern>*/contrib/*</exclude-pattern>
  <exclude-pattern>*/web/core/*</exclude-pattern>
  <exclude-pattern>*/node_modules/*</exclude-pattern>
  <exclude-pattern>*/vendor/*</exclude-pattern>

  <rule ref="Drupal"/>

  <rule ref="DrupalPractice"/>

  <!-- SlevomatCodingStandard.Variables.UnusedVariable.UnusedVariable is better than this rule. -->
  <rule ref="DrupalPractice.CodeAnalysis.VariableAnalysis.UnusedVariable">
    <severity>0</severity>
  </rule>

  <rule ref="Squiz.Strings.DoubleQuoteUsage.NotRequired" />

  <!-- Authored list of SlevomatCodingStandard rules based on https://github.com/slevomat/coding-standard/tree/5.0.0 -->
  <rule ref="SlevomatCodingStandard.TypeHints.DeclareStrictTypes"/>
  <rule ref="SlevomatCodingStandard.TypeHints.DeclareStrictTypes.IncorrectWhitespaceBetweenOpenTagAndDeclare">
    <severity>0</severity>
  </rule>
  <rule ref="SlevomatCodingStandard.TypeHints.TypeHintDeclaration">
    <!-- Defining the type of an array parameter or return type in a hook implementation's doc block should not be required. -->
    <exclude
      name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversableParameterTypeHintSpecification"/>
    <exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversableReturnTypeHintSpecification"/>
  </rule>

  <rule ref="SlevomatCodingStandard.Arrays.DisallowImplicitArrayCreation"/>
  <rule ref="SlevomatCodingStandard.ControlStructures.AssignmentInCondition"/>
  <rule ref="SlevomatCodingStandard.ControlStructures.RequireNullCoalesceOperator"/>

  <rule ref="SlevomatCodingStandard.Functions.StaticClosure"/>
  <rule ref="SlevomatCodingStandard.Operators.RequireOnlyStandaloneIncrementAndDecrementOperators"/>
  <rule ref="SlevomatCodingStandard.Operators.RequireCombinedAssignmentOperator"/>

  <rule ref="SlevomatCodingStandard.Classes.UnusedPrivateElements"/>
  <rule ref="SlevomatCodingStandard.Functions.UnusedInheritedVariablePassedToClosure"/>
  <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses">
    <properties>
      <property name="searchAnnotations" value="1"/>
    </properties>
  </rule>
  <rule ref="SlevomatCodingStandard.Namespaces.UseFromSameNamespace"/>
  <rule ref="SlevomatCodingStandard.Namespaces.UselessAlias"/>
  <rule ref="SlevomatCodingStandard.PHP.UselessParentheses">
    <properties>
      <property name="ignoreComplexTernaryConditions" value="1"/>
    </properties>
  </rule>
  <rule ref="SlevomatCodingStandard.PHP.OptimizedFunctionsWithoutUnpacking"/>
  <rule ref="SlevomatCodingStandard.PHP.UselessSemicolon"/>
  <rule ref="SlevomatCodingStandard.Variables.UnusedVariable">
    <properties>
      <property name="ignoreUnusedValuesWhenOnlyKeysAreUsedInForeach" value="1"/>
    </properties>
  </rule>
  <rule ref="SlevomatCodingStandard.Variables.UselessVariable"/>
  <rule ref="SlevomatCodingStandard.Exceptions.DeadCatch"/>
  <!-- Suppress this sniff locally if it would report a false-positive issue. -->
  <rule ref="SlevomatCodingStandard.Classes.ModernClassNameReference"/>
  <rule ref="SlevomatCodingStandard.Classes.TraitUseDeclaration"/>
  <rule ref="SlevomatCodingStandard.ControlStructures.NewWithParentheses"/>
  <rule ref="SlevomatCodingStandard.ControlStructures.RequireMultiLineTernaryOperator">
    <properties>
      <property name="lineLengthLimit" value="120"/>
    </properties>
  </rule>
  <rule ref="SlevomatCodingStandard.ControlStructures.RequireShortTernaryOperator.RequiredShortTernaryOperator"/>
  <rule ref="SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses">
    <properties>
      <property name="caseSensitive" value="1"/>
    </properties>
  </rule>
  <rule ref="SlevomatCodingStandard.Namespaces.RequireOneNamespaceInFile"/>
  <rule ref="SlevomatCodingStandard.Classes.ClassConstantVisibility"/>
  <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing"/>
  <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHintSpacing"/>
  <rule ref="SlevomatCodingStandard.Namespaces.DisallowGroupUse"/>
  <!-- They make diffs more complicated to read. -->
  <rule ref="SlevomatCodingStandard.Namespaces.MultipleUsesPerLine"/>
  <rule ref="SlevomatCodingStandard.Namespaces.UseDoesNotStartWithBackslash"/>
  <rule ref="SlevomatCodingStandard.Namespaces.FullyQualifiedClassNameInAnnotation"/>
  <rule ref="SlevomatCodingStandard.Commenting.ForbiddenAnnotations">
    <properties>
      <property name="forbiddenAnnotations" type="array" value="@author,@package,@created"/>
    </properties>
  </rule>
  <rule ref="SlevomatCodingStandard.Commenting.ForbiddenComments">
    <properties>
      <!-- This unifies usage of {@inheritdoc} -->
      <property name="forbiddenCommentPatterns" type="array" value="/^\{@inheritDoc\}$/"/>
    </properties>
  </rule>
  <rule ref="SlevomatCodingStandard.Commenting.EmptyComment"/>
  <rule ref="SlevomatCodingStandard.Commenting.InlineDocCommentDeclaration"/>
  <rule ref="SlevomatCodingStandard.ControlStructures.UselessIfConditionWithReturn"/>
  <rule ref="SlevomatCodingStandard.ControlStructures.UselessTernaryOperator"/>
  <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses">
    <properties>
      <!-- This unifies usage of {@inheritdoc} -->
      <property name="ignoredAnnotationNames" type="array" value="@file,@group"/>
    </properties>
  </rule>

</ruleset>