From b6921a52300bf4eb220fabf9e570602e30271d2b Mon Sep 17 00:00:00 2001 From: Sean Fisher Date: Tue, 29 Aug 2023 16:10:05 -0400 Subject: [PATCH 1/2] Upgrade to wpcs 3.0 --- Alley-Interactive/ruleset.xml | 6 ++++++ composer.json | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/Alley-Interactive/ruleset.xml b/Alley-Interactive/ruleset.xml index e51ced6..73720bb 100644 --- a/Alley-Interactive/ruleset.xml +++ b/Alley-Interactive/ruleset.xml @@ -24,6 +24,12 @@ + + + diff --git a/composer.json b/composer.json index 2ef2128..822466c 100644 --- a/composer.json +++ b/composer.json @@ -5,7 +5,7 @@ "keywords": [ "phpcs", "static analysis" ], "license": "GPL-2.0-or-later", "require": { - "automattic/vipwpcs": "^2.3.3", + "automattic/vipwpcs": "^2.3.4", "phpcompatibility/phpcompatibility-wp": "^2.1.4" }, "config": { From df96949e5fa0a413f9cd36a6961f036afc81d305 Mon Sep 17 00:00:00 2001 From: Sean Fisher Date: Tue, 29 Aug 2023 16:18:39 -0400 Subject: [PATCH 2/2] README and CHANGELOG --- README.md | 47 ++++------------------------------------------- 1 file changed, 4 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 7d50c67..3b06599 100644 --- a/README.md +++ b/README.md @@ -64,53 +64,14 @@ You can create a custom ruleset for your project that extends or customizes thes ``` -## Using Alley Coding Standards on PHP 8.1 - -If you plan on using this ruleset on PHP 8.1, you will need to make some -modifications to your Composer configuration. For some context, the current -version of this ruleset requires `wp-coding-standards/wpcs` 2.3. This package is -not compatible with PHP 8.1 and runs into some issues when being used. Until -`wp-coding-standards/wpcs` 3.0 is released we can use a forked version of the -package that is compatible with PHP 8.1. - -### 1. Add the Repository - -Add the Composer repository to your project's `composer.json` file: - -```json -{ - "repositories": { - "wpcs": { - "type": "vcs", - "url": "https://github.com/alleyinteractive/WordPress-Coding-Standards" - } - } -} -``` - -### 2. Switch to the Forked Version - -Add the following to your `composer.json` file `autoload-dev` section: - -```json -{ - "require-dev": { - "alleyinteractive/alley-coding-standards": "^1.0", - "wp-coding-standards/wpcs": "dev-php-8-1 as 2.3.x-dev" - }, -} -``` - -### 3. Run `composer update` - -If you run into any problems, please open an issue. After -`wp-coding-standards/wpcs` 3.0 is released we will remove the above fork from -our projects and rely on the official release. - ## Change Log This project adheres to [Keep a CHANGELOG](https://keepachangelog.com/en/1.0.0/). +### 1.0.1 + +- Ignore deprecation errors in WPCS to allow it work with PHP 8.0+. + ### 1.0.0 - No changes, tagging a stable release of Alley Coding Standards.