@atlaskit/eslint-plugin-design-system 10.25.0 → 10.26.0

package/dist/es2019/rules/no-deprecated-imports/checks.js

@@ -0,0 +1,175 @@
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { getConfig } from '../utils/get-deprecated-config';
+import { isDeprecatedImportConfig } from '../utils/types';
+import { importNameWithCustomMessageId, pathWithCustomMessageId } from './constants';
+import { getDeprecationIconHandler } from './handlers/icon';
+export const createChecks = context => {
+  const deprecatedIconHandler = getDeprecationIconHandler(context);
+  const throwErrors = () => {
+    deprecatedIconHandler.throwErrors();
+  };
+  const getHandler = importSource => {
+    if (importSource.startsWith('@atlaskit/icon')) {
+      return deprecatedIconHandler;
+    }
+  };
+
+  /**
+   * Report a restricted path.
+   * @param {string} importSource path of the import
+   * @param {string} type whether the node is an import or export
+   * @param {node} node representing the restricted path reference
+   * @param {Map<string,TSESTree.Node>} importNames Map of import names that are being imported
+   * @returns {void}
+   * @private
+   */
+  function checkRestrictedPathAndReport({
+    importSource,
+    type,
+    node,
+    importNames
+  }) {
+    var _context$options$;
+    const restrictedPathMessages = ((_context$options$ = context.options[0]) === null || _context$options$ === void 0 ? void 0 : _context$options$.deprecatedConfig) || getConfig('imports');
+    if (!isDeprecatedImportConfig(restrictedPathMessages)) {
+      throw new Error('Config is invalid for deprecated imports');
+    }
+    if (!Object.prototype.hasOwnProperty.call(restrictedPathMessages, importSource)) {
+      return;
+    }
+    const config = restrictedPathMessages[importSource];
+    const handler = getHandler(importSource);
+    if (handler) {
+      if (type === 'import') {
+        handler.createImportError({
+          node,
+          importSource,
+          config
+        });
+      } else {
+        handler.createExportError({
+          node,
+          importSource,
+          config
+        });
+      }
+    } else {
+      // Default behaviour
+      // The message will only exist if the import is completely banned,
+      // eg a deprecated package
+      if ('message' in config) {
+        context.report({
+          node,
+          messageId: pathWithCustomMessageId,
+          data: {
+            importSource,
+            customMessage: config.message
+          }
+        });
+      }
+
+      // if there are specific named exports that are banned,
+      // iterate through and check if they're being imported
+      if ('importSpecifiers' in config) {
+        var _config$importSpecifi;
+        (_config$importSpecifi = config.importSpecifiers) === null || _config$importSpecifi === void 0 ? void 0 : _config$importSpecifi.forEach(restrictedImport => {
+          if (importNames.has(restrictedImport.importName)) {
+            context.report({
+              node: importNames.get(restrictedImport.importName),
+              messageId: importNameWithCustomMessageId,
+              data: {
+                importName: restrictedImport.importName,
+                importSource: importSource,
+                customMessage: restrictedImport.message
+              }
+            });
+          }
+        });
+      }
+    }
+  }
+
+  /**
+   * Checks a node to see if any problems should be reported.
+   * @param {ASTNode} node The node to check.
+   * @returns {void}
+   * @private
+   */
+  const checkImportNode = node => {
+    const importSource = node.source.value.trim();
+    const importNames = new Map();
+    if ('specifiers' in node) {
+      for (const specifier of node.specifiers) {
+        let name;
+        if (specifier.type === 'ImportDefaultSpecifier') {
+          name = 'default';
+        } else if (specifier.type === 'ImportNamespaceSpecifier') {
+          name = '*';
+        } else if (specifier.type === 'ImportSpecifier') {
+          name = specifier.imported.name;
+        }
+        if (name) {
+          importNames.set(name, specifier);
+        }
+      }
+    }
+    checkRestrictedPathAndReport({
+      importSource,
+      type: 'import',
+      node,
+      importNames
+    });
+  };
+
+  /**
+   * Checks a node to see if any problems should be reported.
+   * @param {ASTNode} node The node to check.
+   * @returns {void}
+   * @private
+   */
+  const checkExportNode = node => {
+    if (!node.source || !node.source.value) {
+      return;
+    }
+    const importSource = node.source.value.trim();
+    const importNames = new Map();
+    if ('specifiers' in node) {
+      for (const specifier of node.specifiers) {
+        let name;
+        if (specifier.local) {
+          name = specifier.local.name;
+        }
+        if (name) {
+          importNames.set(name, specifier);
+        }
+      }
+    }
+    checkRestrictedPathAndReport({
+      importSource,
+      type: 'export',
+      node,
+      importNames
+    });
+  };
+
+  /**
+   * Create a mapping of JSX elements by their name so they can be processed later.
+   * @param node The JSX node found by ESLint
+   */
+  const checkJSXElement = node => {
+    if (!('openingElement' in node) || !isNodeOfType(node.openingElement.name, 'JSXIdentifier')) {
+      return;
+    }
+    deprecatedIconHandler.checkJSXElement(node);
+  };
+  const checkIdentifier = node => {
+    deprecatedIconHandler.checkIdentifier(node);
+  };
+  return {
+    checkImportNode,
+    checkExportNode,
+    checkJSXElement,
+    checkIdentifier,
+    throwErrors
+  };
+};

