.phpcs.xml

<?xml version="1.0"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="create-wordpress-plugin" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd">
  <description>PHP_CodeSniffer standard for create-wordpress-plugin.</description>

  <!-- Include Alley Rules -->
  <rule ref="Alley-Interactive" />

  <!--
  Pass some flags to PHPCS:
    p flag: Show progress of the run.
    s flag: Show sniff codes in all reports.
    n flag: Do not print warnings.
  -->
  <arg value="ps" />

  <!-- Whenever possible, cache the scan results and re-use those for unchanged files on the next scan. -->
  <arg name="cache" value=".phpcs/cache.json" />

  <!-- Strip the filepaths down to the relevant bit. -->
  <arg name="basepath" value="./" />

  <!-- Check up to 20 files simultaneously. -->
  <arg name="parallel" value="20" />

  <!-- Set severity to 1 to see everything that isn't effectively turned off. -->
  <arg name="severity" value="1" />

  <!-- Exclude a few directories and autogenerated files. -->
  <exclude-pattern>build/</exclude-pattern>
  <exclude-pattern>vendor/</exclude-pattern>
  <exclude-pattern>tests/</exclude-pattern>

  <!-- The version set here matches the minimum version tested in buddy.yml. -->
  <config name="minimum_supported_wp_version" value="5.9" />

  <!-- Define the prefixes that can be used by the plugin -->
  <rule ref="WordPress.NamingConventions.PrefixAllGlobals">
    <properties>
      <property name="prefixes" type="array">
        <element value="vendor_name" />
        <element value="WP_Newsletter_Builder" />
        <element value="newsletter_builder" />
      </property>
    </properties>
  </rule>

  <!-- Disable commenting rules for example code included in the plugin. -->
  <rule ref="Squiz.PHP.CommentedOutCode.Found">
    <exclude-pattern>src/assets.php</exclude-pattern>
    <exclude-pattern>blocks</exclude-pattern>
    <exclude-pattern>build</exclude-pattern>
    <exclude-pattern>entries</exclude-pattern>
  </rule>

  <rule ref="Squiz.Commenting.InlineComment">
    <exclude-pattern>src/assets.php</exclude-pattern>
  </rule>
</ruleset>