@atlaskit/eslint-plugin-design-system 10.9.0 → 10.10.0

package/dist/esm/rules/no-custom-icons/checks/is-from-import-source.js

@@ -0,0 +1,36 @@
+import { isImportedJSXElement } from './is-imported-jsx-element';
+export function createIsFromImportSourceFor() {
+  for (var _len = arguments.length, importSources = new Array(_len), _key = 0; _key < _len; _key++) {
+    importSources[_key] = arguments[_key];
+  }
+  var literalImportSources = importSources.filter(function (s) {
+    return typeof s === 'string';
+  });
+  var matchImportSources = importSources.filter(function (s) {
+    return s instanceof RegExp;
+  });
+  var varImportSourceMap = new Map();
+  function isFromImportSource(node) {
+    return isImportedJSXElement(node) && varImportSourceMap.has(node.openingElement.name.name);
+  }
+  isFromImportSource.importDeclarationHook = function (node) {
+    var source = node.source.value;
+    if (typeof source !== 'string' || !(literalImportSources.includes(source) || matchImportSources.some(function (r) {
+      return r.test(source);
+    }))) {
+      return;
+    }
+    node.specifiers.filter(function (spec) {
+      return ['ImportSpecifier', 'ImportDefaultSpecifier'].includes(spec.type);
+    }).forEach(function (spec) {
+      return varImportSourceMap.set(spec.local.name, source);
+    });
+  };
+  isFromImportSource.getImportSource = function (node) {
+    if (!isFromImportSource(node)) {
+      throw new Error('Node is not an imported JSX element');
+    }
+    return varImportSourceMap.get(node.openingElement.name.name);
+  };
+  return isFromImportSource;
+}

package/dist/esm/rules/no-custom-icons/checks/is-imported-jsx-element.js

@@ -0,0 +1,4 @@
+import { isNodeOfType } from 'eslint-codemod-utils';
+export function isImportedJSXElement(node) {
+  return isNodeOfType(node, 'JSXElement') && isNodeOfType(node.openingElement.name, 'JSXIdentifier');
+}

package/dist/esm/rules/no-custom-icons/index.js

@@ -0,0 +1,61 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+
+import { createLintRule } from '../utils/create-rule';
+import { errorBoundary } from '../utils/error-boundary';
+import { hasProp } from './checks/has-prop';
+import { createIsFromImportSourceFor } from './checks/is-from-import-source';
+var rule = createLintRule({
+  meta: {
+    name: 'no-custom-icons',
+    type: 'problem',
+    docs: {
+      description: 'Enforces custom glyph icons are used.',
+      recommended: false,
+      severity: 'warn'
+    },
+    schema: [{
+      type: 'object',
+      properties: {
+        centralLocation: {
+          type: 'string'
+        },
+        failSilently: {
+          type: 'boolean'
+        }
+      },
+      additionalProperties: false
+    }],
+    messages: {
+      noCustomIcons: "Custom icons from {{importSource}} are no longer supported. Migrate to an icon from '@atlaskit/(icon-labs|icon/core|icon/utility)'{{locationMessage}}.\n[Migration guide](https://hello.atlassian.net/wiki/spaces/DST/pages/3748692796/New+ADS+iconography+-+Code+migration+guide)."
+    }
+  },
+  create: function create(context) {
+    var _context$options$;
+    var isIconBase = createIsFromImportSourceFor('@atlaskit/icon', '@atlaskit/icon/base');
+    var _ref = (_context$options$ = context.options[0]) !== null && _context$options$ !== void 0 ? _context$options$ : {},
+      _ref$centralLocation = _ref.centralLocation,
+      centralLocation = _ref$centralLocation === void 0 ? '' : _ref$centralLocation,
+      _ref$failSilently = _ref.failSilently,
+      failSilently = _ref$failSilently === void 0 ? false : _ref$failSilently;
+    var locationMessage = centralLocation ? " or move the icon to '".concat(centralLocation, "'") : '';
+    return errorBoundary({
+      JSXElement: function JSXElement(node) {
+        var _isIconBase$getImport;
+        if (!isIconBase(node) || !hasProp(node, 'glyph')) {
+          return;
+        }
+        var importSource = (_isIconBase$getImport = isIconBase.getImportSource(node)) !== null && _isIconBase$getImport !== void 0 ? _isIconBase$getImport : '';
+        context.report({
+          node: node.openingElement,
+          messageId: 'noCustomIcons',
+          data: {
+            importSource: importSource,
+            locationMessage: locationMessage
+          }
+        });
+      },
+      ImportDeclaration: isIconBase.importDeclarationHook
+    }, failSilently);
+  }
+});
+export default rule;

