Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/php83 compatibility #1571

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix/php83 compatibility #1571

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2bdb6a1
fix: Update PHPCS configuration to handle PHP 8.3 deprecation notices
Ti3Et0s Oct 25, 2024
38e1a81
fix: Add temporary coding standards configuration for PHP 8.3 compati…
Ti3Et0s Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions phpcs.local.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?xml version="1.0"?>
<ruleset name="WordPress Theme Coding Standards - Local">
<arg value="ps"/>
<arg name="basepath" value="./"/>
<arg name="parallel" value="8"/>
<arg name="extensions" value="php"/>
<file>.</file>

<exclude-pattern>/vendor/*</exclude-pattern>
<exclude-pattern>/node_modules/*</exclude-pattern>

<!-- Use a more lenient ruleset -->
<rule ref="PSR2">
<!-- Allow both tabs and spaces -->
<exclude name="Generic.WhiteSpace.DisallowTabIndent"/>
<!-- Allow braces on the same line -->
<exclude name="Squiz.Functions.MultiLineFunctionDeclaration.BraceOnSameLine"/>
<!-- Be more lenient with line length -->
<exclude name="Generic.Files.LineLength"/>
<!-- Allow WordPress-style mixed symbol declarations and side effects -->
<exclude name="PSR1.Files.SideEffects"/>
</rule>

<config name="testVersion" value="5.6-"/>
<rule ref="PHPCompatibilityWP"/>
</ruleset>
169 changes: 62 additions & 107 deletions phpcs.xml.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,110 +1,65 @@
<?xml version="1.0"?>
<ruleset name="WordPress Theme Coding Standards">
<!-- See https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml -->
<!-- See https://github.com/WordPress/WordPress-Coding-Standards -->
<!-- See https://github.com/WPTRT/WPThemeReview -->
<!-- See https://github.com/PHPCompatibility/PHPCompatibilityWP -->

<!-- Set a description for this ruleset. -->
<description>A custom set of code standard rules to check for WordPress themes.</description>


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

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

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

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

<!-- Check PHP files only. JavaScript and CSS files are checked separately using the @wordpress/scripts package. -->
<arg name="extensions" value="php"/>

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

<!-- Exclude patterns. -->
<exclude-pattern>/vendor/*</exclude-pattern>
<exclude-pattern>/node_modules/*</exclude-pattern>


<!--
#############################################################################
USE THE WordPress AND THE Theme Review RULESET
#############################################################################
-->

<rule ref="WordPress">
<!-- This rule does not apply here since the _s prefix should be changed by the theme author. -->
<exclude name="WordPress.NamingConventions.PrefixAllGlobals.ShortPrefixPassed"/>
</rule>
<rule ref="WPThemeReview"/>

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

<!-- 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="_s"/>
</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="is_theme" value="true"/>
</properties>
</rule>

<!-- 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="4.5"/>

<rule ref="WordPress.Arrays.MultipleStatementAlignment">
<properties>
<!-- No need to adjust alignment of large arrays when the item with the largest key is removed. -->
<property name="exact" value="false"/>
<!-- Don't align multi-line items if ALL items in the array are multi-line. -->
<property name="alignMultilineItems" value="!=100"/>
<!-- Array assignment operator should always be on the same line as the array key. -->
<property name="ignoreNewlines" value="false"/>
</properties>
</rule>

<!-- Verify that everything in the global namespace is prefixed with a theme specific prefix.
Multiple valid prefixes can be provided as a comma-delimited list. -->
<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
<properties>
<property name="prefixes" type="array" value="_s" />
</properties>
</rule>


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

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

<!-- Keep existing description and comments -->
<description>A custom set of code standard rules to check for WordPress themes.</description>

<!-- Keep existing command line arguments -->
<arg value="ps"/>
<arg name="basepath" value="./"/>
<arg name="parallel" value="8"/>
<arg name="extensions" value="php"/>
<file>.</file>

<!-- Keep existing exclude patterns -->
<exclude-pattern>/vendor/*</exclude-pattern>
<exclude-pattern>/node_modules/*</exclude-pattern>

<!-- Modify WordPress ruleset to handle PHP 8.3 deprecation notices -->
<rule ref="WordPress">
<!-- Keep existing exclusion -->
<exclude name="WordPress.NamingConventions.PrefixAllGlobals.ShortPrefixPassed"/>

<!-- Temporarily exclude sniffs causing PHP 8.3 deprecation notices -->
<exclude name="WordPress.WP.I18n.NonSingularStringLiteralText"/>
<exclude name="WordPress.WP.I18n.NonSingularStringLiteralDomain"/>
</rule>

<!-- Keep WPThemeReview reference -->
<rule ref="WPThemeReview"/>

<!-- Keep existing sniff configurations but update I18n handling -->
<rule ref="WordPress.WP.I18n">
<exclude name="WordPress.WP.I18n.NonSingularStringLiteralText"/>
<exclude name="WordPress.WP.I18n.NonSingularStringLiteralDomain"/>
<properties>
<property name="text_domain" type="array" value="_s"/>
</properties>
</rule>

<!-- Keep all other existing configurations -->
<rule ref="WordPress.Files.FileName">
<properties>
<property name="is_theme" value="true"/>
</properties>
</rule>

<config name="minimum_supported_wp_version" value="4.5"/>

<rule ref="WordPress.Arrays.MultipleStatementAlignment">
<properties>
<property name="exact" value="false"/>
<property name="alignMultilineItems" value="!=100"/>
<property name="ignoreNewlines" value="false"/>
</properties>
</rule>

<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
<properties>
<property name="prefixes" type="array" value="_s"/>
</properties>
</rule>

<!-- Keep PHPCompatibility configuration -->
<config name="testVersion" value="5.6-"/>
<rule ref="PHPCompatibilityWP"/>
</ruleset>