@atlaskit/eslint-plugin-design-system 10.18.0 → 10.18.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/eslint-plugin-design-system
 
+## 10.18.1
+
+### Patch Changes
+
+- [`836af8b0a3b3e`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/836af8b0a3b3e) -
+  Adds the ability to automigrate more complex automigration cases with multiple of the same icon.
+
 ## 10.18.0
 
 ### Minor Changes

package/README.md

@@ -68,7 +68,7 @@ module.exports = {
 | <a href="./src/rules/no-html-button/README.md">no-html-button</a>                                                           | Discourage direct usage of HTML button elements in favor of Atlassian Design System button components.                                                                                                                                                                                                              | Yes         |         |             |
 | <a href="./src/rules/no-invalid-css-map/README.md">no-invalid-css-map</a>                                                   | Checks the validity of a CSS map created through cssMap. This is intended to be used alongside TypeScript's type-checking.                                                                                                                                                                                          | Yes         |         |             |
 | <a href="./src/rules/no-keyframes-tagged-template-expression/README.md">no-keyframes-tagged-template-expression</a>         | Disallows any `keyframe` tagged template expressions that originate from Emotion, Styled Components or Compiled                                                                                                                                                                                                     |             | Yes     |             |
-| <a href="./src/rules/no-legacy-icons/README.md">no-legacy-icons</a>                                                         | Enforces no legacy icons are used.                                                                                                                                                                                                                                                                                  |             | Yes     |             |
+| <a href="./src/rules/no-legacy-icons/README.md">no-legacy-icons</a>                                                         | Enforces no legacy icons are used.                                                                                                                                                                                                                                                                                  |             | Yes     | Yes         |
 | <a href="./src/rules/no-margin/README.md">no-margin</a>                                                                     | Disallow using the margin CSS property.                                                                                                                                                                                                                                                                             |             |         |             |
 | <a href="./src/rules/no-nested-styles/README.md">no-nested-styles</a>                                                       | Disallows use of nested styles in `css` functions.                                                                                                                                                                                                                                                                  | Yes         |         |             |
 | <a href="./src/rules/no-physical-properties/README.md">no-physical-properties</a>                                           | Disallow physical properties and values in `css` function calls.                                                                                                                                                                                                                                                    |             | Yes     |             |

package/dist/cjs/rules/no-legacy-icons/checks.js

@@ -1,17 +1,11 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createChecks = void 0;
-var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _eslintCodemodUtils = require("eslint-codemod-utils");
 var _helpers = require("./helpers");
-function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, 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 normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
 function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
@@ -27,7 +21,6 @@ var createChecks = exports.createChecks = function createChecks(context) {
   var errorsManual = {};
   var errorsAuto = {};
   var guidance = {};
-  var autoIconJSXElementOccurrenceCount = 0;
 
   // Extract parameters
   var shouldErrorForManualMigration = getConfigFlag('shouldErrorForManualMigration', true);
@@ -58,7 +51,8 @@ var createChecks = exports.createChecks = function createChecks(context) {
             legacyIconImports[spec.local.name] = {
               packageName: moduleSource,
               exported: false,
-              importNode: node
+              importNode: node,
+              importSpecifier: spec.local.name
             };
           }
         }
@@ -76,7 +70,8 @@ var createChecks = exports.createChecks = function createChecks(context) {
           migrationIconImports[spec.local.name] = {
             packageName: moduleSource,
             exported: false,
-            importNode: node
+            importNode: node,
+            importSpecifier: spec.local.name
           };
         }
       });
