@atlaskit/eslint-plugin-design-system 4.6.0 → 4.7.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/eslint-plugin-design-system
 
+## 4.7.0
+
+### Minor Changes
+
+- [`740057653f9`](https://bitbucket.org/atlassian/atlassian-frontend/commits/740057653f9) - Adds additional rule to restrict usage of banned imports from the design system.
+
 ## 4.6.0
 
 ### Minor Changes

package/dist/cjs/index.js

@@ -11,6 +11,8 @@ var _ensureDesignTokenUsage = _interopRequireDefault(require("./rules/ensure-des
 
 var _iconLabel = _interopRequireDefault(require("./rules/icon-label"));
 
+var _noBannedImports = _interopRequireDefault(require("./rules/no-banned-imports"));
+
 var _noDeprecatedApis = _interopRequireDefault(require("./rules/no-deprecated-apis"));
 
 var _noDeprecatedDesignTokenUsage = _interopRequireDefault(require("./rules/no-deprecated-design-token-usage"));
@@ -27,6 +29,7 @@ var rules = {
   'no-deprecated-apis': _noDeprecatedApis.default,
   'no-deprecated-design-token-usage': _noDeprecatedDesignTokenUsage.default,
   'no-deprecated-imports': _noDeprecatedImports.default,
+  'no-banned-imports': _noBannedImports.default,
   'no-unsafe-design-token-usage': _noUnsafeDesignTokenUsage.default,
   'use-visually-hidden': _useVisuallyHidden.default
 };
@@ -38,7 +41,19 @@ var configs = {
       '@atlaskit/design-system/icon-label': 'warn',
       '@atlaskit/design-system/no-deprecated-apis': 'warn',
       '@atlaskit/design-system/no-deprecated-imports': 'error',
-      '@atlaskit/design-system/use-visually-hidden': 'error'
+      '@atlaskit/design-system/use-visually-hidden': 'error',
+      '@atlaskit/design-system/no-banned-imports': 'error'
+    }
+  },
+  all: {
+    plugins: ['@atlaskit/design-system'],
+    rules: {
+      '@atlaskit/design-system/icon-label': 'error',
+      '@atlaskit/design-system/no-deprecated-apis': 'error',
+      '@atlaskit/design-system/no-deprecated-imports': 'error',
+      '@atlaskit/design-system/use-visually-hidden': 'error',
+      '@atlaskit/design-system/ensure-design-token-usage': 'error',
+      '@atlaskit/design-system/no-banned-imports': 'error'
     }
   }
 };

package/dist/cjs/rules/no-banned-imports/index.js

@@ -0,0 +1,56 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _eslintCodemodUtils = require("eslint-codemod-utils");
+
+var _paths = require("./paths");
+
+var rule = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'Disallow specified modules when loaded by `import`',
+      recommended: true
+    },
+    messages: {
+      path: "The '{{importSource}}' import is restricted from being used. {{customMessage}}"
+    }
+  },
+  create: function create(context) {
+    function checkNode(node) {
+      if ((0, _eslintCodemodUtils.isNodeOfType)(node, 'ExportAllDeclaration') || (0, _eslintCodemodUtils.isNodeOfType)(node, 'ExportNamedDeclaration') || (0, _eslintCodemodUtils.isNodeOfType)(node, 'ImportDeclaration')) {
+        _paths.restrictedPaths.find(function (_ref) {
+          var _node$source, _node$source$value;
+
+          var path = _ref.path,
+              message = _ref.message;
+          var source = (_node$source = node.source) === null || _node$source === void 0 ? void 0 : (_node$source$value = _node$source.value) === null || _node$source$value === void 0 ? void 0 : _node$source$value.toString();
+
+          if (source && (source === path || source.startsWith(path))) {
+            context.report({
+              node: node,
+              messageId: 'path',
+              data: {
+                importSource: source,
+                customMessage: message
+              }
+            });
+          }
+        });
+      }
+    }
+
+    return {
+      ImportDeclaration: checkNode,
+      ExportAllDeclaration: checkNode,
+      ExportNamedDeclaration: checkNode,
+      ExportDefaultDeclaration: checkNode
+    };
+  }
+};
+var _default = rule;
+exports.default = _default;

