phpcs.xml

<?xml version="1.0"?>
<ruleset name="Medusa WP Plugin Coding Standards">
  <!-- See https://github.com/squizlabs/PHP_CodeSniffer/wiki/ -->
  <!-- See https://github.com/WordPress/WordPress-Coding-Standards -->
  <!-- See https://github.com/WordPress/WordPress-Coding-Standards/wiki -->
  <!-- See https://github.com/PHPCompatibility/PHPCompatibility -->

  <description>Medusa WP custom set of code standard rules for plugins.</description>

  <!--
	#############################################################################
	COMMAND LINE ARGUMENTS
	https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-Ruleset
	#############################################################################
	-->

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

  <!-- Only check the PHP files. -->
  <arg name="extensions" value="php"/>

  <arg name="tab-width" value="4"/>

  <!-- Check all files in this directory and the directories below it. -->
  <file>.</file>

  <!-- Exclude folders and files from being checked. -->
  <exclude-pattern>*.css</exclude-pattern>
  <exclude-pattern>*.js</exclude-pattern>

  <!-- Exclude external dependencies - libraries from being checked. -->
  <exclude-pattern>/libraries/*</exclude-pattern>

  <!-- Exclude the Composer Vendor directory. -->
  <exclude-pattern>*/vendor/*</exclude-pattern>
  <exclude-pattern>*/oas-clients/*</exclude-pattern>

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

  <!--
	#############################################################################
	SET UP THE RULESETS
	#############################################################################
	-->

  <rule ref="WordPress">
    <!-- WordPress.Security rules -->
    <exclude name="WordPress.Security.ValidatedSanitizedInput.InputNotSanitized" />
    <exclude name="WordPress.Security.ValidatedSanitizedInput.MissingUnslash" />
    <exclude name="WordPress.Security.NonceVerification.Recommended" />

    <!-- Other rules -->
    <exclude name="Generic.Commenting.DocComment.MissingShort" />
    <exclude name="Squiz.Commenting.ClassComment.Missing" />
    <exclude name="Squiz.Commenting.FileComment.Missing" />
    <exclude name="Squiz.Commenting.FileComment.MissingPackageTag" />
    <exclude name="Squiz.Commenting.FileComment.SpacingAfterComment" />
    <exclude name="Squiz.Commenting.FileComment.SpacingAfterOpen" />
    <exclude name="Squiz.Commenting.FileComment.WrongStyle" />
    <exclude name="Squiz.Commenting.FunctionComment.IncorrectTypeHint" />
    <exclude name="Squiz.Commenting.FunctionComment.Missing" />
    <exclude name="Squiz.Commenting.FunctionComment.MissingParamComment" />
    <exclude name="Squiz.Commenting.FunctionComment.MissingParamTag" />
    <exclude name="Squiz.Commenting.FunctionComment.ParamCommentFullStop" />
    <exclude name="Squiz.Commenting.FunctionComment.ParamNameNoMatch" />
    <exclude name="Squiz.Commenting.FunctionComment.SpacingAfterParamType" />
    <exclude name="Squiz.Commenting.FunctionComment.WrongStyle" />
    <exclude name="Squiz.Commenting.InlineComment.InvalidEndChar" />
    <exclude name="Squiz.Commenting.VariableComment.Missing" />
    <exclude name="WordPress.Files.FileName.NotHyphenatedLowercase" />
    <exclude name="WordPress.PHP.YodaConditions.NotYoda" />
  </rule>

  <!--
	#############################################################################
	USE THE PHPCompatibility RULESET
	#############################################################################
	-->

  <!-- Check for PHP cross-version compatibility. -->
  <config name="testVersion" value="7.4-"/>
  <rule ref="PHPCompatibilityWP"/>


  <!--
	#############################################################################
	SNIFF SPECIFIC CONFIGURATION
	#############################################################################
	-->

  <!-- Set the minimum supported WP version. This is used by several sniffs.
		 The minimum version set here should be in line with the minimum WP version
		 as set in the "Requires at least" tag in the readme.txt file. -->
  <config name="minimum_supported_wp_version" value="5.6"/>

  <!-- Verify that the text_domain is set to the desired text-domain.
		 Multiple valid text domains can be provided as a comma-delimited list. -->
  <rule ref="WordPress.WP.I18n">
    <properties>
      <property name="text_domain" type="array" value="medusawp"/>
    </properties>
  </rule>

  <!-- Allow for theme specific exceptions to the file name rules based
		 on the theme hierarchy. -->
  <rule ref="WordPress.Files.FileName">
    <properties>
      <property name="strict_class_file_names" value="false"/>
    </properties>
  </rule>
</ruleset>