package/dist/esm/rules/no-legacy-icons/index.js

@@ -54,95 +54,23 @@ var rule = createLintRule({
       checkJSXElement = _createChecks.checkJSXElement,
       checkCallExpression = _createChecks.checkCallExpression,
       throwErrors = _createChecks.throwErrors;
-    return {
+    return errorBoundary({
       // Track imports of relevant components
-      ImportDeclaration: function ImportDeclaration(node) {
-        errorBoundary(function () {
-          return checkImportDeclarations(node);
-        }, {
-          config: {
-            failSilently: failSilently
-          }
-        });
-      },
+      ImportDeclaration: checkImportDeclarations,
       // Keep track of the relevant variable declarations and renames
-      VariableDeclaration: function VariableDeclaration(node) {
-        errorBoundary(function () {
-          return checkVariableDeclarations(node);
-        }, {
-          config: {
-            failSilently: failSilently
-          }
-        });
-      },
+      VariableDeclaration: checkVariableDeclarations,
       // Case: default re-exports. Can't be auto-migrated
-      ExportDefaultDeclaration: function ExportDefaultDeclaration(node) {
-        errorBoundary(function () {
-          return checkExportDefaultDeclaration(node);
-        }, {
-          config: {
-            failSilently: failSilently
-          }
-        });
-      },
-      ExportNamedDeclaration: function ExportNamedDeclaration(node) {
-        errorBoundary(function () {
-          return checkExportNamedVariables(node);
-        }, {
-          config: {
-            failSilently: failSilently
-          }
-        });
-      },
+      ExportDefaultDeclaration: checkExportDefaultDeclaration,
+      ExportNamedDeclaration: checkExportNamedVariables,
       // Legacy icons found in arrays/objects
-      'ObjectExpression > Property > Identifier, ArrayExpression > Identifier ': function ObjectExpressionPropertyIdentifierArrayExpressionIdentifier(node) {
-        errorBoundary(function () {
-          return checkArrayOrMap(node);
-        }, {
-          config: {
-            failSilently: failSilently
-          }
-        });
-      },
+      'ObjectExpression > Property > Identifier, ArrayExpression > Identifier ': checkArrayOrMap,
       // Legacy icons passed in via props, as JSX identifier (i.e. icon={AddIcon})
-      'JSXOpeningElement > JSXAttribute > JSXExpressionContainer > Identifier': function JSXOpeningElementJSXAttributeJSXExpressionContainerIdentifier(node) {
-        errorBoundary(function () {
-          return checkIconAsProp(node);
-        }, {
-          config: {
-            failSilently: failSilently
-          }
-        });
-      },
-      JSXElement: function JSXElement(node) {
-        errorBoundary(function () {
-          return checkJSXElement(node);
-        }, {
-          config: {
-            failSilently: failSilently
-          }
-        });
-      },
+      'JSXOpeningElement > JSXAttribute > JSXExpressionContainer > Identifier': checkIconAsProp,
+      JSXElement: checkJSXElement,
       // Icons called as an argument of a function (i.e. icon={DefaultIcon(AddIcon)})
-      CallExpression: function CallExpression(node) {
-        errorBoundary(function () {
-          return checkCallExpression(node);
-        }, {
-          config: {
-            failSilently: failSilently
-          }
-        });
-      },
-      'Program:exit': function ProgramExit() {
-        errorBoundary(function () {
-          return throwErrors();
-        }, {
-          config: {
-            failSilently: failSilently
-          }
-        });
-      }
-    };
+      CallExpression: checkCallExpression,
+      'Program:exit': throwErrors
+    }, failSilently);
   }
 });
 export default rule;