package/dist/cjs/rules/no-banned-imports/paths.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.restrictedPaths = void 0;
+var restrictedPaths = [{
+  path: '@atlaskit/ds-lib',
+  message: "The '@atlaskit/ds-lib' library has been designed as a utility library for internal usage. It should not be consumed directly."
+}, {
+  path: '@atlaskit/ds-explorations',
+  message: "The @atlaskit/ds-explorations package is currently in an experimental state and should not be consumed directly."
+}];
+exports.restrictedPaths = restrictedPaths;

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-design-system",
-	"version": "4.6.0",
+	"version": "4.7.0",
 	"sideEffects": false
 }

package/dist/es2019/index.js

@@ -1,5 +1,6 @@
 import ensureTokenUsage from './rules/ensure-design-token-usage';
 import iconLabel from './rules/icon-label';
+import noBannedImports from './rules/no-banned-imports';
 import noDeprecatedAPIs from './rules/no-deprecated-apis';
 import noDeprecatedUsage from './rules/no-deprecated-design-token-usage';
 import noDeprecatedImports from './rules/no-deprecated-imports';
@@ -11,6 +12,7 @@ export const rules = {
   'no-deprecated-apis': noDeprecatedAPIs,
   'no-deprecated-design-token-usage': noDeprecatedUsage,
   'no-deprecated-imports': noDeprecatedImports,
+  'no-banned-imports': noBannedImports,
   'no-unsafe-design-token-usage': noUnsafeUsage,
   'use-visually-hidden': useVisuallyHidden
 };
@@ -21,7 +23,19 @@ export const configs = {
       '@atlaskit/design-system/icon-label': 'warn',
       '@atlaskit/design-system/no-deprecated-apis': 'warn',
       '@atlaskit/design-system/no-deprecated-imports': 'error',
-      '@atlaskit/design-system/use-visually-hidden': 'error'
+      '@atlaskit/design-system/use-visually-hidden': 'error',
+      '@atlaskit/design-system/no-banned-imports': 'error'
+    }
+  },
+  all: {
+    plugins: ['@atlaskit/design-system'],
+    rules: {
+      '@atlaskit/design-system/icon-label': 'error',
+      '@atlaskit/design-system/no-deprecated-apis': 'error',
+      '@atlaskit/design-system/no-deprecated-imports': 'error',
+      '@atlaskit/design-system/use-visually-hidden': 'error',
+      '@atlaskit/design-system/ensure-design-token-usage': 'error',
+      '@atlaskit/design-system/no-banned-imports': 'error'
     }
   }
 };

package/dist/es2019/rules/no-banned-imports/index.js

@@ -0,0 +1,49 @@
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { restrictedPaths } from './paths';
+const rule = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'Disallow specified modules when loaded by `import`',
+      recommended: true
+    },
+    messages: {
+      path: "The '{{importSource}}' import is restricted from being used. {{customMessage}}"
+    }
+  },
+
+  create(context) {
+    function checkNode(node) {
+      if (isNodeOfType(node, 'ExportAllDeclaration') || isNodeOfType(node, 'ExportNamedDeclaration') || isNodeOfType(node, 'ImportDeclaration')) {
+        restrictedPaths.find(({
+          path,
+          message
+        }) => {
+          var _node$source, _node$source$value;
+
+          const source = (_node$source = node.source) === null || _node$source === void 0 ? void 0 : (_node$source$value = _node$source.value) === null || _node$source$value === void 0 ? void 0 : _node$source$value.toString();
+
+          if (source && (source === path || source.startsWith(path))) {
+            context.report({
+              node,
+              messageId: 'path',
+              data: {
+                importSource: source,
+                customMessage: message
+              }
+            });
+          }
+        });
+      }
+    }
+
+    return {
+      ImportDeclaration: checkNode,
+      ExportAllDeclaration: checkNode,
+      ExportNamedDeclaration: checkNode,
+      ExportDefaultDeclaration: checkNode
+    };
+  }
+
+};
+export default rule;

