@atlaskit/eslint-plugin-platform 2.6.0 → 2.7.1

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

@@ -6,7 +6,6 @@ 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-platform-yarn-protocol-usage': import("eslint").Rule.RuleModule;
     'ensure-valid-bin-values': import("eslint").Rule.RuleModule;
     'ensure-no-private-dependencies': import("eslint").Rule.RuleModule;
     'expand-border-shorthand': import("eslint").Rule.RuleModule;
@@ -29,6 +28,7 @@ declare const rules: {
     'use-recommended-utils': import("eslint").Rule.RuleModule;
     'no-sparse-checkout': import("eslint").Rule.RuleModule;
     'no-direct-document-usage': import("eslint").Rule.RuleModule;
+    'no-set-immediate': import("eslint").Rule.RuleModule;
 };
 declare const plugin: {
     meta: {
@@ -42,7 +42,6 @@ declare const plugin: {
         '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-platform-yarn-protocol-usage': import("eslint").Rule.RuleModule;
         'ensure-valid-bin-values': import("eslint").Rule.RuleModule;
         'ensure-no-private-dependencies': import("eslint").Rule.RuleModule;
         'expand-border-shorthand': import("eslint").Rule.RuleModule;
@@ -65,6 +64,7 @@ declare const plugin: {
         'use-recommended-utils': import("eslint").Rule.RuleModule;
         'no-sparse-checkout': import("eslint").Rule.RuleModule;
         'no-direct-document-usage': import("eslint").Rule.RuleModule;
+        'no-set-immediate': import("eslint").Rule.RuleModule;
     };
     configs: {
         recommended: {
@@ -90,6 +90,7 @@ declare const plugin: {
                 '@atlaskit/platform/ensure-atlassian-team': "error";
                 '@atlaskit/platform/no-module-level-eval-nav4': "error";
                 '@atlaskit/platform/no-direct-document-usage': "warn";
+                '@atlaskit/platform/no-set-immediate': "error";
                 '@atlaskit/platform/expand-border-shorthand': "error";
                 '@atlaskit/platform/expand-background-shorthand': "error";
                 '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -129,6 +130,7 @@ declare const plugin: {
                 '@atlaskit/platform/ensure-atlassian-team': "error";
                 '@atlaskit/platform/no-module-level-eval-nav4': "error";
                 '@atlaskit/platform/no-direct-document-usage': "warn";
+                '@atlaskit/platform/no-set-immediate': "error";
                 '@atlaskit/platform/expand-border-shorthand': "error";
                 '@atlaskit/platform/expand-background-shorthand': "error";
                 '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -152,6 +154,7 @@ declare const plugin: {
                 '@atlaskit/platform/ensure-atlassian-team': "error";
                 '@atlaskit/platform/no-module-level-eval-nav4': "error";
                 '@atlaskit/platform/no-direct-document-usage': "warn";
+                '@atlaskit/platform/no-set-immediate': "error";
                 '@atlaskit/platform/expand-border-shorthand': "error";
                 '@atlaskit/platform/expand-background-shorthand': "error";
                 '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -178,6 +181,7 @@ declare const plugin: {
                 '@atlaskit/platform/ensure-atlassian-team': "error";
                 '@atlaskit/platform/no-module-level-eval-nav4': "error";
                 '@atlaskit/platform/no-direct-document-usage': "warn";
+                '@atlaskit/platform/no-set-immediate': "error";
                 '@atlaskit/platform/expand-border-shorthand': "error";
                 '@atlaskit/platform/expand-background-shorthand': "error";
                 '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -193,8 +197,8 @@ declare const plugin: {
         };
     };
     processors: {
-        'package-json-processor': Linter.Processor<string | Linter.ProcessorFile>;
-        'package-json-processor-for-flat-config': Linter.Processor<string | Linter.ProcessorFile>;
+        'package-json-processor': Linter.Processor;
+        'package-json-processor-for-flat-config': Linter.Processor;
     };
 };
 declare const configs: {
@@ -221,6 +225,7 @@ declare const configs: {
             '@atlaskit/platform/ensure-atlassian-team': "error";
             '@atlaskit/platform/no-module-level-eval-nav4': "error";
             '@atlaskit/platform/no-direct-document-usage': "warn";
+            '@atlaskit/platform/no-set-immediate': "error";
             '@atlaskit/platform/expand-border-shorthand': "error";
             '@atlaskit/platform/expand-background-shorthand': "error";
             '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -260,6 +265,7 @@ declare const configs: {
             '@atlaskit/platform/ensure-atlassian-team': "error";
             '@atlaskit/platform/no-module-level-eval-nav4': "error";
             '@atlaskit/platform/no-direct-document-usage': "warn";
+            '@atlaskit/platform/no-set-immediate': "error";
             '@atlaskit/platform/expand-border-shorthand': "error";
             '@atlaskit/platform/expand-background-shorthand': "error";
             '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -283,6 +289,7 @@ declare const configs: {
             '@atlaskit/platform/ensure-atlassian-team': "error";
             '@atlaskit/platform/no-module-level-eval-nav4': "error";
             '@atlaskit/platform/no-direct-document-usage': "warn";
+            '@atlaskit/platform/no-set-immediate': "error";
             '@atlaskit/platform/expand-border-shorthand': "error";
             '@atlaskit/platform/expand-background-shorthand': "error";
             '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -309,6 +316,7 @@ declare const configs: {
             '@atlaskit/platform/ensure-atlassian-team': "error";
             '@atlaskit/platform/no-module-level-eval-nav4': "error";
             '@atlaskit/platform/no-direct-document-usage': "warn";
+            '@atlaskit/platform/no-set-immediate': "error";
             '@atlaskit/platform/expand-border-shorthand': "error";
             '@atlaskit/platform/expand-background-shorthand': "error";
             '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -324,8 +332,8 @@ declare const configs: {
     };
 };
 declare const processors: {
-    'package-json-processor': Linter.Processor<string | Linter.ProcessorFile>;
-    'package-json-processor-for-flat-config': Linter.Processor<string | Linter.ProcessorFile>;
+    'package-json-processor': Linter.Processor;
+    'package-json-processor-for-flat-config': Linter.Processor;
 };
 export { configs, plugin, processors, rules };
 export default plugin;

package/dist/types-ts4.5/rules/util/handle-ast-object.d.ts

@@ -1,3 +1,3 @@
 import type { ObjectExpression, SimpleLiteral, RegExpLiteral, BigIntLiteral } from 'estree';
-export declare const getObjectPropertyAsLiteral: (node: ObjectExpression, property: string) => SimpleLiteral['value'] | RegExpLiteral['value'] | BigIntLiteral['value'];
+export declare const getObjectPropertyAsLiteral: (node: ObjectExpression, property: string) => SimpleLiteral["value"] | RegExpLiteral["value"] | BigIntLiteral["value"];
 export declare const getObjectPropertyAsObject: (node: ObjectExpression, property: string) => ObjectExpression | null;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@atlaskit/eslint-plugin-platform",
 	"description": "The essential plugin for use with Atlassian frontend platform tools",
-	"version": "2.6.0",
+	"version": "2.7.1",
 	"author": "Atlassian Pty Ltd",
 	"atlassian": {
 		"team": "Build Infra",
@@ -46,7 +46,7 @@
 		"@types/eslint": "^8.56.6",
 		"eslint": "^8.57.0",
 		"find-up": "^4 || ^5",
-		"outdent": "^0.5.0"
+		"outdent": "^0.7.1"
 	},
 	"peerDependencies": {
 		"find-up": "^4 || ^5"

package/afm-cc/tsconfig.json

@@ -1,24 +0,0 @@
-{
-    "extends": "../../../../tsconfig.entry-points.confluence.json",
-    "compilerOptions": {
-        "target": "es5",
-        "composite": true,
-        "outDir": "../../../../../confluence/tsDist/@atlaskit__eslint-plugin-platform",
-        "rootDir": "../"
-    },
-    "include": [
-        "../src/**/*.ts",
-        "../src/**/*.tsx"
-    ],
-    "exclude": [
-        "../src/**/__tests__/*",
-        "../__tests__/*",
-        "../src/**/*.test.*",
-        "../src/**/test.*"
-    ],
-    "references": [
-        {
-            "path": "../../../design-system/eslint-utils/afm-cc/tsconfig.json"
-        }
-    ]
-}

package/afm-jira/tsconfig.json

@@ -1,24 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.jira.json",
-	"compilerOptions": {
-		"target": "es5",
-		"outDir": "../../../../../tsDist/@atlaskit__eslint-plugin-platform/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*"
-	],
-	"references": [
-		{
-			"path": "../../../design-system/eslint-utils/afm-jira/tsconfig.json"
-		}
-	]
-}

package/build/tsconfig.json

@@ -1,17 +0,0 @@
-{
-  "extends": "../tsconfig",
-  "compilerOptions": {
-    "target": "es5",
-    "paths": {}
-  },
-  "include": [
-    "../src/**/*.ts",
-    "../src/**/*.tsx"
-  ],
-  "exclude": [
-    "../src/**/__tests__/*",
-    "../__tests__/*",
-    "../src/**/*.test.*",
-    "../src/**/test.*"
-  ]
-}

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

@@ -1,79 +0,0 @@
-"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 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');
-  var peerDependencies = (0, _handleAstObject.getObjectPropertyAsObject)(node, 'peerDependencies');
-  for (var _i = 0, _arr = [dependencies, devDependencies, peerDependencies]; _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 (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 Used. To resolve this error, please use the 'workspace:*' protocol instead.",
-      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'
-          });
-        }
-      }
-    };
-  }
-};
-var _default = exports.default = rule;

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

