Skip to content

Commit 2107d7a

Browse files
authored
release: v2.0.1 (#10)
* release: v2.0.1 * ci: add PR template * chore: cleanup
1 parent c4f14f9 commit 2107d7a

File tree

7 files changed

+60
-6
lines changed

7 files changed

+60
-6
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!--
2+
Thanks for taking the time to submit a Pull Request.
3+
-->
4+
5+
## What
6+
<!-- In a few words, what does this PR actually change -->
7+
8+
## Why
9+
<!-- Why is this PR necessary? Please any existing previous issue(s) or PR(s) and include a short summary here, too -->
10+
11+
## How
12+
<!-- How is your PR addressing the issue at hand? What are the implementation details? -->
13+
14+
## Testing Instructions
15+
<!-- Please include step by step instructions on how to test this PR. Ideally with a code example. -->
16+
17+
## Checklist:
18+
<!-- We encourage you to complete this checklist to the best of your abilities. If you can't do everything, that's okay too. -->
19+
- [ ] My code is tested to the best of my abilities.
20+
- [ ] I included the relevant changes in CHANGELOG.md

.github/funding.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# These are supported funding model platforms
2+
3+
github: [AxeWp]

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.vscode/
12
build/
23
vendor/
34
composer.lock

CHANGELOG.md

+19-2
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,27 @@ This projects adheres to [Semantic Versioning](https://semver.org/) and [Keep a
66

77
## [ Unreleased ]
88

9+
## [ 2.0.1 ] - 2025-05-03
10+
11+
This release fixes several bugs where rules were not being disabled correctly.
12+
13+
We've also added CI to the repo to test the rulesets against the latest WPGraphQL codebase, to preemptively catch future issues.
14+
15+
### WPGraphQL-Core
16+
17+
- fix: Fix incorrect excludes XML block in `WPGraphQL-Core` ruleset.
18+
19+
### WPGraphQL-Docs
20+
921
- fix: Disable `Squiz.Commenting.VariableComment.MissingVar` in favor of `SlevomatCodingStandard.TypeHints.PropertyTypeHint`.
22+
23+
### WPGraphQL-Minimum
1024
- fix: Ignore `SlevomatCodingStandard.Namespaces.FullyQualifiedClassNameInAnnotation` for PHPStan annotations.
11-
- fix: Fix incorrect excludes in `WPGraphQL-Core` ruleset.
12-
- ci: Add ruleset testing Workflow.
25+
26+
### Misc
27+
28+
- ci: Add test workflow.
29+
- docs: cleanup Readme.
1330

1431
## [2.0.0] - 2025-02-15
1532

README.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
# WPGraphQL Coding Standards for [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer)
1+
# WPGraphQL Coding Standards for PHP_CodeSniffer
22

3-
This project is a collection of rules and sniffs for PHPCS to validate code developed for the [WPGraphQL](https://github.com/wp-graphql/wp-graphql) ecosystem. It uses rules from:
3+
![Packagist License](https://img.shields.io/packagist/l/axepress/wp-graphql-cs?color=green) ![Packagist Downloads](https://img.shields.io/packagist/dt/axepress/wp-graphql-cs) ![Packagist Version](https://img.shields.io/packagist/v/axepress/wp-graphql-cs?label=stable) ![GitHub commits since latest release (by SemVer)](https://img.shields.io/github/commits-since/AxeWP/WPGraphQL-Coding-Standards/2.0.1) ![GitHub Repo stars](https://img.shields.io/github/stars/AxeWP/WPGraphQL-Coding-Standards?style=social) ![Tests](https://img.shields.io/github/actions/workflow/status/axewp/WPGraphQL-Coding-Standards/test.yml?branch=develop&label=CI)
4+
5+
-----
6+
This project is a collection of rules and sniffs for [PHPCS](https://github.com/squizlabs/PHP_CodeSniffer) to validate code developed for the [WPGraphQL](https://github.com/wp-graphql/wp-graphql) ecosystem. It uses rules from:
47
- [WordPress Coding Standards](https://github.com/WordPress/WordPress-Coding-Standards)
58
- [Automattic VIP Coding Standards](https://github.com/Automattic/VIP-Coding-Standards)
69
- [Slevomat Coding Standard](https://https://github.com/slevomat/coding-standard)
@@ -55,3 +58,13 @@ In this file, you will want to configure the following:
5558
- [`minimum_wp_version`](./phpcs.xml.dist.example#L43) - The minimum WordPress version you want to test against. This should be the lowest version of WordPress that you want to support. While WPGraphQL officially supports WordPress 5.0+, we recommend testing against WordPress 5.6 (the current lowest version actively [tested against](https://github.com/wp-graphql/wp-graphql/blob/develop/.github/workflows/testing-integration.yml)) or higher.
5659
- [`WordPress.WP.I18n.text_domain`](./phpcs.xml.dist.example#L63) - The text domain used in your project. This is used by the `WordPress.WP.I18n` sniff to check that all translatable strings are assigned to a text domain. We recommend using the format `wp-graphql-<project-name>`.
5760
- [`WordPress.NamingConventions.PrefixAllGlobals`](./phpcs.xml.dist.example#L57) - The list of prefixes used in your project. This is used by the `WordPress.NamingConventions.PrefixAllGlobals` sniff to check that all global functions, classes, constants, and variables are prefixed.
61+
62+
## Development and Support
63+
64+
The project is actively maintained by [AxePress Development](https://axepress.dev). Community contributions are _welcome_ and **encouraged**.
65+
66+
Basic support is provided for free, both in [this repo](https://github.com/AxeWP/WPGraphQL-Coding-Standards/issues) and in [WPGraphQL's official Discord](https://discord.gg/55h7WmYZff).
67+
68+
Priority support and custom development are available to [our Sponsors](https://github.com/sponsors/AxeWP).
69+
70+
<a href="https://github.com/sponsors/AxeWP" alt="GitHub Sponsors"><img src="https://img.shields.io/static/v1?label=Sponsor%20Us%20%40%20AxeWP&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86&style=for-the-badge" /></a>

WPGraphQL/ruleset.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="WPGraphQL Strict Coding Standard" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd">
33
<description>WPGraphQL Coding Standards</description>
44

5-
<!-- Includes WPGrapQL-Minimum and WPGraphQL-Strict-->
5+
<!-- Includes WPGraphQL-Minimum and WPGraphQL-Strict-->
66
<rule ref="WPGraphQL-Extra" />
77
<rule ref="WPGraphQL-Docs" />
88

phpcs.xml.dist.example

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
Tests for WordPress version compatibility.
4444
https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Customizable-sniff-properties
4545
-->
46-
<config name="minimum_wp_version" value="5.9"/>
46+
<config name="minimum_wp_version" value="6.0"/>
4747

4848
<!-- Rules: WPGraphQL Coding Standards -->
4949
<!-- https://github.com/AxeWP/WPGraphQL-Coding-Standards/WPGraphQL/ruleset.xml -->

0 commit comments

Comments
 (0)