phpcs.xml.dist

<?xml version="1.0"?>
<ruleset name="helloLOG Coding Standards">
    <description>PHP CodeSniffer ruleset for the helloLOG plugin.</description>

    <file>.</file>

    <exclude-pattern>/vendor/*</exclude-pattern>
    <exclude-pattern>/node_modules/*</exclude-pattern>
    <exclude-pattern>/tests/*</exclude-pattern>
    <!-- The Vue admin source lives under vue-admin/; it is .gitignored
         in the distributable repo but a local dev checkout has it. -->
    <exclude-pattern>/vue-admin/*</exclude-pattern>
    <!-- Built Vue bundle is minified, no point in scanning it. -->
    <exclude-pattern>/assets/admin/*</exclude-pattern>

    <arg value="ps"/>
    <arg name="colors"/>

    <rule ref="WordPress">
        <exclude name="Universal.Arrays.DisallowShortArraySyntax"/>
        <exclude name="Universal.NamingConventions.NoReservedKeywordParameterNames"/>
        <exclude name="Squiz.PHP.CommentedOutCode"/>
        <!-- PSR-4 autoloading: PascalCase filenames, not class- prefix. -->
        <exclude name="WordPress.Files.FileName.NotHyphenatedLowercase"/>
        <exclude name="WordPress.Files.FileName.InvalidClassFileName"/>
        <!-- Typed PHP 8.0+ signatures make most function-level PHPDoc
             redundant noise. We document a method only when its name
             + parameter types don't already tell the full story. -->
        <exclude name="Squiz.Commenting.FunctionComment"/>
        <exclude name="Squiz.Commenting.VariableComment"/>
        <exclude name="Squiz.Commenting.ClassComment"/>
        <exclude name="Squiz.Commenting.FileComment"/>
        <exclude name="Generic.Commenting.DocComment.MissingShort"/>
        <!-- Don't police inline-comment punctuation; the body is the
             content, the trailing dot vs. en-dash is editorial. -->
        <exclude name="Squiz.Commenting.InlineComment.InvalidEndChar"/>
    </rule>

    <rule ref="PHPCompatibilityWP"/>
    <config name="testVersion" value="8.0-"/>

    <config name="minimum_wp_version" value="6.4"/>

    <rule ref="WordPress.WP.I18n">
        <properties>
            <property name="text_domain" type="array">
                <element value="hellolog"/>
            </property>
        </properties>
    </rule>

    <rule ref="WordPress.NamingConventions.PrefixAllGlobals">
        <properties>
            <property name="prefixes" type="array">
                <element value="goal"/>
                <element value="GOAL"/>
                <element value="HelloLog"/>
            </property>
        </properties>
    </rule>
</ruleset>