Add ESLint rule to avoid unintentional dependency on @wp-playgrounds/wordpress-builds

.eslintrc.json

@@ -1,7 +1,7 @@
 {
 	"root": true,
 	"ignorePatterns": ["**/*"],
-	"plugins": ["@nx"],
+	"plugins": ["@nx", "playground-dev"],
 	"overrides": [
 		{
 			"files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
@@ -73,7 +73,8 @@
 				"@typescript-eslint/no-empty-interface": 0,
 				"@typescript-eslint/no-empty-function": 0,
 				"@typescript-eslint/no-unused-vars": "error",
-				"no-constant-condition": 0
+				"no-constant-condition": 0,
+				"playground-dev/avoid-wordpress-builds-dependency": "error"
 			}
 		},
 		{
@@ -89,7 +90,8 @@
 		{
 			"files": "*.spec.ts",
 			"rules": {
-				"no-console": 0
+				"no-console": 0,
+				"playground-dev/avoid-wordpress-builds-dependency": 0
 			}
 		},
 		{

package.json

@@ -168,6 +168,7 @@
 		"eslint-plugin-cypress": "^2.13.4",
 		"eslint-plugin-import": "2.27.5",
 		"eslint-plugin-jsx-a11y": "6.7.1",
+		"eslint-plugin-playground-dev": "file:packages/meta/src/eslint-plugin-playground-dev",
 		"eslint-plugin-react": "7.32.2",
 		"eslint-plugin-react-hooks": "4.6.0",
 		"gh-pages": "5.0.0",

packages/meta/src/eslint-plugin-playground-dev/avoid-wordpress-builds-dependency.js

@@ -0,0 +1,28 @@
+const description =
+	'Avoid dependency on @wp-playground/wordpress-builds ' +
+	'because it is a private, unpublished package. Public, ' +
+	'published packages will be broken if they have a runtime ' +
+	'dependency on an unpublished package.';
+module.exports = {
+	meta: {
+		type: 'problem',
+		docs: { description },
+	},
+	create(context) {
+		return {
+			ImportDeclaration: (node) => {
+				if (node.source.value === '@wp-playground/wordpress-builds') {
+					context.report({
+						loc: node.loc,
+						message:
+							description +
+							' ' +
+							'If you need this dependency and deem it safe, ' +
+							'please disable the rule for this line and leave ' +
+							'a comment explaining why.',
+					});
+				}
+			},
+		};
+	},
+};

packages/meta/src/eslint-plugin-playground-dev/index.js

@@ -0,0 +1,7 @@
+const wpBuildsDepRule = require('./avoid-wordpress-builds-dependency');
+const plugin = {
+	rules: {
+		'avoid-wordpress-builds-dependency': wpBuildsDepRule,
+	},
+};
+module.exports = plugin;

packages/meta/src/eslint-plugin-playground-dev/package.json

@@ -0,0 +1,11 @@
+{
+	"private": true,
+	"name": "eslint-plugin-playground-dev",
+	"version": "0.0.1",
+	"description": "ESLint rules for developing WordPress Playground packages",
+	"main": "index.js",
+	"scripts": {
+		"test": "echo \"TODO: Use ESLint rule tester if tests are needed.\" && exit 1"
+	},
+	"license": "GPL-2.0-or-later"
+}

packages/playground/remote/.eslintrc.json

@@ -8,7 +8,11 @@
 		},
 		{
 			"files": ["*.ts", "*.tsx"],
-			"rules": {}
+			"rules": {
+				// The remote package uses wordpress-builds in a way that does
+				// not create a runtime dependency to an unpublished package.
+				"playground-dev/avoid-wordpress-builds-dependency": 0
+			}
 		},
 		{
 			"files": ["*.js", "*.jsx"],