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

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/eslint-plugin-design-system
 
+## 10.10.1
+
+### Patch Changes
+
+- [#117847](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/117847)
+  [`5795b7b47ceac`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/5795b7b47ceac) -
+  Removes redundant files from NPM deployment
+- [#117920](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/117920)
+  [`57088349e6e38`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/57088349e6e38) -
+  Updated guidance on no-legacy-icons lint rule to be more descriptive.
+
 ## 10.10.0
 
 ### Minor Changes

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

@@ -141,25 +141,36 @@ var createChecks = exports.createChecks = function createChecks(context) {
       if (typeof moduleSource === 'string' && ['@atlaskit/icon/glyph/', '@atlaskit/icon-object/glyph/'].find(function (val) {
         return moduleSource.startsWith(val);
       }) && node.specifiers.length) {
-        (0, _helpers.createCantMigrateReExportError)(node, moduleSource, node.specifiers[0].exported.name, errorsManual);
-        guidance[(0, _helpers.locToString)(node)] = (0, _helpers.createGuidance)(moduleSource);
+        var _iterator4 = _createForOfIteratorHelper(node.specifiers),
+          _step4;
+        try {
+          for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
+            var spec = _step4.value;
+            (0, _helpers.createCantMigrateReExportError)(spec, moduleSource, spec.exported.name, errorsManual);
+            guidance[(0, _helpers.locToString)(spec)] = (0, _helpers.createGuidance)(moduleSource);
+          }
+        } catch (err) {
+          _iterator4.e(err);
+        } finally {
+          _iterator4.f();
+        }
       }
     } else if (node.declaration && (0, _eslintCodemodUtils.isNodeOfType)(node.declaration, 'VariableDeclaration')) {
       // export const Icon = AddIcon;
-      var _iterator4 = _createForOfIteratorHelper(node.declaration.declarations),
-        _step4;
+      var _iterator5 = _createForOfIteratorHelper(node.declaration.declarations),
+        _step5;
       try {
-        for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
-          var decl = _step4.value;
+        for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
+          var decl = _step5.value;
           if ((0, _eslintCodemodUtils.isNodeOfType)(decl, 'VariableDeclarator') && 'init' in decl && decl.init && (0, _eslintCodemodUtils.isNodeOfType)(decl.init, 'Identifier') && decl.init.name in legacyIconImports) {
             (0, _helpers.createCantMigrateReExportError)(node, legacyIconImports[decl.init.name].packageName, decl.init.name, errorsManual);
-            guidance[(0, _helpers.locToString)(node)] = (0, _helpers.createGuidance)((0, _helpers.createGuidance)(legacyIconImports[decl.init.name].packageName));
+            guidance[(0, _helpers.locToString)(node)] = (0, _helpers.createGuidance)(legacyIconImports[decl.init.name].packageName);
           }
         }
       } catch (err) {
-        _iterator4.e(err);
+        _iterator5.e(err);
       } finally {
-        _iterator4.f();
+        _iterator5.f();
       }
     } else if (!node.source && node.specifiers && node.specifiers.length > 0) {
       /**
@@ -168,25 +179,25 @@ var createChecks = exports.createChecks = function createChecks(context) {
        * const crossIcon = LegacyIcon2;
        * export { AddIcon, CrossIcon as default }
        */
-      var _iterator5 = _createForOfIteratorHelper(node.specifiers),
-        _step5;
+      var _iterator6 = _createForOfIteratorHelper(node.specifiers),
+        _step6;
       try {
-        for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
-          var spec = _step5.value;
-          if (spec.local.name in legacyIconImports) {
+        for (_iterator6.s(); !(_step6 = _iterator6.n()).done;) {
+          var _spec2 = _step6.value;
+          if (_spec2.local.name in legacyIconImports) {
             //update legacy imports to be exported
-            legacyIconImports[spec.local.name] = {
-              packageName: legacyIconImports[spec.local.name].packageName,
+            legacyIconImports[_spec2.local.name] = {
+              packageName: legacyIconImports[_spec2.local.name].packageName,
               exported: true
             };
-            (0, _helpers.createCantMigrateReExportError)(spec, legacyIconImports[spec.local.name].packageName, spec.exported.name, errorsManual);
-            guidance[(0, _helpers.locToString)(spec)] = (0, _helpers.createGuidance)(legacyIconImports[spec.local.name].packageName);
+            (0, _helpers.createCantMigrateReExportError)(_spec2, legacyIconImports[_spec2.local.name].packageName, _spec2.exported.name, errorsManual);
+            guidance[(0, _helpers.locToString)(_spec2)] = (0, _helpers.createGuidance)(legacyIconImports[_spec2.local.name].packageName);
           }
         }
       } catch (err) {
-        _iterator5.e(err);
+        _iterator6.e(err);
       } finally {
-        _iterator5.f();
+        _iterator6.f();
       }
     }
   };
@@ -233,18 +244,17 @@ var createChecks = exports.createChecks = function createChecks(context) {
         UNSAFE_propName = result.UNSAFE_propName;
       }
       if (newIcon && isInNewButton && isNewIconMigratable && UNSAFE_size !== 'large' && UNSAFE_size !== 'xlarge') {
-        var iconKey = (0, _helpers.getIconKey)(legacyIconImports[node.name].packageName);
-        (0, _helpers.createAutoMigrationError)(node, legacyIconImports[node.name].packageName, node.name, newIcon, iconKey, errorsAuto);
-        guidance[(0, _helpers.locToString)(node)] = (0, _helpers.createGuidance)(legacyIconImports[node.name].packageName, 'medium');
+        (0, _helpers.createAutoMigrationError)(node, legacyIconImports[node.name].packageName, node.name, errorsAuto);
+        guidance[(0, _helpers.locToString)(node)] = (0, _helpers.createGuidance)(legacyIconImports[node.name].packageName, isInNewButton, 'medium');
       } else if ((!newIcon || !isNewIconMigratable) && !UNSAFE_size) {
         (0, _helpers.createCantFindSuitableReplacementError)(node, legacyIconImports[node.name].packageName, node.name, errorsManual);
-        guidance[(0, _helpers.locToString)(node)] = (0, _helpers.createGuidance)(legacyIconImports[node.name].packageName);
+        guidance[(0, _helpers.locToString)(node)] = (0, _helpers.createGuidance)(legacyIconImports[node.name].packageName, isInNewButton);
       } else if ((UNSAFE_size === 'large' || UNSAFE_size === 'xlarge') && UNSAFE_propName) {
         (0, _helpers.createCantMigrateUnsafeProp)(node, UNSAFE_propName, UNSAFE_size, legacyIconImports[node.name].packageName, node.name, errorsManual);
-        guidance[(0, _helpers.locToString)(node)] = (0, _helpers.createGuidance)(legacyIconImports[node.name].packageName, UNSAFE_size);
+        guidance[(0, _helpers.locToString)(node)] = (0, _helpers.createGuidance)(legacyIconImports[node.name].packageName, isInNewButton, UNSAFE_size);
       } else if (!isInNewButton) {
         (0, _helpers.createCantMigrateFunctionUnknownError)(node, legacyIconImports[node.name].packageName, node.name, errorsManual);
-        guidance[(0, _helpers.locToString)(node)] = (0, _helpers.createGuidance)(legacyIconImports[node.name].packageName);
+        guidance[(0, _helpers.locToString)(node)] = (0, _helpers.createGuidance)(legacyIconImports[node.name].packageName, isInNewButton);
       }
     }
   };
