dev: add support for lazy-loading description/deprecationReason config values (#121)

* chore: update strauss and deps

* dev: use callable descriptions/deprecations

* fix: dont prefix `NodeWithRankMathSeo`

* chore: fix backcompat on connections

* chore: update dep

* chore: update deps

* tests: ensure schema can build

* chore: update and cleanup

* fix: regenerate autoloader

Author: justlevine

.phpcs.xml.dist

@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<ruleset name="WordPress Coding Standards for WPGraphQL for RankMath SEO" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd">
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="WordPress Coding Standards for WPGraphQL for RankMath SEO" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd">
 	<description>Sniffs for the WPGraphQL plugin ecosystem </description>
 
 	<!-- What to scan: include any root-level PHP files, and the /src folder -->
@@ -20,10 +20,12 @@
 	<!-- Strip the file paths down to the relevant bit -->
 	<arg name="colors"/>
 	<arg name="extensions" value="php"/>
-	<!-- Enables parallel processing when available for faster results. -->
-	<arg name="parallel" value="20"/>
 	<!-- Whenever possible, cache the scan results and re-use those for unchanged files on the next scan. -->
 	<arg name="cache" value="tests/_output/phpcs-cache.json" />
+	<!-- Enables parallel processing when available for faster results. -->
+	<arg name="parallel" value="20"/>
+	<!-- Set severity to 1 to see everything that isn't effectively turned off. -->
+	<arg name="severity" value="1" />
 
 	<!-- Ruleset Config: set these to match your project constraints-->
 
@@ -41,19 +43,31 @@
 
 	<!-- Rules: WPGraphQL Coding Standards -->
 	<!-- https://github.com/AxeWP/WPGraphQL-Coding-Standards/WPGraphQL/ruleset.xml -->
-	<rule ref="WPGraphQL" />
+	<rule ref="WPGraphQL">
+		<!-- @todo remove after PHPCS v4-->
+		<exclude name="WordPressVIPMinimum.JS" />
+		<exclude name="Generic.Functions.CallTimePassByReference" />
+	</rule>
 
 	<!-- Individual rule configuration -->
 	<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
 		<properties>
-			<!-- Value: replace the function, class, and variable prefixes used. Separate multiple prefixes with a comma. -->
-			<property name="prefixes" type="array" value="WPGraphQL\RankMath, wp_graphql, graphql_seo, WPGRAPHQL_SEO, rank_math" />
+			<!-- Value: replace the function, class, and variable prefixes used. -->
+			<property name="prefixes" type="array">
+				<element value="WPGraphQL\RankMath" />
+				<element value="wp_graphql" />
+				<element value="graphql_seo" />
+				<element value="WPGRAPHQL_SEO" />
+				<element value="rank_math" />
+			</property>
 		</properties>
 	</rule>
 	<rule ref="WordPress.WP.I18n">
 		<properties>
 			<!-- Value: replace the text domain used. -->
-			<property name="text_domain" type="array" value="wp-graphql-rank-math"/>
+			<property name="text_domain" type="array">
+				<element value="wp-graphql-rank-math"/>
+			</property>
 		</properties>
 	</rule>
 

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## [Unreleased]
 
 - fix: Fix type conflicts on Product interfaces in WooGraphQL 0.21.1+. Props @robbiebel 🙌
+- dev: Add support for lazy-loading GraphQL descriptions and deprecation messages.
 - chore: bump PHPStan to v2.0.x
 - chore: Test compatibility with WordPress 6.8 and WPGraphQL 2.3.
 - chore: Update Composer dev-dependencies and lint.

composer.json

@@ -28,10 +28,10 @@
 	],
 	"require": {
 		"php": ">=7.4",
-		"axepress/wp-graphql-plugin-boilerplate": "^0.1.0"
+		"axepress/wp-graphql-plugin-boilerplate": "^0.1.1"
 	},
 	"require-dev": {
-		"axepress/wp-graphql-cs": "^2.0.0-beta",
+		"axepress/wp-graphql-cs": "^2.0.0",
 		"axepress/wp-graphql-stubs": "^2.0.0",
 		"codeception/lib-innerbrowser": "^1.0",
 		"codeception/module-asserts": "^1.0",
@@ -88,8 +88,13 @@
 			"namespace_prefix": "WPGraphQL\\RankMath\\Vendor\\",
 			"classmap_prefix": "WPGraphQL_RankMath_",
 			"constant_prefix": "WPGRAPHQL_SEO_",
-			"include_modified_date": false,
 			"delete_vendor_packages": true,
+			"include_modified_date": false,
+			"update_call_sites": false,
+			"exclude_from_prefix": {
+				"namespaces": [],
+				"file_patterns": []
+			},
 			"packages": [
 				"axepress/wp-graphql-plugin-boilerplate"
 			]
@@ -122,19 +127,25 @@
 		"phpstan": [
 			"vendor/bin/phpstan analyze --ansi --memory-limit=1G"
 		],
-		"strauss-install": [
-			"test -f ./bin/strauss.phar || curl -o bin/strauss.phar -L -C - https://github.com/BrianHenryIE/strauss/releases/download/0.19.1/strauss.phar"
+		"pre-prefix-namespaces": [
+			"test -d vendor-prefixed || mkdir vendor-prefixed",
+			"test -f ./bin/strauss.phar || curl -o bin/strauss.phar -L -C - https://github.com/BrianHenryIE/strauss/releases/download/0.22.2/strauss.phar"
 		],
-		"strauss": [
-			"@strauss-install",
+		"prefix-namespaces": [
 			"@php bin/strauss.phar",
-			"composer dump-autoload --optimize"
+			"@composer dump-autoload"
+		],
+		"pre-install-cmd": [
+			"@pre-prefix-namespaces"
+		],
+		"pre-update-cmd": [
+			"@pre-install-cmd"
 		],
 		"post-install-cmd": [
-			"@strauss"
+			"@prefix-namespaces"
 		],
 		"post-update-cmd": [
-			"@strauss"
+			"@prefix-namespaces"
 		]
 	}
 }