package/dist/es2019/rules/no-banned-imports/paths.js

@@ -0,0 +1,7 @@
+export const restrictedPaths = [{
+  path: '@atlaskit/ds-lib',
+  message: `The '@atlaskit/ds-lib' library has been designed as a utility library for internal usage. It should not be consumed directly.`
+}, {
+  path: '@atlaskit/ds-explorations',
+  message: `The @atlaskit/ds-explorations package is currently in an experimental state and should not be consumed directly.`
+}];

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-design-system",
-	"version": "4.6.0",
+	"version": "4.7.0",
 	"sideEffects": false
 }

package/dist/esm/index.js

@@ -1,5 +1,6 @@
 import ensureTokenUsage from './rules/ensure-design-token-usage';
 import iconLabel from './rules/icon-label';
+import noBannedImports from './rules/no-banned-imports';
 import noDeprecatedAPIs from './rules/no-deprecated-apis';
 import noDeprecatedUsage from './rules/no-deprecated-design-token-usage';
 import noDeprecatedImports from './rules/no-deprecated-imports';
@@ -11,6 +12,7 @@ export var rules = {
   'no-deprecated-apis': noDeprecatedAPIs,
   'no-deprecated-design-token-usage': noDeprecatedUsage,
   'no-deprecated-imports': noDeprecatedImports,
+  'no-banned-imports': noBannedImports,
   'no-unsafe-design-token-usage': noUnsafeUsage,
   'use-visually-hidden': useVisuallyHidden
 };
@@ -21,7 +23,19 @@ export var configs = {
       '@atlaskit/design-system/icon-label': 'warn',
       '@atlaskit/design-system/no-deprecated-apis': 'warn',
       '@atlaskit/design-system/no-deprecated-imports': 'error',
-      '@atlaskit/design-system/use-visually-hidden': 'error'
+      '@atlaskit/design-system/use-visually-hidden': 'error',
+      '@atlaskit/design-system/no-banned-imports': 'error'
+    }
+  },
+  all: {
+    plugins: ['@atlaskit/design-system'],
+    rules: {
+      '@atlaskit/design-system/icon-label': 'error',
+      '@atlaskit/design-system/no-deprecated-apis': 'error',
+      '@atlaskit/design-system/no-deprecated-imports': 'error',
+      '@atlaskit/design-system/use-visually-hidden': 'error',
+      '@atlaskit/design-system/ensure-design-token-usage': 'error',
+      '@atlaskit/design-system/no-banned-imports': 'error'
     }
   }
 };

package/dist/esm/rules/no-banned-imports/index.js

@@ -0,0 +1,46 @@
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { restrictedPaths } from './paths';
+var rule = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'Disallow specified modules when loaded by `import`',
+      recommended: true
+    },
+    messages: {
+      path: "The '{{importSource}}' import is restricted from being used. {{customMessage}}"
+    }
+  },
+  create: function create(context) {
+    function checkNode(node) {
+      if (isNodeOfType(node, 'ExportAllDeclaration') || isNodeOfType(node, 'ExportNamedDeclaration') || isNodeOfType(node, 'ImportDeclaration')) {
+        restrictedPaths.find(function (_ref) {
+          var _node$source, _node$source$value;
+
+          var path = _ref.path,
+              message = _ref.message;
+          var source = (_node$source = node.source) === null || _node$source === void 0 ? void 0 : (_node$source$value = _node$source.value) === null || _node$source$value === void 0 ? void 0 : _node$source$value.toString();
+
+          if (source && (source === path || source.startsWith(path))) {
+            context.report({
+              node: node,
+              messageId: 'path',
+              data: {
+                importSource: source,
+                customMessage: message
+              }
+            });
+          }
+        });
+      }
+    }
+
+    return {
+      ImportDeclaration: checkNode,
+      ExportAllDeclaration: checkNode,
+      ExportNamedDeclaration: checkNode,
+      ExportDefaultDeclaration: checkNode
+    };
+  }
+};
+export default rule;