package/dist/es2019/rules/no-deprecated-imports/constants.js

@@ -0,0 +1,2 @@
+export const importNameWithCustomMessageId = 'importNameWithCustomMessage';
+export const pathWithCustomMessageId = 'pathWithCustomMessage';

package/dist/es2019/rules/no-deprecated-imports/handlers/icon.js

@@ -0,0 +1,153 @@
+import { isNodeOfType, literal } from 'eslint-codemod-utils';
+import coreIconLabMetadata from '@atlaskit/icon-lab/metadata';
+import { coreIconMetadata, utilityIconMetadata } from '@atlaskit/icon/metadata';
+import { pathWithCustomMessageId } from '../constants';
+/**
+ * __Deprecation icon handler__
+ *
+ * A deprecation icon handler which is responsible for displaying an error for deprecated icons.
+ * It also includes a fixer to replace the deprecated icon with the new icon if a replacement exists.
+ */
+export const getDeprecationIconHandler = context => {
+  const jsxElements = new Map();
+  const identifiers = new Map();
+  const importErrors = {};
+  const exportErrors = {};
+  const getIconComponentName = name => {
+    return name.split(/\W/).map(part => `${part[0].toUpperCase()}${part.slice(1)}`).join('').concat('Icon');
+  };
+  const createImportError = ({
+    node,
+    importSource,
+    config
+  }) => {
+    if (config.message) {
+      const myError = {
+        node,
+        messageId: pathWithCustomMessageId,
+        data: {
+          importSource,
+          customMessage: config.message,
+          unfixable: config.unfixable ? 'true' : 'false'
+        }
+      };
+      importErrors[node.source.value] = myError;
+    }
+  };
+  const createExportError = ({
+    node,
+    importSource,
+    config
+  }) => {
+    if (config.message) {
+      const myError = {
+        node,
+        messageId: pathWithCustomMessageId,
+        data: {
+          importSource,
+          customMessage: config.message
+        }
+      };
+      exportErrors[importSource] = myError;
+    }
+  };
+  const throwErrors = () => {
+    for (const [importSource, error] of Object.entries(importErrors)) {
+      if (importSource.includes('/migration/')) {
+        var _metadata$deprecatedI, _error$data;
+        const [_location, type, _migration, name] = importSource.split('/').slice(1);
+        const metadata = type === 'core' ? coreIconMetadata : utilityIconMetadata;
+        const [deprecatedIconName, legacyIconName] = name.split('--');
+        const replacement = metadata === null || metadata === void 0 ? void 0 : (_metadata$deprecatedI = metadata[deprecatedIconName]) === null || _metadata$deprecatedI === void 0 ? void 0 : _metadata$deprecatedI.replacement;
+        if (replacement && ((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.unfixable) === 'false') {
+          const newIconName = getIconComponentName(replacement.name);
+          addAutoFix(error, importSource, `${replacement.location}/${replacement.type}/migration/${replacement.name}--${legacyIconName}`, newIconName);
+        }
+      } else {
+        var _metadata, _metadata$name;
+        const [location, type, name] = importSource.split('/').slice(1);
+        let metadata;
+        if (location === 'icon') {
+          metadata = type === 'core' ? coreIconMetadata : utilityIconMetadata;
+        } else if (location === 'icon-lab') {
+          metadata = coreIconLabMetadata;
+        }
+        const replacement = (_metadata = metadata) === null || _metadata === void 0 ? void 0 : (_metadata$name = _metadata[name]) === null || _metadata$name === void 0 ? void 0 : _metadata$name.replacement;
+        if (replacement) {
+          const newIconName = getIconComponentName(replacement.name);
+          addAutoFix(error, importSource, `${replacement.location}/${replacement.type}/${replacement.name}`, newIconName);
+        }
+      }
+      context.report(error);
+    }
+    for (const error of Object.values(exportErrors)) {
+      context.report(error);
+    }
+  };
+  const addAutoFix = (error, importSource, newImportSource, newIconName) => {
+    error.fix = fixer => {
+      const fixes = [];
+
+      //Find and update all usages of this icon in JSX with the replacement icon
+      const jsxUsageNodes = jsxElements.get(importSource);
+      if (jsxUsageNodes) {
+        for (const usageNode of jsxUsageNodes) {
+          fixes.push(fixer.replaceText(usageNode.openingElement.name, newIconName));
+        }
+      }
+
+      //Find and update all usages of this icon in identifiers with the replacement icon
+      const usageNodes = identifiers.get(importSource);
+      if (usageNodes) {
+        for (const usageNode of usageNodes) {
+          fixes.push(fixer.replaceText(usageNode.parent, `{${newIconName}}`));
+        }
+      }
+      fixes.push(fixer.replaceText(error.node, `${literal(`import ${newIconName} from '${newImportSource}'`)};`));
+      return fixes;
+    };
+  };
+  const checkJSXElement = node => {
+    if (!('openingElement' in node) || !isNodeOfType(node.openingElement.name, 'JSXIdentifier')) {
+      return;
+    }
+    for (const [importSource, error] of Object.entries(importErrors)) {
+      let importIconName = error.node.specifiers[0].local.name;
+      const iconName = node.openingElement.name.name;
+      if (iconName === importIconName) {
+        if (jsxElements.has(importSource)) {
+          var _jsxElements$get;
+          (_jsxElements$get = jsxElements.get(importSource)) === null || _jsxElements$get === void 0 ? void 0 : _jsxElements$get.push(node);
+        } else {
+          jsxElements.set(importSource, [node]);
+        }
+        break;
+      }
+    }
+  };
+  const checkIdentifier = node => {
+    if (node.type !== 'Identifier' || node.parent.type !== 'JSXExpressionContainer') {
+      return;
+    }
+    for (const [importSource, error] of Object.entries(importErrors)) {
+      let importIconName = error.node.specifiers[0].local.name;
+      const iconName = node.name;
+      if (iconName === importIconName) {
+        if (identifiers.has(importSource)) {
+          var _identifiers$get;
+          (_identifiers$get = identifiers.get(importSource)) === null || _identifiers$get === void 0 ? void 0 : _identifiers$get.push(node);
+        } else {
+          identifiers.set(importSource, [node]);
+        }
+        break;
+      }
+    }
+  };
+  return {
+    createImportError,
+    createExportError,
+    checkJSXElement,
+    checkIdentifier,
+    throwErrors
+  };
+};

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

@@ -25,22 +25,20 @@
  * THE SOFTWARE.
  */
 
-import { createRule } from '../utils/create-rule';
-import { getConfig } from '../utils/get-deprecated-config';
-import { isDeprecatedImportConfig } from '../utils/types';
+import { createLintRule } from '../utils/create-rule';
+import { errorBoundary } from '../utils/error-boundary';
+import { createChecks } from './checks';
 export const name = 'no-deprecated-imports';
-export const importNameWithCustomMessageId = 'importNameWithCustomMessage';
-export const pathWithCustomMessageId = 'pathWithCustomMessage';
-const rule = createRule({
-  name,
-  defaultOptions: [{
-    deprecatedConfig: getConfig('imports')
-  }],
+const rule = createLintRule({
   meta: {
+    name,
+    fixable: 'code',
+    hasSuggestions: true,
     type: 'suggestion',
     docs: {
       description: 'Disallow importing deprecated modules.',
-      recommended: 'error'
+      recommended: true,
+      severity: 'error'
     },
     messages: {
       pathWithCustomMessage: "'{{importSource}}' import is restricted from being used. {{customMessage}}",
@@ -80,99 +78,21 @@ const rule = createRule({
       }
     }]
   },
-  create(context, [options]) {
-    var _context$options$;
+  create(context) {
     const {
-      deprecatedConfig: defaultDeprecatedConfig
-    } = options;
-    const restrictedPathMessages = ((_context$options$ = context.options[0]) === null || _context$options$ === void 0 ? void 0 : _context$options$.deprecatedConfig) || defaultDeprecatedConfig;
-    if (!isDeprecatedImportConfig(restrictedPathMessages)) {
-      throw new Error('Config is invalid for deprecated imports');
-    }
-
-    /**
-     * Report a restricted path.
-     * @param {string} importSource path of the import
-     * @param {node} node representing the restricted path reference
-     * @param {Map<string,TSESTree.Node>} importNames Map of import names that are being imported
-     * @returns {void}
-     * @private
-     */
-    function checkRestrictedPathAndReport(importSource, node, importNames) {
-      if (!Object.prototype.hasOwnProperty.call(restrictedPathMessages, importSource)) {
-        return;
-      }
-      const config = restrictedPathMessages[importSource];
-
-      // The message will only exist if the import is completely banned,
-      // eg a deprecated package
-      if ('message' in config) {
-        context.report({
-          node,
-          messageId: pathWithCustomMessageId,
-          data: {
-            importSource,
-            customMessage: config.message
-          }
-        });
-      }
-
-      // if there are specific named exports that are banned,
-      // iterate through and check if they're being imported
-      if ('importSpecifiers' in config) {
-        var _config$importSpecifi;
-        (_config$importSpecifi = config.importSpecifiers) === null || _config$importSpecifi === void 0 ? void 0 : _config$importSpecifi.forEach(restrictedImport => {
-          if (importNames.has(restrictedImport.importName)) {
-            context.report({
-              node: importNames.get(restrictedImport.importName),
-              messageId: importNameWithCustomMessageId,
-              data: {
-                importName: restrictedImport.importName,
-                importSource: importSource,
-                customMessage: restrictedImport.message
-              }
-            });
-          }
-        });
-      }
-    }
-
-    /**
-     * Checks a node to see if any problems should be reported.
-     * @param {ASTNode} node The node to check.
-     * @returns {void}
-     * @private
-     */
-    const checkNode = node => {
-      const importSource = node.source.value.trim();
-      const importNames = new Map();
-      if ('specifiers' in node) {
-        for (const specifier of node.specifiers) {
-          let name;
-          if (specifier.type === 'ImportDefaultSpecifier') {
-            name = 'default';
-          } else if (specifier.type === 'ImportNamespaceSpecifier') {
-            name = '*';
-          } else if (specifier.type === 'ImportSpecifier') {
-            name = specifier.imported.name;
-          } else if (specifier.local) {
-            name = specifier.local.name;
-          }
-          if (name) {
-            importNames.set(name, specifier);
-          }
-        }
-      }
-      checkRestrictedPathAndReport(importSource, node, importNames);
-    };
-    return {
-      ImportDeclaration: checkNode,
-      ExportNamedDeclaration(node) {
-        if (node.source) {
-          checkNode(node);
-        }
-      }
-    };
+      checkImportNode,
+      checkExportNode,
+      checkJSXElement,
+      checkIdentifier,
+      throwErrors
+    } = createChecks(context);
+    return errorBoundary({
+      ImportDeclaration: checkImportNode,
+      ExportNamedDeclaration: checkExportNode,
+      JSXElement: checkJSXElement,
+      Identifier: checkIdentifier,
+      'Program:exit': throwErrors
+    });
   }
 });
 export default rule;

package/dist/es2019/rules/utils/get-deprecated-config.js

@@ -1,8 +1,19 @@
 import fs from 'fs';
 import path from 'path';
+import { deprecatedCore as deprecatedIconLabCore } from '@atlaskit/icon-lab/deprecated-map';
+import { deprecatedCore as deprecatedIconCore, deprecatedUtility as deprecatedIconUtility } from '@atlaskit/icon/deprecated-map';
 export const getConfig = specifier => {
   const configPath = path.resolve(__dirname, '..', '..', '..', 'configs', 'deprecated.json');
   const source = fs.readFileSync(configPath, 'utf8');
   const parsedConfig = JSON.parse(source);
-  return parsedConfig[specifier];
+  const combinedConfig = {
+    ...parsedConfig,
+    imports: {
+      ...parsedConfig.imports,
+      ...deprecatedIconCore,
+      ...deprecatedIconUtility,
+      ...deprecatedIconLabCore
+    }
+  };
+  return combinedConfig[specifier];
 };

package/dist/esm/rules/no-deprecated-imports/checks.js

@@ -0,0 +1,195 @@
+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; }
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { getConfig } from '../utils/get-deprecated-config';
+import { isDeprecatedImportConfig } from '../utils/types';
+import { importNameWithCustomMessageId, pathWithCustomMessageId } from './constants';
+import { getDeprecationIconHandler } from './handlers/icon';
+export var createChecks = function createChecks(context) {
+  var deprecatedIconHandler = getDeprecationIconHandler(context);
+  var throwErrors = function throwErrors() {
+    deprecatedIconHandler.throwErrors();
+  };
+  var getHandler = function getHandler(importSource) {
+    if (importSource.startsWith('@atlaskit/icon')) {
+      return deprecatedIconHandler;
+    }
+  };
+
+  /**
+   * Report a restricted path.
+   * @param {string} importSource path of the import
+   * @param {string} type whether the node is an import or export
+   * @param {node} node representing the restricted path reference
+   * @param {Map<string,TSESTree.Node>} importNames Map of import names that are being imported
+   * @returns {void}
+   * @private
+   */
+  function checkRestrictedPathAndReport(_ref) {
+    var _context$options$;
+    var importSource = _ref.importSource,
+      type = _ref.type,
+      node = _ref.node,
+      importNames = _ref.importNames;
+    var restrictedPathMessages = ((_context$options$ = context.options[0]) === null || _context$options$ === void 0 ? void 0 : _context$options$.deprecatedConfig) || getConfig('imports');
+    if (!isDeprecatedImportConfig(restrictedPathMessages)) {
+      throw new Error('Config is invalid for deprecated imports');
+    }
+    if (!Object.prototype.hasOwnProperty.call(restrictedPathMessages, importSource)) {
+      return;
+    }
+    var config = restrictedPathMessages[importSource];
+    var handler = getHandler(importSource);
+    if (handler) {
+      if (type === 'import') {
+        handler.createImportError({
+          node: node,
+          importSource: importSource,
+          config: config
+        });
+      } else {
+        handler.createExportError({
+          node: node,
+          importSource: importSource,
+          config: config
+        });
+      }
+    } else {
+      // Default behaviour
+      // The message will only exist if the import is completely banned,
+      // eg a deprecated package
+      if ('message' in config) {
+        context.report({
+          node: node,
+          messageId: pathWithCustomMessageId,
+          data: {
+            importSource: importSource,
+            customMessage: config.message
+          }
+        });
+      }
+
+      // if there are specific named exports that are banned,
+      // iterate through and check if they're being imported
+      if ('importSpecifiers' in config) {
+        var _config$importSpecifi;
+        (_config$importSpecifi = config.importSpecifiers) === null || _config$importSpecifi === void 0 || _config$importSpecifi.forEach(function (restrictedImport) {
+          if (importNames.has(restrictedImport.importName)) {
+            context.report({
+              node: importNames.get(restrictedImport.importName),
+              messageId: importNameWithCustomMessageId,
+              data: {
+                importName: restrictedImport.importName,
+                importSource: importSource,
+                customMessage: restrictedImport.message
+              }
+            });
+          }
+        });
+      }
+    }
+  }
+
+  /**
+   * Checks a node to see if any problems should be reported.
+   * @param {ASTNode} node The node to check.
+   * @returns {void}
+   * @private
+   */
+  var checkImportNode = function checkImportNode(node) {
+    var importSource = node.source.value.trim();
+    var importNames = new Map();
+    if ('specifiers' in node) {
+      var _iterator = _createForOfIteratorHelper(node.specifiers),
+        _step;
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var specifier = _step.value;
+          var name = void 0;
+          if (specifier.type === 'ImportDefaultSpecifier') {
+            name = 'default';
+          } else if (specifier.type === 'ImportNamespaceSpecifier') {
+            name = '*';
+          } else if (specifier.type === 'ImportSpecifier') {
+            name = specifier.imported.name;
+          }
+          if (name) {
+            importNames.set(name, specifier);
+          }
+        }
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+    }
+    checkRestrictedPathAndReport({
+      importSource: importSource,
+      type: 'import',
+      node: node,
+      importNames: importNames
+    });
+  };
+
+  /**
+   * Checks a node to see if any problems should be reported.
+   * @param {ASTNode} node The node to check.
+   * @returns {void}
+   * @private
+   */
+  var checkExportNode = function checkExportNode(node) {
+    if (!node.source || !node.source.value) {
+      return;
+    }
+    var importSource = node.source.value.trim();
+    var importNames = new Map();
+    if ('specifiers' in node) {
+      var _iterator2 = _createForOfIteratorHelper(node.specifiers),
+        _step2;
+      try {
+        for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+          var specifier = _step2.value;
+          var name = void 0;
+          if (specifier.local) {
+            name = specifier.local.name;
+          }
+          if (name) {
+            importNames.set(name, specifier);
+          }
+        }
+      } catch (err) {
+        _iterator2.e(err);
+      } finally {
+        _iterator2.f();
+      }
+    }
+    checkRestrictedPathAndReport({
+      importSource: importSource,
+      type: 'export',
+      node: node,
+      importNames: importNames
+    });
+  };
+
+  /**
+   * Create a mapping of JSX elements by their name so they can be processed later.
+   * @param node The JSX node found by ESLint
+   */
+  var checkJSXElement = function checkJSXElement(node) {
+    if (!('openingElement' in node) || !isNodeOfType(node.openingElement.name, 'JSXIdentifier')) {
+      return;
+    }
+    deprecatedIconHandler.checkJSXElement(node);
+  };
+  var checkIdentifier = function checkIdentifier(node) {
+    deprecatedIconHandler.checkIdentifier(node);
+  };
+  return {
+    checkImportNode: checkImportNode,
+    checkExportNode: checkExportNode,
+    checkJSXElement: checkJSXElement,
+    checkIdentifier: checkIdentifier,
+    throwErrors: throwErrors
+  };
+};