aspireupdate/phpcs.xml.dist
Namith Jawahar 1c78bea1f7
Bump Version CLI Script (#412)
* Bump Version CLI Script

Bump Version CLI Script

* Support for POT Files

1) Added Support for POT Files
2) Added support for BugReport.yml
3) Added support for blueprint.json

* Exclude Bin Folder for PHPCS

Exclude Bin Folder for PHPCS (This was commented out for dev purpose.

---------

Signed-off-by: Namith Jawahar <48271037+namithj@users.noreply.github.com>
2025-06-25 23:36:02 +05:30

111 lines
4 KiB
XML

<?xml version="1.0"?>
<ruleset name="WordPress Coding Standards">
<description>Apply WordPress Coding Standards to all AspireUpdate files</description>
<!--
#############################################################################
COMMAND LINE ARGUMENTS
https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-Ruleset
#############################################################################
-->
<!-- Only scan PHP files. -->
<arg name="extensions" value="php"/>
<!-- Whenever possible, cache the scan results and re-use those for unchanged files on the next scan. -->
<arg name="cache" value=".cache/phpcs.json"/>
<!-- Set the memory limit to 512M.
For most standard PHP configurations, this means the memory limit will temporarily be raised.
Ref: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#specifying-phpini-settings
-->
<ini name="memory_limit" value="512M"/>
<!-- Strip the filepaths down to the relevant bit. -->
<arg name="basepath" value="./"/>
<!-- Check up to 20 files simultaneously. -->
<arg name="parallel" value="20"/>
<!-- Show sniff codes in all reports. -->
<arg value="ps"/>
<!--
#############################################################################
FILE SELECTION
Set which files will be subject to the scans executed using this ruleset.
#############################################################################
-->
<file>.</file>
<!-- Directories and third party library exclusions. -->
<exclude-pattern>/vendor/*</exclude-pattern>
<!-- Translation files. -->
<exclude-pattern>/languages/*</exclude-pattern>
<!-- Exclude executable and script files from all sniffs. -->
<exclude-pattern>/bin/*</exclude-pattern>
<!--
#############################################################################
SET UP THE RULESET
#############################################################################
-->
<!-- Allow short syntax arrays. -->
<rule ref="WordPress-Extra">
<exclude name="Universal.Arrays.DisallowShortArraySyntax"/>
</rule>
<!-- Enforce short syntax arrays. -->
<rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
<!-- Exclude custom Filesystem API implementations from certain sniffs. -->
<rule ref="WordPress.WP.AlternativeFunctions.file_system_operations_fopen">
<exclude-pattern>includes/class-filesystem-direct\.php</exclude-pattern>
</rule>
<rule ref="WordPress.WP.AlternativeFunctions.file_system_operations_fclose">
<exclude-pattern>includes/class-filesystem-direct\.php</exclude-pattern>
</rule>
<rule ref="WordPress.WP.AlternativeFunctions.file_system_operations_fwrite">
<exclude-pattern>includes/class-filesystem-direct\.php</exclude-pattern>
</rule>
<rule ref="WordPress.PHP.NoSilencedErrors.Discouraged">
<exclude-pattern>includes/class-filesystem-direct\.php</exclude-pattern>
</rule>
<!-- Exclude test classes from naming conventions. -->
<rule ref="WordPress.Files.FileName.InvalidClassFileName">
<exclude-pattern>/tests/phpunit/*</exclude-pattern>
</rule>
<rule ref="WordPress.Files.FileName.NotHyphenatedLowercase">
<exclude-pattern>/tests/phpunit/*</exclude-pattern>
</rule>
<!-- Exclude test files from overriding globals sniff. -->
<rule ref="WordPress.WP.GlobalVariablesOverride.Prohibited">
<exclude-pattern>/tests/phpunit/tests/*</exclude-pattern>
</rule>
<!-- Exclude test files from some filesystem sniffs. -->
<rule ref="WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents">
<exclude-pattern>/tests/phpunit/*</exclude-pattern>
</rule>
<rule ref="WordPress.WP.AlternativeFunctions.file_system_operations_file_put_contents">
<exclude-pattern>/tests/phpunit/*</exclude-pattern>
</rule>
<rule ref="WordPress.WP.AlternativeFunctions.unlink_unlink">
<exclude-pattern>/tests/phpunit/*</exclude-pattern>
</rule>
<rule ref="WordPress.WP.AlternativeFunctions.file_system_operations_mkdir">
<exclude-pattern>/tests/phpunit/*</exclude-pattern>
</rule>
<rule ref="WordPress.WP.AlternativeFunctions.file_system_operations_rmdir">
<exclude-pattern>/tests/phpunit/*</exclude-pattern>
</rule>
</ruleset>