phpcs.xml

<?xml version="1.0"?>
<ruleset name="LifterLMS Core">
	<description>LifterLMS Rules for PHP_CodeSniffer</description>

	<file>.</file>

    <!-- Exclude project directories -->
    <exclude-pattern>.bin/</exclude-pattern>
    <exclude-pattern>.config/</exclude-pattern>
    <exclude-pattern>.github/</exclude-pattern>
    <exclude-pattern>.wordpress-org/</exclude-pattern>

    <!-- Exclude compile or minified JS files -->
    <exclude-pattern>assets/js/llms.js</exclude-pattern>
    <exclude-pattern>assets/js/llms-admin-addons.js</exclude-pattern>
    <exclude-pattern>assets/js/llms-admin-certificate-editor.js</exclude-pattern>
    <exclude-pattern>assets/js/llms-builder.js</exclude-pattern>
    <exclude-pattern>assets/js/llms-components.js</exclude-pattern>
    <exclude-pattern>assets/js/llms-icons.js</exclude-pattern>
    <exclude-pattern>assets/js/llms-metaboxes.js</exclude-pattern>
    <exclude-pattern>assets/js/llms-spinner.js</exclude-pattern>
    <exclude-pattern>blocks/**/*.js</exclude-pattern>

    <!-- Exclude PHP asset files -->
    <exclude-pattern>*.asset.php</exclude-pattern>

    <!-- Let ESLint handle ESNext JS -->
    <exclude-pattern type="relative">src/**/*</exclude-pattern>
    <exclude-pattern>webpack.config.js</exclude-pattern>

    <!-- Exclude node packages -->
    <exclude-pattern>packages/</exclude-pattern>

    <!-- Exclude external libraries -->
    <exclude-pattern>libraries/</exclude-pattern>

    <!-- Exclude deprecated/legacy files -->
    <exclude-pattern>includes/functions/llms-functions-deprecated.php</exclude-pattern>

    <!-- Exclude locale files that take forever to process -->
    <exclude-pattern>languages/*.php</exclude-pattern>

    <!-- Allow dynamic styles on the certificate template. -->
	<rule ref="WordPress.WP.EnqueuedResources.NonEnqueuedStylesheet">
		<exclude-pattern>templates/certificates/dynamic-styles.php</exclude-pattern>
	</rule>

	<rule ref="LifterLMS">

		<!-- @todo: Apply coding standards to js -->
		<exclude-pattern>assets/js/*.js</exclude-pattern>

		<!-- @todo: Fix docs and comments to adhere to these rules -->

		<exclude name="Squiz.Commenting.FunctionComment.ParamCommentFullStop" />

		<exclude name="Generic.Commenting.DocComment.MissingShort" />
		<exclude name="Generic.Commenting.DocComment.ShortNotCapital" />

		<exclude name="Squiz.Commenting.FunctionComment.Missing" />
		<exclude name="Squiz.Commenting.FunctionComment.MissingParamComment" />
		<exclude name="Squiz.Commenting.FunctionComment.MissingParamTag" />
		<exclude name="Squiz.Commenting.FunctionComment.MissingParamName" />
		<exclude name="Squiz.Commenting.VariableComment.Missing" />

		<exclude name="Squiz.Commenting.FunctionComment.InvalidReturnVoid" />

		<!-- @todo: Update these to use a prefix, see https://github.com/WordPress/WordPress-Coding-Standards/wiki/Customizable-sniff-properties#naming-conventions-prefix-everything-in-the-global-namespace -->
		<exclude name="WordPress.WP.GlobalVariablesOverride.Prohibited" />

		<!-- @todo: extract is messy you're right, fix this -->
		<exclude name="WordPress.PHP.DontExtract.extract_extract" />

		<!-- @todo: Most core files break this rule. -->
		<exclude name="WordPress.Files.FileName.InvalidClassFileName" />

		<!-- @todo: This needs to be adjusted since WP 5.3 -->
		<exclude name="WordPress.DateTime.RestrictedFunctions.date_date" />

		<!-- These templates follow WP Template style so they're okay -->
		<exclude name="WordPress.Files.FileName.NotHyphenatedLowercase">
			<exclude-pattern>templates/taxonomy-*.php</exclude-pattern>
		</exclude>
		
		<!-- This rule is for PHP versions less than 7.3, but we require an higher PHP version. -->
		<exclude name="PHPCompatibility.Classes.NewTypedProperties.Found" />
		
	</rule>

	<!--
		@todo The following 3 rule sets are disabled for the following files/directories
			  We are in the process of gradually fixing these in bulk.
			  See https://github.com/gocodebox/lifterlms/issues/946
	-->
	<rule ref="LifterLMS.Commenting.FileComment">
		<exclude-pattern>includes/admin/views/*.php</exclude-pattern>
		<exclude-pattern>includes/admin/views/**/*.php</exclude-pattern>

		<exclude-pattern>templates/*.php</exclude-pattern>
		<exclude-pattern>templates/**/*.php</exclude-pattern>
	</rule>
	<rule ref="Squiz.Commenting.FileComment">
		<exclude-pattern>includes/admin/views/*.php</exclude-pattern>
		<exclude-pattern>includes/admin/views/**/*.php</exclude-pattern>

		<exclude-pattern>templates/*.php</exclude-pattern>
		<exclude-pattern>templates/**/*.php</exclude-pattern>
	</rule>
	<rule ref="Squiz.Commenting.ClassComment.Missing">
		<exclude-pattern>includes/admin/views/*.php</exclude-pattern>
		<exclude-pattern>includes/admin/views/**/*.php</exclude-pattern>

		<exclude-pattern>templates/*.php</exclude-pattern>
		<exclude-pattern>templates/**/*.php</exclude-pattern>
	</rule>

	<rule ref="Squiz.Commenting.InlineComment.InvalidEndChar">
		<!-- To be fixed -->
		<exclude-pattern>includes/notifications/class.llms.notifications.query.php</exclude-pattern>
		<exclude-pattern>includes/privacy/class-llms-privacy-exporters.php</exclude-pattern>
		<exclude-pattern>includes/privacy/class-llms-privacy.php</exclude-pattern>
		<exclude-pattern>includes/processors/class.llms.processor.membership.bulk.enroll.php</exclude-pattern>
		<exclude-pattern>includes/processors/class.llms.processor.table.to.csv.php</exclude-pattern>
		<exclude-pattern>includes/shortcodes/class.llms.shortcode.course.outline.php</exclude-pattern>
		<exclude-pattern>includes/shortcodes/class.llms.shortcode.hide.content.php</exclude-pattern>
	</rule>

	<rule ref="WordPress.WP.I18n">
		<!-- @todo: Fix all of these -->
		<exclude name="WordPress.WP.I18n.MissingTranslatorsComment" />

		<properties>
			<property name="text_domain" value="lifterlms" />
		</properties>
	</rule>

	<!-- @todo: Fix these issues. -->
	<rule ref="Squiz.PHP.DisallowSizeFunctionsInLoops.Found">
	    <exclude-pattern>assets/js/*.js</exclude-pattern>
	</rule>

</ruleset>