@atlaskit/eslint-plugin-platform 0.10.0 → 0.11.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/eslint-plugin-platform
 
+## 0.11.0
+
+### Minor Changes
+
+- [#157006](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/157006)
+  [`cfd78f9ae1e67`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/cfd78f9ae1e67) -
+  Renamed `ensure-valid-workspace-protocol-usage` to `ensure-valid-yarn-protocol-usage` and updated
+  the rule to error if the root custom yarn protocol is used in any platform package.
+
+## 0.10.1
+
+### Patch Changes
+
+- [#156370](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/156370)
+  [`b8def46d59747`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/b8def46d59747) -
+  Improved error message in ensure-valid-workspace-protocol-usage rule to provide information about
+  how to resolve the error.
+
 ## 0.10.0
 
 ### Minor Changes

package/dist/cjs/index.js

@@ -15,7 +15,7 @@ var _noDuplicateDependencies = _interopRequireDefault(require("./rules/no-duplic
 var _noInvalidFeatureFlagUsage = _interopRequireDefault(require("./rules/no-invalid-feature-flag-usage"));
 var _ensureFeatureFlagPrefix = _interopRequireDefault(require("./rules/ensure-feature-flag-prefix"));
 var _ensureCriticalDependencyResolutions = _interopRequireDefault(require("./rules/ensure-critical-dependency-resolutions"));
-var _ensureValidWorkspaceProtocolUsage = _interopRequireDefault(require("./rules/ensure-valid-workspace-protocol-usage"));
+var _ensureValidYarnProtocolUsage = _interopRequireDefault(require("./rules/ensure-valid-yarn-protocol-usage"));
 var _ensureValidBinValues = _interopRequireDefault(require("./rules/ensure-valid-bin-values"));
 var _noInvalidStorybookDecoratorUsage = _interopRequireDefault(require("./rules/no-invalid-storybook-decorator-usage"));
 var _ensurePublishValid = _interopRequireDefault(require("./rules/ensure-publish-valid"));
@@ -38,7 +38,7 @@ var rules = exports.rules = {
   'ensure-test-runner-nested-count': _ensureTestRunnerNestedCount.default,
   'ensure-atlassian-team': _ensureAtlassianTeam.default,
   'ensure-critical-dependency-resolutions': _ensureCriticalDependencyResolutions.default,
-  'ensure-valid-workspace-protocol-usage': _ensureValidWorkspaceProtocolUsage.default,
+  'ensure-valid-yarn-protocol-usage': _ensureValidYarnProtocolUsage.default,
   'ensure-valid-bin-values': _ensureValidBinValues.default,
   'no-duplicate-dependencies': _noDuplicateDependencies.default,
   'no-invalid-feature-flag-usage': _noInvalidFeatureFlagUsage.default,

package/dist/cjs/rules/ensure-valid-yarn-protocol-usage/index.js

@@ -0,0 +1,91 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _handleAstObject = require("../util/handle-ast-object");
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; } // eslint-disable-next-line import/no-extraneous-dependencies
+var workspaceProtocolRegex = /^workspace:[\^~\*]$/;
+var rootProtocolRegex = /^root:[\^~\*]$/;
+
+/**
+ * Checks if the 'workspace:' and 'root:' protocol are used as either dependencies or devDependencies
+ */
+function getYarnProtocolsUsed(node) {
+  var protocolsUsed = {
+    workspace: false,
+    root: false
+  };
+  var dependencies = (0, _handleAstObject.getObjectPropertyAsObject)(node, 'dependencies');
+  var devDependencies = (0, _handleAstObject.getObjectPropertyAsObject)(node, 'devDependencies');
+  for (var _i = 0, _arr = [dependencies, devDependencies]; _i < _arr.length; _i++) {
+    var obj = _arr[_i];
+    var _iterator = _createForOfIteratorHelper((obj === null || obj === void 0 ? void 0 : obj.properties) || []),
+      _step;
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        var p = _step.value;
+        if (p.type === 'Property' && p.value.type === 'Literal') {
+          if (typeof p.value.value === 'string') {
+            if (workspaceProtocolRegex.test(p.value.value)) {
+              protocolsUsed.workspace = true;
+            }
+            if (rootProtocolRegex.test(p.value.value)) {
+              protocolsUsed.root = true;
+            }
+          }
+        }
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
+  }
+  return protocolsUsed;
+}
+var rule = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: "Ensures that yarn protocols 'workspace:' and 'root:' are used correctly.",
+      recommended: true
+    },
+    hasSuggestions: false,
+    messages: {
+      invalidWorkspaceProtocolUsage: "The 'workspace:' protocol is not allowed in public packages. To resolve this error, either set the package to private or replace the 'workspace:' protocol with specific package versions (e.g. '^1.0.0').",
+      invalidRootProtocolUsage: "The 'root:' protocol is not allowed in platform packages. To resolve this error, replace the 'root:' protocol with specific package versions (e.g. '^1.0.0')."
+    }
+  },
+  create: function create(context) {
+    return {
+      ObjectExpression: function ObjectExpression(node) {
+        if (!context.filename.endsWith('package.json') || node.type !== 'ObjectExpression') {
+          return;
+        }
+        var yarnProtocolsUsed = getYarnProtocolsUsed(node);
+
+        // The 'root:' protocol can not be used in any platform packages
+        if (yarnProtocolsUsed.root) {
+          context.report({
+            node: node,
+            messageId: 'invalidRootProtocolUsage'
+          });
+        }
+
+        // The 'workspace:' protocol can not be used in public packages
+        var isPrivatePackage = (0, _handleAstObject.getObjectPropertyAsLiteral)(node, 'private') === true;
+        if (!isPrivatePackage && yarnProtocolsUsed.workspace) {
+          context.report({
+            node: node,
+            messageId: 'invalidWorkspaceProtocolUsage'
+          });
+        }
+      }
+    };
+  }
+};
+var _default = exports.default = rule;

package/dist/es2019/index.js

@@ -9,7 +9,7 @@ import noDuplicateDependencies from './rules/no-duplicate-dependencies';
 import noInvalidFeatureFlagUsage from './rules/no-invalid-feature-flag-usage';
 import ensureFeatureFlagPrefix from './rules/ensure-feature-flag-prefix';
 import ensureCriticalDependencyResolutions from './rules/ensure-critical-dependency-resolutions';
-import ensureValidWorkspaceProtocolUsage from './rules/ensure-valid-workspace-protocol-usage';
+import ensureValidYarnProtocolUsage from './rules/ensure-valid-yarn-protocol-usage';
 import ensureValidBinValues from './rules/ensure-valid-bin-values';
 import noInvalidStorybookDecoratorUsage from './rules/no-invalid-storybook-decorator-usage';
 import ensurePublishValid from './rules/ensure-publish-valid';
@@ -30,7 +30,7 @@ export const rules = {
   'ensure-test-runner-nested-count': ensureTestRunnerNestedCount,
   'ensure-atlassian-team': ensureAtlassianTeam,
   'ensure-critical-dependency-resolutions': ensureCriticalDependencyResolutions,
-  'ensure-valid-workspace-protocol-usage': ensureValidWorkspaceProtocolUsage,
+  'ensure-valid-yarn-protocol-usage': ensureValidYarnProtocolUsage,
   'ensure-valid-bin-values': ensureValidBinValues,
   'no-duplicate-dependencies': noDuplicateDependencies,
   'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,

package/dist/es2019/rules/ensure-valid-yarn-protocol-usage/index.js

@@ -0,0 +1,74 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+
+import { getObjectPropertyAsObject, getObjectPropertyAsLiteral } from '../util/handle-ast-object';
+const workspaceProtocolRegex = /^workspace:[\^~\*]$/;
+const rootProtocolRegex = /^root:[\^~\*]$/;
+
+/**
+ * Checks if the 'workspace:' and 'root:' protocol are used as either dependencies or devDependencies
+ */
+function getYarnProtocolsUsed(node) {
+  const protocolsUsed = {
+    workspace: false,
+    root: false
+  };
+  const dependencies = getObjectPropertyAsObject(node, 'dependencies');
+  const devDependencies = getObjectPropertyAsObject(node, 'devDependencies');
+  for (const obj of [dependencies, devDependencies]) {
+    for (const p of (obj === null || obj === void 0 ? void 0 : obj.properties) || []) {
+      if (p.type === 'Property' && p.value.type === 'Literal') {
+        if (typeof p.value.value === 'string') {
+          if (workspaceProtocolRegex.test(p.value.value)) {
+            protocolsUsed.workspace = true;
+          }
+          if (rootProtocolRegex.test(p.value.value)) {
+            protocolsUsed.root = true;
+          }
+        }
+      }
+    }
+  }
+  return protocolsUsed;
+}
+const rule = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: `Ensures that yarn protocols 'workspace:' and 'root:' are used correctly.`,
+      recommended: true
+    },
+    hasSuggestions: false,
+    messages: {
+      invalidWorkspaceProtocolUsage: `The 'workspace:' protocol is not allowed in public packages. To resolve this error, either set the package to private or replace the 'workspace:' protocol with specific package versions (e.g. '^1.0.0').`,
+      invalidRootProtocolUsage: `The 'root:' protocol is not allowed in platform packages. To resolve this error, replace the 'root:' protocol with specific package versions (e.g. '^1.0.0').`
+    }
+  },
+  create(context) {
+    return {
+      ObjectExpression: node => {
+        if (!context.filename.endsWith('package.json') || node.type !== 'ObjectExpression') {
+          return;
+        }
+        const yarnProtocolsUsed = getYarnProtocolsUsed(node);
+
+        // The 'root:' protocol can not be used in any platform packages
+        if (yarnProtocolsUsed.root) {
+          context.report({
+            node,
+            messageId: 'invalidRootProtocolUsage'
+          });
+        }
+
+        // The 'workspace:' protocol can not be used in public packages
+        const isPrivatePackage = getObjectPropertyAsLiteral(node, 'private') === true;
+        if (!isPrivatePackage && yarnProtocolsUsed.workspace) {
+          context.report({
+            node,
+            messageId: 'invalidWorkspaceProtocolUsage'
+          });
+        }
+      }
+    };
+  }
+};
+export default rule;

