phpcs-ruleset.xml

<?xml version="1.0"?>
<!-- PHP_CodeSniffer standard for NextEuropa subsites. -->
<!-- See http://pear.php.net/manual/en/package.php.php-codesniffer.annotated-ruleset.php -->
<ruleset name="NextEuropa">
    <description>Drupal coding standard for NextEuropa subsites</description>

    <rule ref="./vendor/drupal/coder/coder_sniffer/Drupal" />
    <rule ref="./vendor/drupal/coder/coder_sniffer/DrupalPractice" />
    <rule ref="./vendor/ec-europa/qa-automation/DrupalSecure" />
    <rule ref="./vendor/ec-europa/qa-automation/QualityAssurance" />

    <!-- Minified files don't have to comply with coding standards. -->
    <exclude-pattern>*\.min\.css</exclude-pattern>
    <exclude-pattern>*\.min\.js</exclude-pattern>

    <exclude-pattern>*/themes/*/css/style.css</exclude-pattern>

    <!-- Exclude node_modules. -->
    <exclude-pattern>node_modules*</exclude-pattern>

    <!-- Exclude starterkit. -->
    <exclude-pattern>dt_STARTERKIT</exclude-pattern>

    <!-- Exclude generated and third party code -->
    <exclude-pattern>bootstrap-sass</exclude-pattern>
    <exclude-pattern>styleguide</exclude-pattern>
    <exclude-pattern>js/libraries</exclude-pattern>
    <exclude-pattern>*/style-sass*.css</exclude-pattern>

    <!-- Exclude settings.php -->
    <exclude-pattern>*/settings.php</exclude-pattern>

    <!-- Exclude files that do not contain PHP, Javascript or CSS code. -->
    <exclude-pattern>*\.json</exclude-pattern>
    <exclude-pattern>*\.sh</exclude-pattern>
    <exclude-pattern>*\.xml</exclude-pattern>
    <exclude-pattern>*\.yml</exclude-pattern>
    <exclude-pattern>composer.lock</exclude-pattern>

    <!-- Exclude third party code. -->
    <exclude-pattern>resources/cloudformation</exclude-pattern>
    <exclude-pattern>resources/codedeploy</exclude-pattern>
    <exclude-pattern>resources/vendor</exclude-pattern>

    <!-- Exclude EntityReference handlers -->
    <exclude-pattern>*/behavior/*.class.php</exclude-pattern>

    <!-- Exclude non drupal folders. -->
    <exclude-pattern>/vendor</exclude-pattern>
    <exclude-pattern>/src</exclude-pattern>
    <exclude-pattern>/resources</exclude-pattern>

    <!-- Exclude folders of example modules. -->
    <exclude-pattern>**/example_module</exclude-pattern>
    <exclude-pattern>**/myproject_core</exclude-pattern>
    <exclude-pattern>**/example_theme</exclude-pattern>

    <!-- Views handlers not strictly follow Drupal class name conventions. -->
    <rule ref="Drupal.NamingConventions.ValidClassName">
        <exclude-pattern>modules/**/views/*.inc</exclude-pattern>
        <exclude-pattern>modules/**/views*.inc</exclude-pattern>
        <exclude-pattern>cwt_team_handler_field_node_source_language_path.inc</exclude-pattern>
        <exclude-pattern>context_condition_node_taxonomy_uuid.inc</exclude-pattern>
    </rule>

    <!-- Views handlers not strictly follow Drupal function name conventions. -->
    <rule ref="Drupal.NamingConventions.ValidFunctionName">
        <exclude-pattern>modules/**/views/*.inc</exclude-pattern>
        <exclude-pattern>modules/**/views*.inc</exclude-pattern>
        <exclude-pattern>context_condition_node_taxonomy_uuid.inc</exclude-pattern>
    </rule>

    <!-- Phing tasks require to use CamelCaps for argument names. -->
    <rule ref="Drupal.NamingConventions.ValidVariableName">
        <exclude-pattern>src/Phing</exclude-pattern>
    </rule>

    <!-- Features creates violations for fields. -->
    <rule ref="Drupal.Commenting.InlineComment.InvalidEndChar">
        <exclude-pattern>*.features.field.inc</exclude-pattern>
        <exclude-pattern>*.features.field_*.inc</exclude-pattern>
        <exclude-pattern>*.features.wysiwyg.inc</exclude-pattern>
    </rule>

    <!-- Features creates violations for fields. -->
    <rule ref="Drupal.Files.LineLength">
        <exclude-pattern>*.features.field.inc</exclude-pattern>
        <exclude-pattern>*.features.field_*.inc</exclude-pattern>
        <exclude-pattern>*.features.menu_links.inc</exclude-pattern>
        <exclude-pattern>modules/**/views/*.inc</exclude-pattern>
    </rule>

    <!-- FieldGroup titles are not translatable. -->
    <rule ref="Drupal.Semantics.FunctionT.NotLiteralString">
        <exclude-pattern>*/nexteuropa_inpage_nav.module</exclude-pattern>
    </rule>

    <!-- Exported translations. -->
    <rule ref="Drupal.Semantics.FunctionT.BackslashSingleQuote">
        <exclude-pattern>*.features.*.inc</exclude-pattern>
    </rule>

    <!-- Exclude tr. -->
    <rule ref="Drupal.Semantics.FunctionT.ConcatString">
        <exclude-pattern>*.*</exclude-pattern>
    </rule>

    <!-- Wysiwyg profiles exported in Features do not have a trailing period. -->
    <!-- Remove this once https://www.drupal.org/node/2724173 is in. -->
    <rule ref="Drupal.Commenting.InlineComment.InvalidEndChar">
        <exclude-pattern>*.features.wysiwyg.inc</exclude-pattern>
    </rule>

    <!-- Disallow short array -->
    <rule ref="Generic.Arrays.DisallowLongArraySyntax">
        <severity>0</severity>
        <!-- Exclude features generated files from this rule -->
        <exclude-pattern>*.ds.*.inc</exclude-pattern>
        <exclude-pattern>*.default_*.inc</exclude-pattern>
        <exclude-pattern>*.file_default_displays.*.inc</exclude-pattern>
        <exclude-pattern>*.views_default.*.inc</exclude-pattern>
        <exclude-pattern>*.facetapi_defaults.*.inc</exclude-pattern>
        <exclude-pattern>*.custom_formatters.*.inc</exclude-pattern>
        <exclude-pattern>*.context.*.inc</exclude-pattern>
        <exclude-pattern>*.strongarm.*.inc</exclude-pattern>
        <exclude-pattern>*.variable.*.inc</exclude-pattern>
        <exclude-pattern>*.features.*.inc</exclude-pattern>
        <exclude-pattern>*.field_group.inc</exclude-pattern>
        <exclude-pattern>src/Phing</exclude-pattern>
    </rule>
</ruleset>