@@ -137,7 +132,9 @@ var createChecks = exports.createChecks = function createChecks(context) {
             if (Object.keys(legacyIconImports).includes(decl.init.name)) {
               legacyIconImports[decl.id.name] = {
                 packageName: legacyIconImports[decl.init.name].packageName,
-                exported: legacyIconImports[decl.init.name].exported || isExported
+                exported: legacyIconImports[decl.init.name].exported || isExported,
+                importNode: legacyIconImports[decl.init.name].importNode,
+                importSpecifier: legacyIconImports[decl.init.name].importSpecifier
               };
             } else if (newButtonImports.has(decl.init.name)) {
               newButtonImports.add(decl.id.name);
@@ -181,7 +178,7 @@ var createChecks = exports.createChecks = function createChecks(context) {
    * @param node The named export node found by ESLint
    */
   var checkExportNamedVariables = function checkExportNamedVariables(node) {
-    // export {default as AddIcon} from '@atlaskit/icon/glyph/add';
+    // Case: export {default as AddIcon} from '@atlaskit/icon/glyph/add';
     if (node.source && (0, _eslintCodemodUtils.isNodeOfType)(node.source, 'Literal') && Object.keys(node.source).includes('value')) {
       var moduleSource = node.source.value;
       if (typeof moduleSource === 'string' && ['@atlaskit/icon/glyph/', '@atlaskit/icon-object/glyph/'].find(function (val) {
@@ -206,7 +203,7 @@ var createChecks = exports.createChecks = function createChecks(context) {
         }
       }
     } else if (node.declaration && (0, _eslintCodemodUtils.isNodeOfType)(node.declaration, 'VariableDeclaration')) {
-      // export const Icon = AddIcon;
+      // Case: export const Icon = AddIcon;
       var _iterator6 = _createForOfIteratorHelper(node.declaration.declarations),
         _step6;
       try {
@@ -242,7 +239,9 @@ var createChecks = exports.createChecks = function createChecks(context) {
             //update legacy imports to be exported
             legacyIconImports[_spec3.local.name] = {
               packageName: legacyIconImports[_spec3.local.name].packageName,
-              exported: true
+              exported: true,
+              importNode: legacyIconImports[_spec3.local.name].importNode,
+              importSpecifier: legacyIconImports[_spec3.local.name].importSpecifier
             };
             (0, _helpers.createCantMigrateReExportError)(_spec3, legacyIconImports[_spec3.local.name].packageName, _spec3.exported.name, errorsManual);
             (0, _helpers.addToListOfRanges)(_spec3, errorRanges);
@@ -497,7 +496,6 @@ var createChecks = exports.createChecks = function createChecks(context) {
       });
       var _shouldAddSpaciousSpacing = (_sizeProp && _sizeProp.type === 'JSXAttribute' && ((_sizeProp$value2 = _sizeProp.value) === null || _sizeProp$value2 === void 0 ? void 0 : _sizeProp$value2.type) === 'Literal' && _sizeProp.value.value === 'medium' || !_sizeProp) && !_insideNewButton && !insideLegacyButton;
       if (!hasManualMigration && (newIcon || upcomingIcon) && isNewIconMigratable) {
-        autoIconJSXElementOccurrenceCount++;
         (0, _helpers.createAutoMigrationError)({
           node: node,
           importSource: legacyIconImports[name].packageName,
@@ -551,132 +549,26 @@ var createChecks = exports.createChecks = function createChecks(context) {
    * Throws the relevant errors in the correct order based on configs.
    */
   var throwErrors = function throwErrors() {
+    // Throw manual errors
     if (shouldErrorForManualMigration) {
-      for (var _i = 0, _Object$entries = Object.entries(errorsManual); _i < _Object$entries.length; _i++) {
-        var _Object$entries$_i = (0, _slicedToArray2.default)(_Object$entries[_i], 2),
-          _key = _Object$entries$_i[0],
-          errorList = _Object$entries$_i[1];
-        var _node = 'node' in errorList.errors[0] ? errorList.errors[0].node : null;
-        var cantMigrateIdentifierError = errorList.errors.find(function (x) {
-          return 'messageId' in x && x.messageId === 'cantMigrateIdentifier';
-        });
-        if (_node) {
-          var isInRange = false;
-          if (cantMigrateIdentifierError && (0, _helpers.isInRangeList)(_node, errorRanges)) {
-            isInRange = true;
-          }
-          if (isInRange && errorList.errors.length - 1 > 0 || !isInRange && errorList.errors.length > 0) {
-            var guidanceMessage = Object.keys(guidance).includes(_key) ? guidance[_key] : '';
-            context.report({
-              node: _node,
-              messageId: 'noLegacyIconsManualMigration',
-              data: {
-                iconName: errorList.iconName,
-                importSource: errorList.importSource,
-                guidance: isQuietMode ? guidanceMessage : "".concat(guidanceMessage, "For more information see the below errors.\n")
-              }
-            });
-            if (!isQuietMode) {
-              var _iterator10 = _createForOfIteratorHelper(errorList.errors),
-                _step10;
-              try {
-                for (_iterator10.s(); !(_step10 = _iterator10.n()).done;) {
-                  var error = _step10.value;
-                  if ('messageId' in error && (error.messageId !== 'cantMigrateIdentifier' || error.messageId === 'cantMigrateIdentifier' && !isInRange)) {
-                    context.report(error);
-                  }
-                }
-              } catch (err) {
-                _iterator10.e(err);
-              } finally {
-                _iterator10.f();
-              }
-            }
-          }
-        }
-      }
+      (0, _helpers.throwManualErrors)({
+        errorsManual: errorsManual,
+        errorRanges: errorRanges,
+        guidance: guidance,
+        context: context,
+        isQuietMode: isQuietMode
+      });
     }
     if (shouldErrorForAutoMigration) {
-      var _loop = function _loop() {
-        var _Object$entries2$_i = (0, _slicedToArray2.default)(_Object$entries2[_i2], 2),
-          key = _Object$entries2$_i[0],
-          error = _Object$entries2$_i[1];
-        // If there's a manual error that exists for this same component,
-        // don't throw the auto error
-        if (Object.keys(errorsManual).includes(key)) {
-          var _cantMigrateIdentifierError = errorsManual[key].errors.find(function (x) {
-            return 'messageId' in x && x.messageId === 'cantMigrateIdentifier';
-          });
-          if (!_cantMigrateIdentifierError || _cantMigrateIdentifierError && errorsManual[key].errors.length > 1) {
-            delete errorsAuto[key];
-            return 1; // continue
-          }
-        }
-        var node = 'node' in error ? error.node : null;
-        if (node) {
-          var _guidanceMessage = Object.keys(guidance).includes(key) ? guidance[key] : '';
-          if (Object.keys(error).includes('data') && error.data) {
-            error.data.guidance = _guidanceMessage;
-          }
-          context.report(_objectSpread(_objectSpread({}, error), {}, {
-            fix: function fix(fixer) {
-              var _legacyIconImports$er, _migrationIconImports;
-              // don't migration if the new icon is not available
-              if (!error.data || shouldUseMigrationPath && !(0, _helpers.checkIfNewIconExist)(error)) {
-                return [];
-              }
-              var fixArguments = {
-                metadata: error.data,
-                legacyImportNode: (_legacyIconImports$er = legacyIconImports[error.data.iconName]) === null || _legacyIconImports$er === void 0 ? void 0 : _legacyIconImports$er.importNode,
-                migrationImportNode: (_migrationIconImports = migrationIconImports[error.data.iconName]) === null || _migrationIconImports === void 0 ? void 0 : _migrationIconImports.importNode,
-                shouldUseMigrationPath: shouldUseMigrationPath
-              };
-              var propsFixes = (0, _helpers.createPropFixes)(_objectSpread(_objectSpread({}, fixArguments), {}, {
-                node: node,
-                fixer: fixer
-              }));
-              var importFixes = [];
-              // Otherwise if there are multiple occurrences of the icon, import path will be handled after the prop fix
-              if (autoIconJSXElementOccurrenceCount <= 1) {
-                importFixes = (0, _helpers.createImportFix)(_objectSpread(_objectSpread({}, fixArguments), {}, {
-                  fixer: fixer
-                }));
-              }
-              return [].concat((0, _toConsumableArray2.default)(propsFixes), (0, _toConsumableArray2.default)(importFixes));
-            }
-          }));
-        }
-      };
-      for (var _i2 = 0, _Object$entries2 = Object.entries(errorsAuto); _i2 < _Object$entries2.length; _i2++) {
-        if (_loop()) continue;
-      }
-
-      // Update import path at the end if there are multiple occurrences of the icon
-      if (autoIconJSXElementOccurrenceCount > 1) {
-        var _loop2 = function _loop2() {
-          var _Object$entries3$_i = (0, _slicedToArray2.default)(_Object$entries3[_i3], 2),
-            _ = _Object$entries3$_i[0],
-            error = _Object$entries3$_i[1];
-          context.report(_objectSpread(_objectSpread({}, error), {}, {
-            fix: function fix(fixer) {
-              var _legacyIconImports$er2, _migrationIconImports2;
-              if (!error.data || shouldUseMigrationPath && !(0, _helpers.checkIfNewIconExist)(error)) {
-                return [];
-              }
-              return (0, _helpers.createImportFix)({
-                metadata: error.data,
-                fixer: fixer,
-                legacyImportNode: (_legacyIconImports$er2 = legacyIconImports[error.data.iconName]) === null || _legacyIconImports$er2 === void 0 ? void 0 : _legacyIconImports$er2.importNode,
-                migrationImportNode: (_migrationIconImports2 = migrationIconImports[error.data.iconName]) === null || _migrationIconImports2 === void 0 ? void 0 : _migrationIconImports2.importNode,
-                shouldUseMigrationPath: shouldUseMigrationPath
-              });
-            }
-          }));
-        };
-        for (var _i3 = 0, _Object$entries3 = Object.entries(errorsAuto); _i3 < _Object$entries3.length; _i3++) {
-          _loop2();
-        }
-      }
+      (0, _helpers.throwAutoErrors)({
+        errorsManual: errorsManual,
+        errorsAuto: errorsAuto,
+        legacyIconImports: legacyIconImports,
+        guidance: guidance,
+        migrationIconImports: migrationIconImports,
+        shouldUseMigrationPath: shouldUseMigrationPath,
+        context: context
+      });
     }
   };
   return {

package/dist/cjs/rules/no-legacy-icons/helpers.js

@@ -5,13 +5,20 @@ var _typeof = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.locToString = exports.isSize = exports.isInsideNewButton = exports.isInsideLegacyButton = exports.isInRangeList = exports.getUpcomingIcons = exports.getNewIconNameAndImportPath = exports.getMigrationMapObject = exports.getLiteralStringValue = exports.createPropFixes = exports.createImportFix = exports.createHelpers = exports.createGuidance = exports.createCantMigrateSpreadPropsError = exports.createCantMigrateSizeUnknown = exports.createCantMigrateReExportError = exports.createCantMigrateIdentifierMapOrArrayError = exports.createCantMigrateIdentifierError = exports.createCantMigrateFunctionUnknownError = exports.createCantMigrateColorError = exports.createCantFindSuitableReplacementError = exports.createAutoMigrationError = exports.checkIfNewIconExist = exports.canMigrateColor = exports.canAutoMigrateNewIconBasedOnSize = exports.addToListOfRanges = void 0;
+exports.throwManualErrors = exports.throwAutoErrors = exports.locToString = exports.isSize = exports.isInsideNewButton = exports.isInsideLegacyButton = exports.getUpcomingIcons = exports.getMigrationMapObject = exports.createHelpers = exports.createGuidance = exports.createCantMigrateSpreadPropsError = exports.createCantMigrateSizeUnknown = exports.createCantMigrateReExportError = exports.createCantMigrateIdentifierMapOrArrayError = exports.createCantMigrateIdentifierError = exports.createCantMigrateFunctionUnknownError = exports.createCantMigrateColorError = exports.createCantFindSuitableReplacementError = exports.createAutoMigrationError = exports.canMigrateColor = exports.canAutoMigrateNewIconBasedOnSize = exports.addToListOfRanges = void 0;
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _eslintCodemodUtils = require("eslint-codemod-utils");
 var _UNSAFE_migrationMap = _interopRequireWildcard(require("@atlaskit/icon/UNSAFE_migration-map"));
 var _upcomingIcons = require("./upcoming-icons");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, 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 normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
 var sizes = ['small', 'medium', 'large', 'xlarge'];
 var isSize = exports.isSize = function isSize(size) {
   return sizes.includes(size);
@@ -67,7 +74,7 @@ var canAutoMigrateNewIconBasedOnSize = exports.canAutoMigrateNewIconBasedOnSize
  * @param iconPackage string
  * @returns object of new icon name and import path
  */
-var getNewIconNameAndImportPath = exports.getNewIconNameAndImportPath = function getNewIconNameAndImportPath(iconPackage, shouldUseMigrationPath) {
+var getNewIconNameAndImportPath = function getNewIconNameAndImportPath(iconPackage, shouldUseMigrationPath) {
   var legacyIconName = getIconKey(iconPackage);
   var migrationMapObject = getMigrationMapObject(iconPackage);
   if (!migrationMapObject || !migrationMapObject.newIcon) {
@@ -298,7 +305,7 @@ var pushManualError = function pushManualError(key, errors, myError, importSourc
     };
   }
 };
-var getLiteralStringValue = exports.getLiteralStringValue = function getLiteralStringValue(value) {
+var getLiteralStringValue = function getLiteralStringValue(value) {
   if (!value) {
     return;
   }
@@ -366,7 +373,7 @@ var addToListOfRanges = exports.addToListOfRanges = function addToListOfRanges(n
     });
   }
 };
-var isInRangeList = exports.isInRangeList = function isInRangeList(node, sortedListOfRangesForErrors) {
+var isInRangeList = function isInRangeList(node, sortedListOfRangesForErrors) {
   var range = node.range;
   if (!range || range.length < 2) {
     return false;
@@ -411,6 +418,18 @@ var findProp = function findProp(attributes, propName) {
     return attr.type === 'JSXAttribute' && attr.name.name === propName;
   });
 };
+var getNewIconNameForRenaming = function getNewIconNameForRenaming(isInManualArray, importSource, importSpecifier) {
+  var newIconName;
+  if (isInManualArray) {
+    newIconName = getNewIconNameAndImportPath(importSource).iconName;
+    var keyToName = newIconName ? newIconName[0].toUpperCase() + newIconName.slice(1) + 'Icon' : undefined;
+    newIconName = keyToName;
+    if (newIconName === undefined || importSpecifier === keyToName) {
+      newIconName = "".concat(keyToName, "New");
+    }
+  }
+  return newIconName;
+};
 
 /**
  *
@@ -422,22 +441,22 @@ var findProp = function findProp(attributes, propName) {
  * @param migrationImportNode The migration import declaration node to replace, only present if shouldUseMigrationPath is false
  * @returns A list of fixers to migrate the icon
  */
-var createImportFix = exports.createImportFix = function createImportFix(_ref6) {
+var createImportFix = function createImportFix(_ref6) {
   var fixer = _ref6.fixer,
     legacyImportNode = _ref6.legacyImportNode,
     metadata = _ref6.metadata,
     shouldUseMigrationPath = _ref6.shouldUseMigrationPath,
-    migrationImportNode = _ref6.migrationImportNode;
+    migrationImportNode = _ref6.migrationImportNode,
+    newIconName = _ref6.newIconName;
   var fixes = [];
   var importSource = metadata.importSource;
   var importPath = migrationImportNode ? importSource.replace('/migration', '').split('--')[0] : getNewIconNameAndImportPath(importSource, shouldUseMigrationPath).importPath;
-
-  // replace old icon import with icon import
-  if (legacyImportNode && importPath) {
-    fixes.push(fixer.replaceText(legacyImportNode.source, "'".concat((0, _eslintCodemodUtils.literal)(importPath), "'")));
-  }
-  if (migrationImportNode && !shouldUseMigrationPath && importPath) {
-    fixes.push(fixer.replaceText(migrationImportNode.source, "'".concat((0, _eslintCodemodUtils.literal)(importPath), "'")));
+  var useMigrationPath = legacyImportNode && importPath;
+  var useFinalPath = migrationImportNode && !shouldUseMigrationPath && importPath;
+  if (useMigrationPath) {
+    fixes.push(newIconName ? fixer.insertTextBefore(legacyImportNode, "import ".concat(newIconName, " from '").concat(importPath, "';\n")) : fixer.replaceText(legacyImportNode.source, "'".concat((0, _eslintCodemodUtils.literal)(importPath), "'")));
+  } else if (useFinalPath) {
+    fixes.push(newIconName ? fixer.insertTextBefore(migrationImportNode, "import ".concat(newIconName, " from '").concat(importPath, "';\n")) : fixer.replaceText(migrationImportNode.source, "'".concat((0, _eslintCodemodUtils.literal)(importPath), "'")));
   }
   return fixes;
 };
@@ -452,13 +471,14 @@ var createImportFix = exports.createImportFix = function createImportFix(_ref6)
  * @param migrationImportNode The migration import declaration node to replace, only present if shouldUseMigrationPath is false
  * @returns A list of fixers to migrate the icon
  */
-var createPropFixes = exports.createPropFixes = function createPropFixes(_ref7) {
+var createPropFixes = function createPropFixes(_ref7) {
   var node = _ref7.node,
     fixer = _ref7.fixer,
     legacyImportNode = _ref7.legacyImportNode,
     metadata = _ref7.metadata,
     shouldUseMigrationPath = _ref7.shouldUseMigrationPath,
-    migrationImportNode = _ref7.migrationImportNode;
+    migrationImportNode = _ref7.migrationImportNode,
+    newIconName = _ref7.newIconName;
   var fixes = [];
   var importSource = metadata.importSource,
     spacing = metadata.spacing,
@@ -470,6 +490,9 @@ var createPropFixes = exports.createPropFixes = function createPropFixes(_ref7)
   var iconType = importPath !== null && importPath !== void 0 && importPath.startsWith('@atlaskit/icon/core') ? 'core' : 'utility';
   if (node.type === 'JSXElement') {
     var openingElement = node.openingElement;
+    if (newIconName) {
+      fixes.push(fixer.replaceText(openingElement.name, newIconName));
+    }
     var attributes = openingElement.attributes;
 
     // replace primaryColor prop with color
@@ -526,6 +549,8 @@ var createPropFixes = exports.createPropFixes = function createPropFixes(_ref7)
         }
       });
     }
+  } else if (node.type === 'Identifier' && newIconName) {
+    fixes.push(fixer.replaceText(node, newIconName));
   }
   return fixes;
 };
@@ -533,7 +558,7 @@ var createPropFixes = exports.createPropFixes = function createPropFixes(_ref7)
 /**
  * Check if the new icon exists in the migration map
  */
-var checkIfNewIconExist = exports.checkIfNewIconExist = function checkIfNewIconExist(error) {
+var checkIfNewIconExist = function checkIfNewIconExist(error) {
   var _error$data;
   if (!((_error$data = error.data) !== null && _error$data !== void 0 && _error$data.importSource)) {
     return false;
@@ -542,4 +567,210 @@ var checkIfNewIconExist = exports.checkIfNewIconExist = function checkIfNewIconE
   var _ref8 = _UNSAFE_migrationMap.default[iconKey] || {},
     newIcon = _ref8.newIcon;
   return Boolean(newIcon);
+};
+var throwManualErrors = exports.throwManualErrors = function throwManualErrors(_ref9) {
+  var errorsManual = _ref9.errorsManual,
+    errorRanges = _ref9.errorRanges,
+    guidance = _ref9.guidance,
+    context = _ref9.context,
+    isQuietMode = _ref9.isQuietMode;
+  for (var _i2 = 0, _Object$entries2 = Object.entries(errorsManual); _i2 < _Object$entries2.length; _i2++) {
+    var _Object$entries2$_i = (0, _slicedToArray2.default)(_Object$entries2[_i2], 2),
+      _key = _Object$entries2$_i[0],
+      errorList = _Object$entries2$_i[1];
+    var node = 'node' in errorList.errors[0] ? errorList.errors[0].node : null;
+    if (!node) {
+      return;
+    }
+    var cantMigrateIdentifierError = errorList.errors.find(function (x) {
+      return 'messageId' in x && x.messageId === 'cantMigrateIdentifier';
+    });
+    var isInRange = false;
+    if (cantMigrateIdentifierError && isInRangeList(node, errorRanges)) {
+      isInRange = true;
+    }
+    if (isInRange && errorList.errors.length - 1 > 0 || !isInRange && errorList.errors.length > 0) {
+      var guidanceMessage = Object.keys(guidance).includes(_key) ? guidance[_key] : '';
+      context.report({
+        node: node,
+        messageId: 'noLegacyIconsManualMigration',
+        data: {
+          iconName: errorList.iconName,
+          importSource: errorList.importSource,
+          guidance: isQuietMode ? guidanceMessage : "".concat(guidanceMessage, "For more information see the below errors.\n")
+        }
+      });
+      if (!isQuietMode) {
+        var _iterator = _createForOfIteratorHelper(errorList.errors),
+          _step;
+        try {
+          for (_iterator.s(); !(_step = _iterator.n()).done;) {
+            var error = _step.value;
+            if ('messageId' in error && (error.messageId !== 'cantMigrateIdentifier' || error.messageId === 'cantMigrateIdentifier' && !isInRange)) {
+              context.report(error);
+            }
+          }
+        } catch (err) {
+          _iterator.e(err);
+        } finally {
+          _iterator.f();
+        }
+      }
+    }
+  }
+};
+
+// Loops through automatic errors and them after adding the required suggestion/fix
+var throwAutoErrors = exports.throwAutoErrors = function throwAutoErrors(_ref10) {
+  var errorsManual = _ref10.errorsManual,
+    errorsAuto = _ref10.errorsAuto,
+    legacyIconImports = _ref10.legacyIconImports,
+    guidance = _ref10.guidance,
+    migrationIconImports = _ref10.migrationIconImports,
+    shouldUseMigrationPath = _ref10.shouldUseMigrationPath,
+    context = _ref10.context;
+  // Set of all the import sources that have manual errors (required later to check if a source has both manual and auto
+  // errors in one file making it impossible to just remove the legacy import)
+  var allManualErrorSources = Object.entries(errorsManual).reduce(function (result, option) {
+    var _option = (0, _slicedToArray2.default)(option, 2),
+      key = _option[0],
+      errorInfo = _option[1];
+    if (!errorsAuto.hasOwnProperty(key)) {
+      result.add(errorInfo.importSource);
+    }
+    return result;
+  }, new Set());
+  //group errors by import source and remove any unwanted errors
+  var groupedErrorList = Object.entries(errorsAuto).reduce(function (result, option) {
+    var _option2 = (0, _slicedToArray2.default)(option, 2),
+      key = _option2[0],
+      error = _option2[1];
+    //return early if no data
+    if (!error.data) {
+      return result;
+    }
+    if (Object.keys(errorsManual).includes(key)) {
+      var cantMigrateIdentifierError = errorsManual[key].errors.find(function (x) {
+        return 'messageId' in x && x.messageId === 'cantMigrateIdentifier';
+      });
+      // If cantMigrateIdentifier is the only manual error found we still want to throw the auto error
+      if (!(cantMigrateIdentifierError && errorsManual[key].errors.length === 1)) {
+        return result;
+      }
+    }
+    var importSource = error.data.importSource;
+    if (!result.hasOwnProperty(importSource)) {
+      result[importSource] = [];
+    }
+    result[importSource].push(_objectSpread({
+      key: key
+    }, error));
+    return result;
+  }, {});
+  var _loop = function _loop() {
+    var _Object$entries3$_i = (0, _slicedToArray2.default)(_Object$entries3[_i3], 2),
+      importSource = _Object$entries3$_i[0],
+      errorList = _Object$entries3$_i[1];
+    var autoFixers = [];
+    // appliedErrorsForImport will contain all the errors FOR A SINGLE IMPORT and will be merged into errorListForReport
+    var appliedErrorsForImport = [];
+    // Loop over auto errors for a single import source
+    var _iterator2 = _createForOfIteratorHelper(errorList.entries()),
+      _step2;
+    try {
+      var _loop2 = function _loop2() {
+          var _legacyIconImports$er, _legacyIconImports$er2, _migrationIconImports;
+          var _step2$value = (0, _slicedToArray2.default)(_step2.value, 2),
+            _ = _step2$value[0],
+            error = _step2$value[1];
+          var key = error.key;
+          var node = 'node' in error ? error.node : null;
+          // Check if there is a manual error for the same import source somewhere else in the same file
+          // If that is the case we'll need to provide a suggestion instead of auto-fixing as the suggestion will
+          // add another import without removing the old import and this needs to be validated
+          var isInManualArray = allManualErrorSources.has(importSource);
+          // New icon name for renaming if the icon is in the manual array
+          var newIconName = getNewIconNameForRenaming(isInManualArray, importSource, errorList[0].data ? (_legacyIconImports$er = legacyIconImports[errorList[0].data.iconName]) === null || _legacyIconImports$er === void 0 ? void 0 : _legacyIconImports$er.importSpecifier : undefined);
+          if (!node) {
+            return 0; // continue
+          }
+          var guidanceMessage = guidance.hasOwnProperty(key) ? guidance[key] : '';
+          if (Object.keys(error).includes('data') && error.data) {
+            error.data.guidance = guidanceMessage;
+          }
+          var fixArguments = error.data ? {
+            metadata: error.data,
+            legacyImportNode: (_legacyIconImports$er2 = legacyIconImports[error.data.iconName]) === null || _legacyIconImports$er2 === void 0 ? void 0 : _legacyIconImports$er2.importNode,
+            migrationImportNode: (_migrationIconImports = migrationIconImports[error.data.iconName]) === null || _migrationIconImports === void 0 ? void 0 : _migrationIconImports.importNode,
+            shouldUseMigrationPath: shouldUseMigrationPath,
+            newIconName: isInManualArray ? newIconName : undefined
+          } : null;
+          if (!error.data || shouldUseMigrationPath && !checkIfNewIconExist(error) || !fixArguments) {
+            return 0; // continue
+          }
+          if (isInManualArray) {
+            // provide suggestion if there is a manual error for the same import source and thus the legacy import can't be removed
+            error.suggest = [{
+              desc: 'Rename icon import, import from the new package, and update props.',
+              fix: function fix(fixer) {
+                return [].concat((0, _toConsumableArray2.default)(createPropFixes(_objectSpread(_objectSpread({}, fixArguments), {}, {
+                  node: node,
+                  fixer: fixer
+                }))), (0, _toConsumableArray2.default)(createImportFix(_objectSpread(_objectSpread({}, fixArguments), {}, {
+                  fixer: fixer
+                }))));
+              }
+            }];
+          } else {
+            // Update Guidance message for auto-fixing
+            if (error.data) {
+              error.data.guidance = error.data.guidance + "\nTo automatically fix this icon, run the auto-fixer attached to the first use of ".concat(importSource, " in this file - either manually, or by saving this file.");
+            }
+            // There should only be 1 import fix for each import source and thus only add this at the start of the list
+            if (autoFixers.length === 0) {
+              autoFixers.push(function (fixer) {
+                return createImportFix(_objectSpread(_objectSpread({}, fixArguments), {}, {
+                  fixer: fixer
+                }));
+              });
+            }
+            // Push the prop fix regardless
+            autoFixers.push(function (fixer) {
+              return createPropFixes(_objectSpread(_objectSpread({}, fixArguments), {}, {
+                node: node,
+                fixer: fixer
+              }));
+            });
+          }
+          // Add the error to the appliedErrorsForImport, ready to be thrown later
+          appliedErrorsForImport.push(error);
+        },
+        _ret;
+      for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+        _ret = _loop2();
+        if (_ret === 0) continue;
+      }
+      // We want to have only 1 fix for each import source that is not in the manual array
+      // NOTE: If in the manual array, suggestions have been applied above and autoFixers.length will be 0 which will mean no fix is added
+    } catch (err) {
+      _iterator2.e(err);
+    } finally {
+      _iterator2.f();
+    }
+    if (autoFixers.length > 0) {
+      // Add the fix to only one of the errors in the list of errors from the current import source
+      appliedErrorsForImport[0].fix = function (fixer) {
+        return autoFixers.flatMap(function (autoFixer) {
+          return autoFixer(fixer);
+        });
+      };
+    }
+    // throw errors
+    appliedErrorsForImport.forEach(function (error) {
+      context.report(error);
+    });
+  };
+  for (var _i3 = 0, _Object$entries3 = Object.entries(groupedErrorList); _i3 < _Object$entries3.length; _i3++) {
+    _loop();
+  }
 };

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

@@ -12,6 +12,7 @@ var rule = (0, _createRule.createLintRule)({
   meta: {
     name: 'no-legacy-icons',
     fixable: 'code',
+    hasSuggestions: true,
     type: 'problem',
     docs: {
       description: 'Enforces no legacy icons are used.',