package/dist/esm/index.js

@@ -12,7 +12,7 @@ import noDuplicateDependencies from './rules/no-duplicate-dependencies';
 import noInvalidFeatureFlagUsage from './rules/no-invalid-feature-flag-usage';
 import ensureFeatureFlagPrefix from './rules/ensure-feature-flag-prefix';
 import ensureCriticalDependencyResolutions from './rules/ensure-critical-dependency-resolutions';
-import ensureValidWorkspaceProtocolUsage from './rules/ensure-valid-workspace-protocol-usage';
+import ensureValidYarnProtocolUsage from './rules/ensure-valid-yarn-protocol-usage';
 import ensureValidBinValues from './rules/ensure-valid-bin-values';
 import noInvalidStorybookDecoratorUsage from './rules/no-invalid-storybook-decorator-usage';
 import ensurePublishValid from './rules/ensure-publish-valid';
@@ -33,7 +33,7 @@ export var rules = {
   'ensure-test-runner-nested-count': ensureTestRunnerNestedCount,
   'ensure-atlassian-team': ensureAtlassianTeam,
   'ensure-critical-dependency-resolutions': ensureCriticalDependencyResolutions,
-  'ensure-valid-workspace-protocol-usage': ensureValidWorkspaceProtocolUsage,
+  'ensure-valid-yarn-protocol-usage': ensureValidYarnProtocolUsage,
   'ensure-valid-bin-values': ensureValidBinValues,
   'no-duplicate-dependencies': noDuplicateDependencies,
   'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,

package/dist/esm/rules/ensure-valid-yarn-protocol-usage/index.js

@@ -0,0 +1,87 @@
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+// eslint-disable-next-line import/no-extraneous-dependencies
+
+import { getObjectPropertyAsObject, getObjectPropertyAsLiteral } from '../util/handle-ast-object';
+var workspaceProtocolRegex = /^workspace:[\^~\*]$/;
+var rootProtocolRegex = /^root:[\^~\*]$/;
+
+/**
+ * Checks if the 'workspace:' and 'root:' protocol are used as either dependencies or devDependencies
+ */
+function getYarnProtocolsUsed(node) {
+  var protocolsUsed = {
+    workspace: false,
+    root: false
+  };
+  var dependencies = getObjectPropertyAsObject(node, 'dependencies');
+  var devDependencies = getObjectPropertyAsObject(node, 'devDependencies');
+  for (var _i = 0, _arr = [dependencies, devDependencies]; _i < _arr.length; _i++) {
+    var obj = _arr[_i];
+    var _iterator = _createForOfIteratorHelper((obj === null || obj === void 0 ? void 0 : obj.properties) || []),
+      _step;
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        var p = _step.value;
+        if (p.type === 'Property' && p.value.type === 'Literal') {
+          if (typeof p.value.value === 'string') {
+            if (workspaceProtocolRegex.test(p.value.value)) {
+              protocolsUsed.workspace = true;
+            }
+            if (rootProtocolRegex.test(p.value.value)) {
+              protocolsUsed.root = true;
+            }
+          }
+        }
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
+  }
+  return protocolsUsed;
+}
+var rule = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: "Ensures that yarn protocols 'workspace:' and 'root:' are used correctly.",
+      recommended: true
+    },
+    hasSuggestions: false,
+    messages: {
+      invalidWorkspaceProtocolUsage: "The 'workspace:' protocol is not allowed in public packages. To resolve this error, either set the package to private or replace the 'workspace:' protocol with specific package versions (e.g. '^1.0.0').",
+      invalidRootProtocolUsage: "The 'root:' protocol is not allowed in platform packages. To resolve this error, replace the 'root:' protocol with specific package versions (e.g. '^1.0.0')."
+    }
+  },
+  create: function create(context) {
+    return {
+      ObjectExpression: function ObjectExpression(node) {
+        if (!context.filename.endsWith('package.json') || node.type !== 'ObjectExpression') {
+          return;
+        }
+        var yarnProtocolsUsed = getYarnProtocolsUsed(node);
+
+        // The 'root:' protocol can not be used in any platform packages
+        if (yarnProtocolsUsed.root) {
+          context.report({
+            node: node,
+            messageId: 'invalidRootProtocolUsage'
+          });
+        }
+
+        // The 'workspace:' protocol can not be used in public packages
+        var isPrivatePackage = getObjectPropertyAsLiteral(node, 'private') === true;
+        if (!isPrivatePackage && yarnProtocolsUsed.workspace) {
+          context.report({
+            node: node,
+            messageId: 'invalidWorkspaceProtocolUsage'
+          });
+        }
+      }
+    };
+  }
+};
+export default rule;