package/dist/esm/rules/use-tokens-typography/index.js

@@ -6,16 +6,12 @@ var create = function create(context) {
   var config = getConfig(context.options[0]);
   return {
     // const styles = css({ fontSize: '14px, ... }), styled.div({ fontSize: 14, ... })
-    ObjectExpression: function ObjectExpression(node) {
-      return errorBoundary(function () {
-        return StyleObject.lint(node, {
-          context: context,
-          config: config
-        });
-      }, {
+    ObjectExpression: errorBoundary(function (node) {
+      return StyleObject.lint(node, {
+        context: context,
         config: config
       });
-    }
+    }, config)
   };
 };
 var rule = createLintRule({

package/dist/esm/rules/utils/error-boundary.js

@@ -1,3 +1,11 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _typeof from "@babel/runtime/helpers/typeof";
+// eslint-disable-next-line import/no-extraneous-dependencies
+
+// Need to intersect type RuleListener with a generic function to allow use of Parameters<...> to be used
+
+// Allow config to be to be easily passed from rules
+
 /**
  * ESLint rules should NEVER throw exceptions, because that breaks the VSCode ESLint server
  * (and probably the IntelliJ one too), which causes linting to fail in a file.
@@ -5,14 +13,52 @@
  * It also breaks CI, which was the reason this error boundary was added. It's a final
  * catch all.
  */
-export var errorBoundary = function errorBoundary(func, _ref) {
-  var config = _ref.config;
-  try {
-    func();
-  } catch (err) {
-    if (!config.failSilently) {
-      // eslint-disable-next-line no-console
-      console.warn(err);
-    }
+export function errorBoundary(ruleOrRules) {
+  var config = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+  var failSilently = failSilentlyFromConfig(config);
+  if (isSingleRuleListener(ruleOrRules)) {
+    return wrapSingleRuleListener(ruleOrRules, failSilently);
+  }
+  return wrapRuleListener(ruleOrRules, failSilently);
+}
+function isSingleRuleListener(rule) {
+  return typeof rule === 'function';
+}
+function failSilentlyFromConfig(c) {
+  switch (_typeof(c)) {
+    case 'undefined':
+      return false;
+    case 'boolean':
+      return c;
+    case 'object':
+      if ('failSilently' in c) {
+        var _c$failSilently;
+        return (_c$failSilently = c.failSilently) !== null && _c$failSilently !== void 0 ? _c$failSilently : false;
+      } else if ('config' in c) {
+        var _c$config$failSilentl;
+        return (_c$config$failSilentl = c.config.failSilently) !== null && _c$config$failSilentl !== void 0 ? _c$config$failSilentl : false;
+      }
+      return false;
+    default:
+      throw new Error('Invalid config');
   }
-};
+}
+function wrapSingleRuleListener(rule, failSilently) {
+  return function () {
+    try {
+      rule.apply(void 0, arguments);
+    } catch (err) {
+      if (!failSilently) {
+        // eslint-disable-next-line no-console
+        console.warn(err);
+      }
+    }
+  };
+}
+function wrapRuleListener(ruleListener, failSilently) {
+  return Object.entries(ruleListener).reduce(function (wrappedRuleListener, e) {
+    var ruleName = e[0];
+    var rule = e[1];
+    return Object.assign(wrappedRuleListener, _defineProperty({}, ruleName, wrapSingleRuleListener(rule, failSilently)));
+  }, {});
+}

package/dist/types/index.codegen.d.ts

@@ -9,6 +9,7 @@ export declare const configs: {
             '@atlaskit/design-system/icon-label': string;
             '@atlaskit/design-system/no-banned-imports': string;
             '@atlaskit/design-system/no-css-tagged-template-expression': string;
+            '@atlaskit/design-system/no-custom-icons': string;
             '@atlaskit/design-system/no-deprecated-apis': string;
             '@atlaskit/design-system/no-deprecated-design-token-usage': string;
             '@atlaskit/design-system/no-deprecated-imports': string;

package/dist/types/presets/all.codegen.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::9bb5329713677543f16019954484ae2f>>
+ * @codegen <<SignedSource::ab43b6e1a867d07b9a27eae78d48834a>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -12,6 +12,7 @@ declare const _default: {
         '@atlaskit/design-system/icon-label': string;
         '@atlaskit/design-system/no-banned-imports': string;
         '@atlaskit/design-system/no-css-tagged-template-expression': string;
+        '@atlaskit/design-system/no-custom-icons': string;
         '@atlaskit/design-system/no-deprecated-apis': string;
         '@atlaskit/design-system/no-deprecated-design-token-usage': string;
         '@atlaskit/design-system/no-deprecated-imports': string;

package/dist/types/rules/index.codegen.d.ts

@@ -5,6 +5,7 @@ declare const _default: {
     'icon-label': import("eslint").Rule.RuleModule;
     'no-banned-imports': import("eslint").Rule.RuleModule;
     'no-css-tagged-template-expression': import("eslint").Rule.RuleModule;
+    'no-custom-icons': import("eslint").Rule.RuleModule;
     'no-deprecated-apis': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<string, [{
         deprecatedConfig: import("./utils/types").DeprecatedConfig;
     }], import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;

package/dist/types/rules/no-custom-icons/checks/has-prop.d.ts

@@ -0,0 +1,2 @@
+import { type JSXElement } from 'eslint-codemod-utils';
+export declare function hasProp(node: JSXElement, propName: string): boolean;

package/dist/types/rules/no-custom-icons/checks/is-from-import-source.d.ts

@@ -0,0 +1,8 @@
+import type { Rule } from 'eslint';
+import type { ImportDeclaration } from 'eslint-codemod-utils';
+import { type ImportedJSXElement } from './is-imported-jsx-element';
+export declare function createIsFromImportSourceFor(...importSources: (string | RegExp)[]): {
+    (node: Rule.Node): node is ImportedJSXElement;
+    importDeclarationHook(node: ImportDeclaration): void;
+    getImportSource(node: Rule.Node): string;
+};

package/dist/types/rules/no-custom-icons/checks/is-imported-jsx-element.d.ts

@@ -0,0 +1,8 @@
+import type { Rule } from 'eslint';
+import { type JSXElement, type JSXIdentifier, type JSXOpeningElement } from 'eslint-codemod-utils';
+export type ImportedJSXElement = JSXElement & Rule.NodeParentExtension & {
+    openingElement: JSXOpeningElement & {
+        name: JSXIdentifier;
+    };
+};
+export declare function isImportedJSXElement(node: Rule.Node): node is ImportedJSXElement;

package/dist/types/rules/no-custom-icons/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-legacy-icons/index.d.ts

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

package/dist/types/rules/utils/error-boundary.d.ts

@@ -1,6 +1,11 @@
-type RuleConfig = {
+import type { Rule } from 'eslint';
+type SingleRuleListener = Rule.RuleListener[keyof Rule.RuleListener] & ((...args: any[]) => void);
+type ErrorBoundaryConfig = undefined | boolean | {
     failSilently?: boolean;
-    shouldEnforceFallbacks?: boolean;
+} | {
+    config: {
+        failSilently?: boolean;
+    };
 };
 /**
  * ESLint rules should NEVER throw exceptions, because that breaks the VSCode ESLint server
@@ -9,7 +14,5 @@ type RuleConfig = {
  * It also breaks CI, which was the reason this error boundary was added. It's a final
  * catch all.
  */
-export declare const errorBoundary: (func: () => void, { config }: {
-    config: RuleConfig;
-}) => void;
+export declare function errorBoundary<R extends SingleRuleListener | Rule.RuleListener>(ruleOrRules: R, config?: ErrorBoundaryConfig): R;
 export {};

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

@@ -9,6 +9,7 @@ export declare const configs: {
             '@atlaskit/design-system/icon-label': string;
             '@atlaskit/design-system/no-banned-imports': string;
             '@atlaskit/design-system/no-css-tagged-template-expression': string;
+            '@atlaskit/design-system/no-custom-icons': string;
             '@atlaskit/design-system/no-deprecated-apis': string;
             '@atlaskit/design-system/no-deprecated-design-token-usage': string;
             '@atlaskit/design-system/no-deprecated-imports': string;

package/dist/types-ts4.5/presets/all.codegen.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::9bb5329713677543f16019954484ae2f>>
+ * @codegen <<SignedSource::ab43b6e1a867d07b9a27eae78d48834a>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -12,6 +12,7 @@ declare const _default: {
         '@atlaskit/design-system/icon-label': string;
         '@atlaskit/design-system/no-banned-imports': string;
         '@atlaskit/design-system/no-css-tagged-template-expression': string;
+        '@atlaskit/design-system/no-custom-icons': string;
         '@atlaskit/design-system/no-deprecated-apis': string;
         '@atlaskit/design-system/no-deprecated-design-token-usage': string;
         '@atlaskit/design-system/no-deprecated-imports': string;

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

@@ -5,6 +5,7 @@ declare const _default: {
     'icon-label': import("eslint").Rule.RuleModule;
     'no-banned-imports': import("eslint").Rule.RuleModule;
     'no-css-tagged-template-expression': import("eslint").Rule.RuleModule;
+    'no-custom-icons': import("eslint").Rule.RuleModule;
     'no-deprecated-apis': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<string, [
         {
             deprecatedConfig: import("./utils/types").DeprecatedConfig;

package/dist/types-ts4.5/rules/no-custom-icons/checks/has-prop.d.ts

@@ -0,0 +1,2 @@
+import { type JSXElement } from 'eslint-codemod-utils';
+export declare function hasProp(node: JSXElement, propName: string): boolean;

package/dist/types-ts4.5/rules/no-custom-icons/checks/is-from-import-source.d.ts

@@ -0,0 +1,8 @@
+import type { Rule } from 'eslint';
+import type { ImportDeclaration } from 'eslint-codemod-utils';
+import { type ImportedJSXElement } from './is-imported-jsx-element';
+export declare function createIsFromImportSourceFor(...importSources: (string | RegExp)[]): {
+    (node: Rule.Node): node is ImportedJSXElement;
+    importDeclarationHook(node: ImportDeclaration): void;
+    getImportSource(node: Rule.Node): string;
+};

package/dist/types-ts4.5/rules/no-custom-icons/checks/is-imported-jsx-element.d.ts

@@ -0,0 +1,8 @@
+import type { Rule } from 'eslint';
+import { type JSXElement, type JSXIdentifier, type JSXOpeningElement } from 'eslint-codemod-utils';
+export type ImportedJSXElement = JSXElement & Rule.NodeParentExtension & {
+    openingElement: JSXOpeningElement & {
+        name: JSXIdentifier;
+    };
+};
+export declare function isImportedJSXElement(node: Rule.Node): node is ImportedJSXElement;

package/dist/types-ts4.5/rules/no-custom-icons/index.d.ts

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

package/dist/types-ts4.5/rules/no-legacy-icons/index.d.ts

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

package/dist/types-ts4.5/rules/utils/error-boundary.d.ts

@@ -1,6 +1,11 @@
-type RuleConfig = {
+import type { Rule } from 'eslint';
+type SingleRuleListener = Rule.RuleListener[keyof Rule.RuleListener] & ((...args: any[]) => void);
+type ErrorBoundaryConfig = undefined | boolean | {
     failSilently?: boolean;
-    shouldEnforceFallbacks?: boolean;
+} | {
+    config: {
+        failSilently?: boolean;
+    };
 };
 /**
  * ESLint rules should NEVER throw exceptions, because that breaks the VSCode ESLint server
@@ -9,7 +14,5 @@ type RuleConfig = {
  * It also breaks CI, which was the reason this error boundary was added. It's a final
  * catch all.
  */
-export declare const errorBoundary: (func: () => void, { config }: {
-    config: RuleConfig;
-}) => void;
+export declare function errorBoundary<R extends SingleRuleListener | Rule.RuleListener>(ruleOrRules: R, config?: ErrorBoundaryConfig): R;
 export {};

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": "10.9.0",
+	"version": "10.10.0",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
 	"publishConfig": {