@@ -1,62 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-
-import { getObjectPropertyAsObject } from '../util/handle-ast-object';
-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');
-  const peerDependencies = getObjectPropertyAsObject(node, 'peerDependencies');
-  for (const obj of [dependencies, devDependencies, peerDependencies]) {
-    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 (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 Used. To resolve this error, please use the 'workspace:*' protocol instead.`,
-      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'
-          });
-        }
-      }
-    };
-  }
-};
-export default rule;

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

@@ -1,75 +0,0 @@
-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 } from '../util/handle-ast-object';
-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');
-  var peerDependencies = getObjectPropertyAsObject(node, 'peerDependencies');
-  for (var _i = 0, _arr = [dependencies, devDependencies, peerDependencies]; _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 (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 Used. To resolve this error, please use the 'workspace:*' protocol instead.",
-      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'
-          });
-        }
-      }
-    };
-  }
-};
-export default rule;

package/src/__tests__/utils/_tester.tsx

@@ -1,26 +0,0 @@
-/* eslint-disable @repo/internal/fs/filename-pattern-match */
-/* eslint-disable no-undef */
-import { RuleTester } from 'eslint';
-
-(RuleTester as any).describe = (text: string, method: Function) => {
-	const origHasAssertions = expect.hasAssertions;
-	describe(text, () => {
-		beforeAll(() => {
-			// Stub out expect.hasAssertions beforeEach from jest-presetup.js
-			expect.hasAssertions = () => {};
-		});
-		afterAll(() => {
-			expect.hasAssertions = origHasAssertions;
-		});
-
-		method();
-	});
-};
-
-export const tester = new RuleTester({
-	parser: require.resolve('@babel/eslint-parser'),
-	parserOptions: {
-		ecmaVersion: 6,
-		sourceType: 'module',
-	},
-});