@@ -287,11 +297,11 @@ var createChecks = exports.createChecks = function createChecks(context) {
       var requiredAttributesAfterSpread = new Set(['size', 'primaryColor', 'secondaryColor']);
       var hasSpread = false;
       var hasPrimaryColorProp = false;
-      var _iterator6 = _createForOfIteratorHelper(node.openingElement.attributes),
-        _step6;
+      var _iterator7 = _createForOfIteratorHelper(node.openingElement.attributes),
+        _step7;
       try {
-        for (_iterator6.s(); !(_step6 = _iterator6.n()).done;) {
-          var attr = _step6.value;
+        for (_iterator7.s(); !(_step7 = _iterator7.n()).done;) {
+          var attr = _step7.value;
           // Detect spread props
           if ((0, _eslintCodemodUtils.isNodeOfType)(attr, 'JSXSpreadAttribute')) {
             // In case there are more spread props
@@ -324,9 +334,9 @@ var createChecks = exports.createChecks = function createChecks(context) {
           }
         }
       } catch (err) {
-        _iterator6.e(err);
+        _iterator7.e(err);
       } finally {
-        _iterator6.f();
+        _iterator7.f();
       }
       var hasManualMigration = false;
       if (primaryColor && !(0, _helpers.canMigrateColor)(primaryColor) || hasPrimaryColorProp && !primaryColor) {
@@ -340,7 +350,6 @@ var createChecks = exports.createChecks = function createChecks(context) {
         (0, _helpers.createCantMigrateSizeUnknown)(node, errorsManual, legacyIconImports[name].packageName, name);
         hasManualMigration = true;
       }
-      guidance[(0, _helpers.locToString)(node)] = (0, _helpers.createGuidance)(legacyIconImports[name].packageName, size ? size : undefined);
       // Check for unsafe size
       if ((UNSAFE_size === 'large' || UNSAFE_size === 'xlarge') && (UNSAFE_propName === 'UNSAFE_iconAfter_size' || UNSAFE_propName === 'UNSAFE_iconBefore_size' || UNSAFE_propName === 'UNSAFE_size')) {
         (0, _helpers.createCantMigrateUnsafeProp)(node, UNSAFE_propName, UNSAFE_size, legacyIconImports[name].packageName, name, errorsManual);
@@ -362,14 +371,14 @@ var createChecks = exports.createChecks = function createChecks(context) {
         hasManualMigration = true;
       }
       var migrationMapObject = (0, _helpers.getMigrationMapObject)(legacyIconImports[name].packageName);
-      var iconKey = (0, _helpers.getIconKey)(legacyIconImports[name].packageName);
       var newIcon = migrationMapObject === null || migrationMapObject === void 0 ? void 0 : migrationMapObject.newIcon;
       var isNewIconMigratable = (0, _helpers.canAutoMigrateNewIconBasedOnSize)(migrationMapObject === null || migrationMapObject === void 0 ? void 0 : migrationMapObject.sizeGuidance[(_size = size) !== null && _size !== void 0 ? _size : 'medium']);
       if (!hasManualMigration && newIcon && isNewIconMigratable) {
-        (0, _helpers.createAutoMigrationError)(node, legacyIconImports[name].packageName, name, newIcon, iconKey, errorsAuto);
+        (0, _helpers.createAutoMigrationError)(node, legacyIconImports[name].packageName, name, errorsAuto);
       } else if ((!newIcon || !isNewIconMigratable) && size) {
-        (0, _helpers.createCantFindSuitableReplacementError)(node, legacyIconImports[name].packageName, name, errorsManual);
+        (0, _helpers.createCantFindSuitableReplacementError)(node, legacyIconImports[name].packageName, name, errorsManual, migrationMapObject ? true : false);
       }
+      guidance[(0, _helpers.locToString)(node)] = (0, _helpers.createGuidance)(legacyIconImports[name].packageName, insideNewButton, size && (0, _migrationMapTemp.isSize)(size) ? size : undefined);
     }
   };
 
@@ -379,20 +388,20 @@ var createChecks = exports.createChecks = function createChecks(context) {
    */
   var checkCallExpression = function checkCallExpression(node) {
     if ('arguments' in node && node.arguments.length) {
-      var _iterator7 = _createForOfIteratorHelper(node.arguments),
-        _step7;
+      var _iterator8 = _createForOfIteratorHelper(node.arguments),
+        _step8;
       try {
-        for (_iterator7.s(); !(_step7 = _iterator7.n()).done;) {
-          var arg = _step7.value;
+        for (_iterator8.s(); !(_step8 = _iterator8.n()).done;) {
+          var arg = _step8.value;
           if ((0, _eslintCodemodUtils.isNodeOfType)(arg, 'Identifier') && arg.name in legacyIconImports && legacyIconImports[arg.name].packageName) {
             (0, _helpers.createCantMigrateFunctionUnknownError)(node, legacyIconImports[arg.name].packageName, arg.name, errorsManual);
             guidance[(0, _helpers.locToString)(node)] = (0, _helpers.createGuidance)(legacyIconImports[arg.name].packageName);
           }
         }
       } catch (err) {
-        _iterator7.e(err);
+        _iterator8.e(err);
       } finally {
-        _iterator7.f();
+        _iterator8.f();
       }
     }
   };
@@ -408,36 +417,28 @@ var createChecks = exports.createChecks = function createChecks(context) {
           errorList = _Object$entries$_i[1];
         var node = 'node' in errorList.errors[0] ? errorList.errors[0].node : null;
         if (node) {
+          var guidanceMessage = _key in guidance ? guidance[_key] : '';
           context.report({
             node: node,
             messageId: 'noLegacyIconsManualMigration',
             data: {
               iconName: errorList.iconName,
               importSource: errorList.importSource,
-              quietModeGuidance: isQuietMode ? 'For more information see the below errors:' : ''
+              guidance: isQuietMode ? guidanceMessage : "".concat(guidanceMessage, "For more information see the below errors.\n")
             }
           });
           if (!isQuietMode) {
-            var _iterator8 = _createForOfIteratorHelper(errorList.errors),
-              _step8;
+            var _iterator9 = _createForOfIteratorHelper(errorList.errors),
+              _step9;
             try {
-              for (_iterator8.s(); !(_step8 = _iterator8.n()).done;) {
-                var error = _step8.value;
+              for (_iterator9.s(); !(_step9 = _iterator9.n()).done;) {
+                var error = _step9.value;
                 context.report(error);
               }
             } catch (err) {
-              _iterator8.e(err);
+              _iterator9.e(err);
             } finally {
-              _iterator8.f();
-            }
-            if (_key in guidance) {
-              context.report({
-                node: node,
-                messageId: 'guidance',
-                data: {
-                  guidance: guidance[_key]
-                }
-              });
+              _iterator9.f();
             }
           }
         }
@@ -456,16 +457,11 @@ var createChecks = exports.createChecks = function createChecks(context) {
         }
         var _node = 'node' in _error ? _error.node : null;
         if (_node) {
-          context.report(_error);
-          if (_key2 in guidance && !isQuietMode) {
-            context.report({
-              node: _node,
-              messageId: 'guidance',
-              data: {
-                guidance: guidance[_key2]
-              }
-            });
+          var _guidanceMessage = _key2 in guidance ? guidance[_key2] : '';
+          if ('data' in _error && _error.data) {
+            _error.data.guidance = _guidanceMessage;
           }
+          context.report(_error);
         }
       }
     }

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

@@ -5,7 +5,7 @@ var _typeof = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.locToString = exports.getMigrationMapObject = exports.getLiteralStringValue = exports.getIconKey = exports.findUNSAFEProp = exports.createHelpers = exports.createGuidance = exports.createCantMigrateUnsafeProp = exports.createCantMigrateSpreadPropsError = exports.createCantMigrateSizeUnknown = exports.createCantMigrateReExportError = exports.createCantMigrateIdentifierError = exports.createCantMigrateFunctionUnknownError = exports.createCantMigrateColorError = exports.createCantFindSuitableReplacementError = exports.createAutoMigrationError = exports.canMigrateColor = exports.canAutoMigrateNewIconBasedOnSize = void 0;
+exports.locToString = exports.getMigrationMapObject = exports.getLiteralStringValue = exports.findUNSAFEProp = exports.createHelpers = exports.createGuidance = exports.createCantMigrateUnsafeProp = exports.createCantMigrateSpreadPropsError = exports.createCantMigrateSizeUnknown = exports.createCantMigrateReExportError = exports.createCantMigrateIdentifierError = exports.createCantMigrateFunctionUnknownError = exports.createCantMigrateColorError = exports.createCantFindSuitableReplacementError = exports.createAutoMigrationError = exports.canMigrateColor = exports.canAutoMigrateNewIconBasedOnSize = void 0;
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _eslintCodemodUtils = require("eslint-codemod-utils");
 var _getImportName = require("../utils/get-import-name");
@@ -30,7 +30,7 @@ var getMigrationMapObject = exports.getMigrationMapObject = function getMigratio
  * @param iconPackage The name of the legacy icon package
  * @returns The unique identifier for the icon (the part after "@atlaskit/icon/glyph")
  */
-var getIconKey = exports.getIconKey = function getIconKey(iconPackage) {
+var getIconKey = function getIconKey(iconPackage) {
   var key = iconPackage.replace(/^@atlaskit\/icon\/glyph\//, '');
   return key;
 };
@@ -45,39 +45,48 @@ var canAutoMigrateNewIconBasedOnSize = exports.canAutoMigrateNewIconBasedOnSize
 /**
  * Creates the written guidance for migrating a legacy icon to a new icon
  */
-var createGuidance = exports.createGuidance = function createGuidance(iconPackage, size) {
+var createGuidance = exports.createGuidance = function createGuidance(iconPackage) {
+  var insideNewButton = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+  var size = arguments.length > 2 ? arguments[2] : undefined;
   var migrationMapObject = getMigrationMapObject(iconPackage);
   if (migrationMapObject) {
     var newIcon = migrationMapObject.newIcon;
     if (!newIcon) {
       return 'No equivalent icon in new set. An option is to contribute a custom icon into icon-labs package instead.\n';
     }
+    var buttonGuidanceStr = "Please set 'spacing' property of the new icon to 'none', to ensure appropriate spacing inside `@atlaskit/button`.\n";
+    var guidance = '';
     if (size) {
-      var guidance = "Fix: Use ".concat(newIcon.name, " from @atlaskit/").concat(newIcon.library, "/").concat(newIcon.type, "/").concat(newIcon.name, " instead.");
-      if (migrationMapObject.sizeGuidance[size] in _migrationMapTemp.outcomeDescriptionMap) {
-        guidance += " Please: ".concat(_migrationMapTemp.outcomeDescriptionMap[migrationMapObject.sizeGuidance[size]], "\n");
+      if (migrationMapObject.sizeGuidance[size] && canAutoMigrateNewIconBasedOnSize(migrationMapObject.sizeGuidance[size])) {
+        guidance += "Fix: Use ".concat(newIcon.name, " from @atlaskit/").concat(newIcon.library, "/").concat(newIcon.type, "/").concat(newIcon.name, " instead.");
       } else {
-        guidance += ' No migration advice given.\n';
+        guidance += "No equivalent icon for this size, ".concat(size, ", in new set.");
       }
-      return guidance;
+      guidance += "".concat(migrationMapObject.sizeGuidance[size] in _migrationMapTemp.outcomeDescriptionMap ? " Please: ".concat(_migrationMapTemp.outcomeDescriptionMap[migrationMapObject.sizeGuidance[size]]) : ' No migration size advice given.', "\n");
     } else {
-      var _guidance = "Use ".concat(newIcon.name, " from @atlaskit/").concat(newIcon.library, "/").concat(newIcon.type, "/").concat(newIcon.name, " instead.\nMigration suggestions, depending on the legacy icon size:\n");
+      guidance = "Use ".concat(newIcon.name, " from @atlaskit/").concat(newIcon.library, "/").concat(newIcon.type, "/").concat(newIcon.name, " instead.\nMigration suggestions, depending on the legacy icon size:\n");
       for (var _i = 0, _Object$entries = Object.entries(migrationMapObject.sizeGuidance); _i < _Object$entries.length; _i++) {
         var _Object$entries$_i = (0, _slicedToArray2.default)(_Object$entries[_i], 2),
           _size = _Object$entries$_i[0],
           value = _Object$entries$_i[1];
-        _guidance += "\t- ".concat(_size, ": ");
+        guidance += "\t- ".concat(_size, ": ");
         if (!(value in _migrationMapTemp.outcomeDescriptionMap)) {
-          _guidance += 'No migration advice given.\n';
+          guidance += 'No migration advice given.\n';
         } else {
-          _guidance += "".concat(_migrationMapTemp.outcomeDescriptionMap[value], "\n");
+          guidance += "".concat(_migrationMapTemp.outcomeDescriptionMap[value], ".\n");
         }
-        _guidance;
       }
-      return _guidance;
     }
+    if (insideNewButton) {
+      guidance += buttonGuidanceStr;
+    } else if (size && size === 'medium') {
+      guidance += "Setting the spacing property to 'spacious' will maintain the icon's box dimensions - but consider setting spacing='none' as it allows for easier control of spacing by parent elements.\n";
+    } else if (size) {
+      guidance += "In the new icon, please use spacing='none'.\n";
+    }
+    return guidance;
   } else {
-    return 'Migration suggestions not found\n';
+    return "Migration suggestions not found for \"".concat(iconPackage, "\".\n");
   }
 };
 
@@ -155,13 +164,14 @@ var createCantMigrateUnsafeProp = exports.createCantMigrateUnsafeProp = function
   };
   pushManualError(locToString(node), errors, myError, packageName, iconName);
 };
-var createCantFindSuitableReplacementError = exports.createCantFindSuitableReplacementError = function createCantFindSuitableReplacementError(node, importSource, iconName, errors) {
+var createCantFindSuitableReplacementError = exports.createCantFindSuitableReplacementError = function createCantFindSuitableReplacementError(node, importSource, iconName, errors, sizeIssue) {
   var myError = {
     node: node,
     messageId: 'cantFindSuitableReplacement',
     data: {
       importSource: importSource,
-      iconName: iconName
+      iconName: iconName,
+      sizeGuidance: sizeIssue ? ' at the current size' : ''
     }
   };
   pushManualError(locToString(node), errors, myError, importSource, iconName);
@@ -204,18 +214,13 @@ var createCantMigrateSizeUnknown = exports.createCantMigrateSizeUnknown = functi
   };
   pushManualError(locToString(node), errors, myError, importSource, iconName);
 };
-var createAutoMigrationError = exports.createAutoMigrationError = function createAutoMigrationError(node, importSource, iconName, newIcon, oldIconName, errors) {
-  var migrationKey = newIcon.name === oldIconName ? newIcon.name : "".concat(newIcon.name, "--").concat(oldIconName);
-  var newMigrationIconPackage = "@atlaskit/".concat(newIcon.library, "/").concat(newIcon.type, "/migration/").concat(migrationKey);
+var createAutoMigrationError = exports.createAutoMigrationError = function createAutoMigrationError(node, importSource, iconName, errors) {
   var myError = {
     node: node,
     messageId: 'noLegacyIconsAutoMigration',
     data: {
       importSource: importSource,
-      iconName: iconName,
-      newIcon: newIcon.name,
-      //TODO: provide size guidance
-      newPackage: newMigrationIconPackage
+      iconName: iconName
     }
   };
   errors[locToString(node)] = myError;

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

@@ -33,17 +33,16 @@ var rule = (0, _createRule.createLintRule)({
       additionalProperties: false
     }],
     messages: {
-      noLegacyIconsAutoMigration: "Auto Migration:\nLegacy icon '{{iconName}}' from '{{importSource}}' detected.\nAutomatic migration is possible to '{{newIcon}}' from '{{newPackage}}.\nAtlassians: See https://go.atlassian.com/icon-migration-guide for details.'",
-      noLegacyIconsManualMigration: "Manual Migration:\nLegacy icon '{{iconName}}' from '{{importSource}}' detected.\nAutomatic migration not possible.{{quietModeGuidance}}.\nAtlassians: See https://go.atlassian.com/icon-migration-guide for details.",
-      cantFindSuitableReplacement: "No suitable replacement found for '{{iconName}}' from '{{importSource}}' at the size listed. Please manually migrate this icon.",
+      noLegacyIconsAutoMigration: "Auto Migration:\nLegacy icon '{{iconName}}' from '{{importSource}}' detected.\nAutomatic migration is possible.\n\n{{guidance}}\nAtlassians: See https://go.atlassian.com/icon-migration-guide for details.'",
+      noLegacyIconsManualMigration: "Manual Migration:\nLegacy icon '{{iconName}}' from '{{importSource}}' detected.\nAutomatic migration not possible.\n\n{{guidance}}\nAtlassians: See https://go.atlassian.com/icon-migration-guide for details.",
+      cantFindSuitableReplacement: "No suitable replacement found for '{{iconName}}' from '{{importSource}}'{{sizeGuidance}}. Please manually migrate this icon.",
       cantMigrateReExport: "'{{exportName}}' is a re-export of icon from '{{packageName}}' and cannot be automatically migrated. Please utilize the export from icons directly.",
       cantMigrateColor: "Primary Color prop has {{colorValue}} which cannot be automatically migrated to color prop in the new Icon API. Please use either an appropriate color.icon, color.link token, or currentColor (as a last resort).",
       cantMigrateSpreadProps: "This usage of Icon uses spread props in a way that can't be automatically migrated. Please explicitly define the following props after spread: '{{missingProps}}' ",
       cantMigrateSizeUnknown: "This usage of Icon sets the size via a variable or function that can't be determined.",
       cantMigrateFunctionUnknown: "'{{iconName}}' from legacy '{{importSource}}' is used in unknown function/component. Please manually migrate this icon.",
       cantMigrateIdentifier: "This icon is passed to other components via a map or array, in a way that can't be automatically migrated. Please manually migrate wherever this expression is used and use the icon components directly.",
-      cantMigrateUnsafeProp: "Property '{{propName}}' with value of '{{value}}' is unable to be auto-migrated to the new button. Please manually migrate this icon.",
-      guidance: "Guidance:\n'{{guidance}}'"
+      cantMigrateUnsafeProp: "Property '{{propName}}' with value of '{{value}}' is unable to be auto-migrated to the new button. Please manually migrate this icon."
     }
   },
   create: function create(context) {

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

@@ -1,5 +1,5 @@
 import { isNodeOfType } from 'eslint-codemod-utils';
-import { canAutoMigrateNewIconBasedOnSize, canMigrateColor, createAutoMigrationError, createCantFindSuitableReplacementError, createCantMigrateColorError, createCantMigrateFunctionUnknownError, createCantMigrateIdentifierError, createCantMigrateReExportError, createCantMigrateSizeUnknown, createCantMigrateSpreadPropsError, createCantMigrateUnsafeProp, createGuidance, createHelpers, findUNSAFEProp, getIconKey, getMigrationMapObject, locToString } from './helpers';
+import { canAutoMigrateNewIconBasedOnSize, canMigrateColor, createAutoMigrationError, createCantFindSuitableReplacementError, createCantMigrateColorError, createCantMigrateFunctionUnknownError, createCantMigrateIdentifierError, createCantMigrateReExportError, createCantMigrateSizeUnknown, createCantMigrateSpreadPropsError, createCantMigrateUnsafeProp, createGuidance, createHelpers, findUNSAFEProp, getMigrationMapObject, locToString } from './helpers';
 import { isSize } from './migration-map-temp';
 export const createChecks = context => {
   //create global variables to be shared by the checks
@@ -100,15 +100,17 @@ export const createChecks = context => {
     if (node.source && isNodeOfType(node.source, 'Literal') && 'value' in node.source) {
       const moduleSource = node.source.value;
       if (typeof moduleSource === 'string' && ['@atlaskit/icon/glyph/', '@atlaskit/icon-object/glyph/'].find(val => moduleSource.startsWith(val)) && node.specifiers.length) {
-        createCantMigrateReExportError(node, moduleSource, node.specifiers[0].exported.name, errorsManual);
-        guidance[locToString(node)] = createGuidance(moduleSource);
+        for (const spec of node.specifiers) {
+          createCantMigrateReExportError(spec, moduleSource, spec.exported.name, errorsManual);
+          guidance[locToString(spec)] = createGuidance(moduleSource);
+        }
       }
     } else if (node.declaration && isNodeOfType(node.declaration, 'VariableDeclaration')) {
       // export const Icon = AddIcon;
       for (const decl of node.declaration.declarations) {
         if (isNodeOfType(decl, 'VariableDeclarator') && 'init' in decl && decl.init && isNodeOfType(decl.init, 'Identifier') && decl.init.name in legacyIconImports) {
           createCantMigrateReExportError(node, legacyIconImports[decl.init.name].packageName, decl.init.name, errorsManual);
-          guidance[locToString(node)] = createGuidance(createGuidance(legacyIconImports[decl.init.name].packageName));
+          guidance[locToString(node)] = createGuidance(legacyIconImports[decl.init.name].packageName);
         }
       }
     } else if (!node.source && node.specifiers && node.specifiers.length > 0) {
@@ -174,18 +176,17 @@ export const createChecks = context => {
         UNSAFE_propName = result.UNSAFE_propName;
       }
       if (newIcon && isInNewButton && isNewIconMigratable && UNSAFE_size !== 'large' && UNSAFE_size !== 'xlarge') {
-        const iconKey = getIconKey(legacyIconImports[node.name].packageName);
-        createAutoMigrationError(node, legacyIconImports[node.name].packageName, node.name, newIcon, iconKey, errorsAuto);
-        guidance[locToString(node)] = createGuidance(legacyIconImports[node.name].packageName, 'medium');
+        createAutoMigrationError(node, legacyIconImports[node.name].packageName, node.name, errorsAuto);
+        guidance[locToString(node)] = createGuidance(legacyIconImports[node.name].packageName, isInNewButton, 'medium');
       } else if ((!newIcon || !isNewIconMigratable) && !UNSAFE_size) {
         createCantFindSuitableReplacementError(node, legacyIconImports[node.name].packageName, node.name, errorsManual);
-        guidance[locToString(node)] = createGuidance(legacyIconImports[node.name].packageName);
+        guidance[locToString(node)] = createGuidance(legacyIconImports[node.name].packageName, isInNewButton);
       } else if ((UNSAFE_size === 'large' || UNSAFE_size === 'xlarge') && UNSAFE_propName) {
         createCantMigrateUnsafeProp(node, UNSAFE_propName, UNSAFE_size, legacyIconImports[node.name].packageName, node.name, errorsManual);
-        guidance[locToString(node)] = createGuidance(legacyIconImports[node.name].packageName, UNSAFE_size);
+        guidance[locToString(node)] = createGuidance(legacyIconImports[node.name].packageName, isInNewButton, UNSAFE_size);
       } else if (!isInNewButton) {
         createCantMigrateFunctionUnknownError(node, legacyIconImports[node.name].packageName, node.name, errorsManual);
-        guidance[locToString(node)] = createGuidance(legacyIconImports[node.name].packageName);
+        guidance[locToString(node)] = createGuidance(legacyIconImports[node.name].packageName, isInNewButton);
       }
     }
   };
@@ -272,7 +273,6 @@ export const createChecks = context => {
         createCantMigrateSizeUnknown(node, errorsManual, legacyIconImports[name].packageName, name);
         hasManualMigration = true;
       }
-      guidance[locToString(node)] = createGuidance(legacyIconImports[name].packageName, size ? size : undefined);
       // Check for unsafe size
       if ((UNSAFE_size === 'large' || UNSAFE_size === 'xlarge') && (UNSAFE_propName === 'UNSAFE_iconAfter_size' || UNSAFE_propName === 'UNSAFE_iconBefore_size' || UNSAFE_propName === 'UNSAFE_size')) {
         createCantMigrateUnsafeProp(node, UNSAFE_propName, UNSAFE_size, legacyIconImports[name].packageName, name, errorsManual);
@@ -290,14 +290,14 @@ export const createChecks = context => {
         hasManualMigration = true;
       }
       const migrationMapObject = getMigrationMapObject(legacyIconImports[name].packageName);
-      const iconKey = getIconKey(legacyIconImports[name].packageName);
       const newIcon = migrationMapObject === null || migrationMapObject === void 0 ? void 0 : migrationMapObject.newIcon;
       const isNewIconMigratable = canAutoMigrateNewIconBasedOnSize(migrationMapObject === null || migrationMapObject === void 0 ? void 0 : migrationMapObject.sizeGuidance[(_size = size) !== null && _size !== void 0 ? _size : 'medium']);
       if (!hasManualMigration && newIcon && isNewIconMigratable) {
-        createAutoMigrationError(node, legacyIconImports[name].packageName, name, newIcon, iconKey, errorsAuto);
+        createAutoMigrationError(node, legacyIconImports[name].packageName, name, errorsAuto);
       } else if ((!newIcon || !isNewIconMigratable) && size) {
-        createCantFindSuitableReplacementError(node, legacyIconImports[name].packageName, name, errorsManual);
+        createCantFindSuitableReplacementError(node, legacyIconImports[name].packageName, name, errorsManual, migrationMapObject ? true : false);
       }
+      guidance[locToString(node)] = createGuidance(legacyIconImports[name].packageName, insideNewButton, size && isSize(size) ? size : undefined);
     }
   };
 
@@ -324,28 +324,20 @@ export const createChecks = context => {
       for (const [key, errorList] of Object.entries(errorsManual)) {
         const node = 'node' in errorList.errors[0] ? errorList.errors[0].node : null;
         if (node) {
+          const guidanceMessage = key in guidance ? guidance[key] : '';
           context.report({
             node,
             messageId: 'noLegacyIconsManualMigration',
             data: {
               iconName: errorList.iconName,
               importSource: errorList.importSource,
-              quietModeGuidance: isQuietMode ? 'For more information see the below errors:' : ''
+              guidance: isQuietMode ? guidanceMessage : `${guidanceMessage}For more information see the below errors.\n`
             }
           });
           if (!isQuietMode) {
             for (const error of errorList.errors) {
               context.report(error);
             }
-            if (key in guidance) {
-              context.report({
-                node,
-                messageId: 'guidance',
-                data: {
-                  guidance: guidance[key]
-                }
-              });
-            }
           }
         }
       }
@@ -360,16 +352,11 @@ export const createChecks = context => {
         }
         const node = 'node' in error ? error.node : null;
         if (node) {
-          context.report(error);
-          if (key in guidance && !isQuietMode) {
-            context.report({
-              node,
-              messageId: 'guidance',
-              data: {
-                guidance: guidance[key]
-              }
-            });
+          const guidanceMessage = key in guidance ? guidance[key] : '';
+          if ('data' in error && error.data) {
+            error.data.guidance = guidanceMessage;
           }
+          context.report(error);
         }
       }
     }