package/dist/esm/rules/no-banned-imports/paths.js

@@ -0,0 +1,7 @@
+export var restrictedPaths = [{
+  path: '@atlaskit/ds-lib',
+  message: "The '@atlaskit/ds-lib' library has been designed as a utility library for internal usage. It should not be consumed directly."
+}, {
+  path: '@atlaskit/ds-explorations',
+  message: "The @atlaskit/ds-explorations package is currently in an experimental state and should not be consumed directly."
+}];

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-design-system",
-	"version": "4.6.0",
+	"version": "4.7.0",
 	"sideEffects": false
 }

package/dist/types/index.d.ts

@@ -4,6 +4,7 @@ export declare const rules: {
     'no-deprecated-apis': import("eslint").Rule.RuleModule;
     'no-deprecated-design-token-usage': import("eslint").Rule.RuleModule;
     'no-deprecated-imports': import("eslint").Rule.RuleModule;
+    'no-banned-imports': import("eslint").Rule.RuleModule;
     'no-unsafe-design-token-usage': import("eslint").Rule.RuleModule;
     'use-visually-hidden': import("eslint").Rule.RuleModule;
 };
@@ -15,6 +16,18 @@ export declare const configs: {
             '@atlaskit/design-system/no-deprecated-apis': string;
             '@atlaskit/design-system/no-deprecated-imports': string;
             '@atlaskit/design-system/use-visually-hidden': string;
+            '@atlaskit/design-system/no-banned-imports': string;
+        };
+    };
+    all: {
+        plugins: string[];
+        rules: {
+            '@atlaskit/design-system/icon-label': string;
+            '@atlaskit/design-system/no-deprecated-apis': string;
+            '@atlaskit/design-system/no-deprecated-imports': string;
+            '@atlaskit/design-system/use-visually-hidden': string;
+            '@atlaskit/design-system/ensure-design-token-usage': string;
+            '@atlaskit/design-system/no-banned-imports': string;
         };
     };
 };

package/dist/types/rules/no-banned-imports/index.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

package/dist/types/rules/no-banned-imports/paths.d.ts

@@ -0,0 +1,4 @@
+export declare const restrictedPaths: {
+    path: string;
+    message: string;
+}[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@atlaskit/eslint-plugin-design-system",
   "description": "The essential plugin for use with the Atlassian Design System.",
-  "version": "4.6.0",
+  "version": "4.7.0",
   "author": "Atlassian Pty Ltd",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -31,7 +31,7 @@
     "eslint-codemod-utils": "^1.3.2"
   },
   "devDependencies": {
-    "@atlaskit/ds-lib": "^1.4.1",
+    "@atlaskit/ds-lib": "^2.0.0",
     "@atlaskit/theme": "^12.0.2",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@emotion/core": "^10.0.9",
@@ -48,6 +48,7 @@
       "circular-dependencies": "file-and-folder-level"
     },
     "@repo/internal": {
+      "dom-events": "use-bind-event-listener",
       "design-system": "v1",
       "deprecation": "no-deprecated-imports",
       "styling": [

package/report.api.md

@@ -0,0 +1,31 @@
+## API Report File for "@atlaskit/eslint-plugin-design-system"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import { Rule } from 'eslint';
+
+export declare const configs: {
+  recommended: {
+    plugins: string[];
+    rules: {
+      '@atlaskit/design-system/icon-label': string;
+      '@atlaskit/design-system/no-deprecated-apis': string;
+      '@atlaskit/design-system/no-deprecated-imports': string;
+      '@atlaskit/design-system/use-visually-hidden': string;
+    };
+  };
+};
+
+export declare const rules: {
+  'ensure-design-token-usage': Rule.RuleModule;
+  'icon-label': Rule.RuleModule;
+  'no-deprecated-apis': Rule.RuleModule;
+  'no-deprecated-design-token-usage': Rule.RuleModule;
+  'no-deprecated-imports': Rule.RuleModule;
+  'no-unsafe-design-token-usage': Rule.RuleModule;
+  'use-visually-hidden': Rule.RuleModule;
+};
+
+export {};
+```