package/dist/types/index.d.ts

@@ -6,7 +6,7 @@ export declare const rules: {
     'ensure-test-runner-nested-count': import("eslint").Rule.RuleModule;
     'ensure-atlassian-team': import("eslint").Rule.RuleModule;
     'ensure-critical-dependency-resolutions': import("eslint").Rule.RuleModule;
-    'ensure-valid-workspace-protocol-usage': import("eslint").Rule.RuleModule;
+    'ensure-valid-yarn-protocol-usage': import("eslint").Rule.RuleModule;
     'ensure-valid-bin-values': import("eslint").Rule.RuleModule;
     'no-duplicate-dependencies': import("eslint").Rule.RuleModule;
     'no-invalid-feature-flag-usage': import("eslint").Rule.RuleModule;

package/dist/types-ts4.5/index.d.ts

@@ -6,7 +6,7 @@ export declare const rules: {
     'ensure-test-runner-nested-count': import("eslint").Rule.RuleModule;
     'ensure-atlassian-team': import("eslint").Rule.RuleModule;
     'ensure-critical-dependency-resolutions': import("eslint").Rule.RuleModule;
-    'ensure-valid-workspace-protocol-usage': import("eslint").Rule.RuleModule;
+    'ensure-valid-yarn-protocol-usage': import("eslint").Rule.RuleModule;
     'ensure-valid-bin-values': import("eslint").Rule.RuleModule;
     'no-duplicate-dependencies': import("eslint").Rule.RuleModule;
     'no-invalid-feature-flag-usage': import("eslint").Rule.RuleModule;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@atlaskit/eslint-plugin-platform",
 	"description": "The essential plugin for use with Atlassian frontend platform tools",
-	"version": "0.10.0",
+	"version": "0.11.0",
 	"author": "Atlassian Pty Ltd",
 	"atlassian": {
 		"team": "UIP Dev Infra",

package/src/index.tsx

@@ -9,7 +9,7 @@ import noDuplicateDependencies from './rules/no-duplicate-dependencies';
 import noInvalidFeatureFlagUsage from './rules/no-invalid-feature-flag-usage';
 import ensureFeatureFlagPrefix from './rules/ensure-feature-flag-prefix';
 import ensureCriticalDependencyResolutions from './rules/ensure-critical-dependency-resolutions';
-import ensureValidWorkspaceProtocolUsage from './rules/ensure-valid-workspace-protocol-usage';
+import ensureValidYarnProtocolUsage from './rules/ensure-valid-yarn-protocol-usage';
 import ensureValidBinValues from './rules/ensure-valid-bin-values';
 import noInvalidStorybookDecoratorUsage from './rules/no-invalid-storybook-decorator-usage';
 import ensurePublishValid from './rules/ensure-publish-valid';
@@ -31,7 +31,7 @@ export const rules = {
 	'ensure-test-runner-nested-count': ensureTestRunnerNestedCount,
 	'ensure-atlassian-team': ensureAtlassianTeam,
 	'ensure-critical-dependency-resolutions': ensureCriticalDependencyResolutions,
-	'ensure-valid-workspace-protocol-usage': ensureValidWorkspaceProtocolUsage,
+	'ensure-valid-yarn-protocol-usage': ensureValidYarnProtocolUsage,
 	'ensure-valid-bin-values': ensureValidBinValues,
 	'no-duplicate-dependencies': noDuplicateDependencies,
 	'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,

package/src/rules/{ensure-valid-workspace-protocol-usage → ensure-valid-yarn-protocol-usage}/__tests__/unit/rule.test.ts

@@ -3,10 +3,10 @@ import rule from '../../index';
 
 const cwd = process.cwd();
 
-describe('test ensure-valid-workspace-protocol-usage rule', () => {
-	tester.run('ensure-valid-workspace-protocol-usage', rule, {
-		// Workspace protocol is allowed in private packages as dependencies
+describe('test ensure-valid-yarn-protocol-usage rule', () => {
+	tester.run('workspace protocol', rule, {
 		valid: [
+			// Workspace protocol is allowed in private packages as dependencies
 			{
 				code: `const foo = {
             "private": true,
@@ -96,4 +96,104 @@ describe('test ensure-valid-workspace-protocol-usage rule', () => {
 			},
 		],
 	});
+
+	tester.run('root: protocol', rule, {
+		// 'root:' protocol is not allowed in any platform package
+		valid: [],
+		invalid: [
+			// 'root:' protocol is not allowed in packages as dependencies
+			{
+				code: `const foo = {
+            "dependencies": {
+              "react": "root:*",
+            }
+        }`,
+				filename: `${cwd}/packages/foo/package.json`,
+				errors: [
+					{
+						messageId: 'invalidRootProtocolUsage',
+					},
+				],
+			},
+			// 'root:' protocol is not allowed in private packages as dependencies
+			{
+				code: `const foo = {
+            "private": true,
+            "dependencies": {
+              "react": "root:*",
+            }
+        }`,
+				filename: `${cwd}/packages/foo/package.json`,
+				errors: [
+					{
+						messageId: 'invalidRootProtocolUsage',
+					},
+				],
+			},
+			// 'root:' protocol is not allowed in public packages as devDependencies
+			{
+				code: `const foo = {
+            "devDependencies": {
+              "react": "root:*",
+            }
+        }`,
+				filename: `${cwd}/packages/foo/package.json`,
+				errors: [
+					{
+						messageId: 'invalidRootProtocolUsage',
+					},
+				],
+			},
+			// 'root:' protocol is not allowed in private packages as devDependencies
+			{
+				code: `const foo = {
+            "private": true,
+            "devDependencies": {
+              "react": "root:*",
+            }
+        }`,
+				filename: `${cwd}/packages/foo/package.json`,
+				errors: [
+					{
+						messageId: 'invalidRootProtocolUsage',
+					},
+				],
+			},
+			// 'root:' protocol is not allowed in public packages as dependencies and devDependencies
+			{
+				code: `const foo = {
+            "dependencies": {
+              "lodash": "root:*"
+            },
+            "devDependencies": {
+              "react": "root:*"
+            }
+        }`,
+				filename: `${cwd}/packages/foo/package.json`,
+				errors: [
+					{
+						messageId: 'invalidRootProtocolUsage',
+					},
+				],
+			},
+			// 'root:' protocol is not allowed in private packages as dependencies and devDependencies
+			{
+				code: `const foo = {
+            "private": true,
+            "dependencies": {
+              "lodash": "root:*"
+            },
+            "devDependencies": {
+              "react": "root:*"
+            }
+        }`,
+				filename: `${cwd}/packages/foo/package.json`,
+				errors: [
+					{
+						messageId: 'invalidRootProtocolUsage',
+					},
+				],
+			},
+		],
+	});
 });

package/src/rules/ensure-valid-yarn-protocol-usage/index.ts

@@ -0,0 +1,79 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import type { Rule } from 'eslint';
+import type { ObjectExpression } from 'estree';
+import { getObjectPropertyAsObject, getObjectPropertyAsLiteral } from '../util/handle-ast-object';
+
+const workspaceProtocolRegex = /^workspace:[\^~\*]$/;
+const rootProtocolRegex = /^root:[\^~\*]$/;
+
+/**
+ * Checks if the 'workspace:' and 'root:' protocol are used as either dependencies or devDependencies
+ */
+function getYarnProtocolsUsed(node: ObjectExpression) {
+	const protocolsUsed = { workspace: false, root: false };
+
+	const dependencies = getObjectPropertyAsObject(node, 'dependencies');
+	const devDependencies = getObjectPropertyAsObject(node, 'devDependencies');
+
+	for (const obj of [dependencies, devDependencies]) {
+		for (const p of obj?.properties || []) {
+			if (p.type === 'Property' && p.value.type === 'Literal') {
+				if (typeof p.value.value === 'string') {
+					if (workspaceProtocolRegex.test(p.value.value)) {
+						protocolsUsed.workspace = true;
+					}
+					if (rootProtocolRegex.test(p.value.value)) {
+						protocolsUsed.root = true;
+					}
+				}
+			}
+		}
+	}
+
+	return protocolsUsed;
+}
+
+const rule: Rule.RuleModule = {
+	meta: {
+		type: 'problem',
+		docs: {
+			description: `Ensures that yarn protocols 'workspace:' and 'root:' are used correctly.`,
+			recommended: true,
+		},
+		hasSuggestions: false,
+		messages: {
+			invalidWorkspaceProtocolUsage: `The 'workspace:' protocol is not allowed in public packages. To resolve this error, either set the package to private or replace the 'workspace:' protocol with specific package versions (e.g. '^1.0.0').`,
+			invalidRootProtocolUsage: `The 'root:' protocol is not allowed in platform packages. To resolve this error, replace the 'root:' protocol with specific package versions (e.g. '^1.0.0').`,
+		},
+	},
+	create(context) {
+		return {
+			ObjectExpression: (node: Rule.Node) => {
+				if (!context.filename.endsWith('package.json') || node.type !== 'ObjectExpression') {
+					return;
+				}
+
+				const yarnProtocolsUsed = getYarnProtocolsUsed(node);
+
+				// The 'root:' protocol can not be used in any platform packages
+				if (yarnProtocolsUsed.root) {
+					context.report({
+						node,
+						messageId: 'invalidRootProtocolUsage',
+					});
+				}
+
+				// The 'workspace:' protocol can not be used in public packages
+				const isPrivatePackage = getObjectPropertyAsLiteral(node, 'private') === true;
+				if (!isPrivatePackage && yarnProtocolsUsed.workspace) {
+					context.report({
+						node,
+						messageId: 'invalidWorkspaceProtocolUsage',
+					});
+				}
+			},
+		};
+	},
+};
+
+export default rule;

package/dist/cjs/rules/ensure-valid-workspace-protocol-usage/index.js

@@ -1,65 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _handleAstObject = require("../util/handle-ast-object");
-// eslint-disable-next-line import/no-extraneous-dependencies
-
-var workspaceProtocolRegex = /^workspace:[\^~\*]$/;
-
-/**
- * Checks if the workspace protocol is used in either dependencies or devDependencies
- */
-function checkIsWorkspaceProtocolUsed(node) {
-  var dependencies = (0, _handleAstObject.getObjectPropertyAsObject)(node, 'dependencies');
-  var devDependencies = (0, _handleAstObject.getObjectPropertyAsObject)(node, 'devDependencies');
-  return [dependencies, devDependencies].some(function (obj) {
-    return obj !== null && obj.properties.some(function (p) {
-      if (p.type === 'Property' && p.value.type === 'Literal') {
-        return typeof p.value.value === 'string' && workspaceProtocolRegex.test(p.value.value);
-      }
-    });
-  });
-}
-var rule = {
-  meta: {
-    type: 'problem',
-    docs: {
-      description: "Ensures the workspace protocol is only used in private packages.",
-      recommended: true
-    },
-    hasSuggestions: false,
-    messages: {
-      invalidWorkspaceProtocolUsage: "The workspace protocol can not be used in public packages."
-    }
-  },
-  create: function create(context) {
-    var fileName = context.getFilename();
-    return {
-      ObjectExpression: function ObjectExpression(node) {
-        if (!fileName.endsWith('package.json') || node.type !== 'ObjectExpression') {
-          return;
-        }
-
-        // Exit early if we are linting a private package
-        var isPrivatePackage = (0, _handleAstObject.getObjectPropertyAsLiteral)(node, 'private') === true;
-        if (isPrivatePackage) {
-          return;
-        }
-
-        // Check if the workspace protocol is used in either dependencies or devDependencies
-        var isWorkspaceProtocolused = checkIsWorkspaceProtocolUsed(node);
-        if (!isWorkspaceProtocolused) {
-          return;
-        }
-        return context.report({
-          node: node,
-          messageId: 'invalidWorkspaceProtocolUsage'
-        });
-      }
-    };
-  }
-};
-var _default = exports.default = rule;

package/dist/es2019/rules/ensure-valid-workspace-protocol-usage/index.js

@@ -1,59 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-
-import { getObjectPropertyAsObject, getObjectPropertyAsLiteral } from '../util/handle-ast-object';
-const workspaceProtocolRegex = /^workspace:[\^~\*]$/;
-
-/**
- * Checks if the workspace protocol is used in either dependencies or devDependencies
- */
-function checkIsWorkspaceProtocolUsed(node) {
-  const dependencies = getObjectPropertyAsObject(node, 'dependencies');
-  const devDependencies = getObjectPropertyAsObject(node, 'devDependencies');
-  return [dependencies, devDependencies].some(obj => {
-    return obj !== null && obj.properties.some(p => {
-      if (p.type === 'Property' && p.value.type === 'Literal') {
-        return typeof p.value.value === 'string' && workspaceProtocolRegex.test(p.value.value);
-      }
-    });
-  });
-}
-const rule = {
-  meta: {
-    type: 'problem',
-    docs: {
-      description: `Ensures the workspace protocol is only used in private packages.`,
-      recommended: true
-    },
-    hasSuggestions: false,
-    messages: {
-      invalidWorkspaceProtocolUsage: `The workspace protocol can not be used in public packages.`
-    }
-  },
-  create(context) {
-    const fileName = context.getFilename();
-    return {
-      ObjectExpression: node => {
-        if (!fileName.endsWith('package.json') || node.type !== 'ObjectExpression') {
-          return;
-        }
-
-        // Exit early if we are linting a private package
-        const isPrivatePackage = getObjectPropertyAsLiteral(node, 'private') === true;
-        if (isPrivatePackage) {
-          return;
-        }
-
-        // Check if the workspace protocol is used in either dependencies or devDependencies
-        const isWorkspaceProtocolused = checkIsWorkspaceProtocolUsed(node);
-        if (!isWorkspaceProtocolused) {
-          return;
-        }
-        return context.report({
-          node,
-          messageId: 'invalidWorkspaceProtocolUsage'
-        });
-      }
-    };
-  }
-};
-export default rule;

package/dist/esm/rules/ensure-valid-workspace-protocol-usage/index.js

@@ -1,59 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-
-import { getObjectPropertyAsObject, getObjectPropertyAsLiteral } from '../util/handle-ast-object';
-var workspaceProtocolRegex = /^workspace:[\^~\*]$/;
-
-/**
- * Checks if the workspace protocol is used in either dependencies or devDependencies
- */
-function checkIsWorkspaceProtocolUsed(node) {
-  var dependencies = getObjectPropertyAsObject(node, 'dependencies');
-  var devDependencies = getObjectPropertyAsObject(node, 'devDependencies');
-  return [dependencies, devDependencies].some(function (obj) {
-    return obj !== null && obj.properties.some(function (p) {
-      if (p.type === 'Property' && p.value.type === 'Literal') {
-        return typeof p.value.value === 'string' && workspaceProtocolRegex.test(p.value.value);
-      }
-    });
-  });
-}
-var rule = {
-  meta: {
-    type: 'problem',
-    docs: {
-      description: "Ensures the workspace protocol is only used in private packages.",
-      recommended: true
-    },
-    hasSuggestions: false,
-    messages: {
-      invalidWorkspaceProtocolUsage: "The workspace protocol can not be used in public packages."
-    }
-  },
-  create: function create(context) {
-    var fileName = context.getFilename();
-    return {
-      ObjectExpression: function ObjectExpression(node) {
-        if (!fileName.endsWith('package.json') || node.type !== 'ObjectExpression') {
-          return;
-        }
-
-        // Exit early if we are linting a private package
-        var isPrivatePackage = getObjectPropertyAsLiteral(node, 'private') === true;
-        if (isPrivatePackage) {
-          return;
-        }
-
-        // Check if the workspace protocol is used in either dependencies or devDependencies
-        var isWorkspaceProtocolused = checkIsWorkspaceProtocolUsed(node);
-        if (!isWorkspaceProtocolused) {
-          return;
-        }
-        return context.report({
-          node: node,
-          messageId: 'invalidWorkspaceProtocolUsage'
-        });
-      }
-    };
-  }
-};
-export default rule;

package/src/rules/ensure-valid-workspace-protocol-usage/index.ts

@@ -1,67 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-import type { Rule } from 'eslint';
-import type { ObjectExpression } from 'estree';
-import { getObjectPropertyAsObject, getObjectPropertyAsLiteral } from '../util/handle-ast-object';
-
-const workspaceProtocolRegex = /^workspace:[\^~\*]$/;
-
-/**
- * Checks if the workspace protocol is used in either dependencies or devDependencies
- */
-function checkIsWorkspaceProtocolUsed(node: ObjectExpression) {
-	const dependencies = getObjectPropertyAsObject(node, 'dependencies');
-	const devDependencies = getObjectPropertyAsObject(node, 'devDependencies');
-	return [dependencies, devDependencies].some((obj) => {
-		return (
-			obj !== null &&
-			obj.properties.some((p) => {
-				if (p.type === 'Property' && p.value.type === 'Literal') {
-					return typeof p.value.value === 'string' && workspaceProtocolRegex.test(p.value.value);
-				}
-			})
-		);
-	});
-}
-
-const rule: Rule.RuleModule = {
-	meta: {
-		type: 'problem',
-		docs: {
-			description: `Ensures the workspace protocol is only used in private packages.`,
-			recommended: true,
-		},
-		hasSuggestions: false,
-		messages: {
-			invalidWorkspaceProtocolUsage: `The workspace protocol can not be used in public packages.`,
-		},
-	},
-	create(context) {
-		const fileName = context.getFilename();
-		return {
-			ObjectExpression: (node: Rule.Node) => {
-				if (!fileName.endsWith('package.json') || node.type !== 'ObjectExpression') {
-					return;
-				}
-
-				// Exit early if we are linting a private package
-				const isPrivatePackage = getObjectPropertyAsLiteral(node, 'private') === true;
-				if (isPrivatePackage) {
-					return;
-				}
-
-				// Check if the workspace protocol is used in either dependencies or devDependencies
-				const isWorkspaceProtocolused = checkIsWorkspaceProtocolUsed(node);
-				if (!isWorkspaceProtocolused) {
-					return;
-				}
-
-				return context.report({
-					node,
-					messageId: 'invalidWorkspaceProtocolUsage',
-				});
-			},
-		};
-	},
-};
-
-export default rule;