@atlaskit/eslint-plugin-design-system 10.12.3 → 10.12.4

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/eslint-plugin-design-system
 
+## 10.12.4
+
+### Patch Changes
+
+- [#126974](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/126974)
+  [`bf10ab6817404`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/bf10ab6817404) -
+  Updates the no-legacy-icons eslint rule to account for upcoming icons.
+
 ## 10.12.3
 
 ### Patch Changes

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

@@ -232,13 +232,14 @@ var createChecks = exports.createChecks = function createChecks(context) {
     if (node.name in legacyIconImports && (0, _eslintCodemodUtils.isNodeOfType)(node.parent.parent.name, 'JSXIdentifier') && node.parent.parent.name.name !== 'LEGACY_fallbackIcon') {
       var _migrationMapObject$s;
       var migrationMapObject = (0, _helpers.getMigrationMapObject)(legacyIconImports[node.name].packageName);
+      var upcomingIcon = (0, _helpers.getUpcomingIcons)(legacyIconImports[node.name].packageName);
       var newIcon = migrationMapObject === null || migrationMapObject === void 0 ? void 0 : migrationMapObject.newIcon;
-      var isNewIconMigratable = (0, _helpers.canAutoMigrateNewIconBasedOnSize)(migrationMapObject === null || migrationMapObject === void 0 || (_migrationMapObject$s = migrationMapObject.sizeGuidance) === null || _migrationMapObject$s === void 0 ? void 0 : _migrationMapObject$s.medium);
+      var isNewIconMigratable = (0, _helpers.canAutoMigrateNewIconBasedOnSize)(upcomingIcon ? upcomingIcon.sizeGuidance.medium : migrationMapObject === null || migrationMapObject === void 0 || (_migrationMapObject$s = migrationMapObject.sizeGuidance) === null || _migrationMapObject$s === void 0 ? void 0 : _migrationMapObject$s.medium);
       var isInNewButton = (0, _eslintCodemodUtils.isNodeOfType)(node.parent.parent.parent.name, 'JSXIdentifier') && newButtonImports.has(node.parent.parent.parent.name.name);
-      if (newIcon && isInNewButton && isNewIconMigratable) {
+      if (newIcon && isInNewButton && isNewIconMigratable || upcomingIcon && isInNewButton && isNewIconMigratable) {
         (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) {
+      } else if (!newIcon && !upcomingIcon || !isNewIconMigratable) {
         (0, _helpers.createCantFindSuitableReplacementError)(node, legacyIconImports[node.name].packageName, node.name, errorsManual);
         guidance[(0, _helpers.locToString)(node)] = (0, _helpers.createGuidance)(legacyIconImports[node.name].packageName, isInNewButton);
       } else if (!isInNewButton) {
@@ -265,7 +266,7 @@ var createChecks = exports.createChecks = function createChecks(context) {
     var name = node.openingElement.name.name;
     // Legacy icons rendered as JSX elements
     if (name in legacyIconImports) {
-      var _node$parent2, _node$parent3, _size;
+      var _node$parent2, _node$parent3, _size, _size2;
       // Determine if inside a new button - if so:
       // - Assume spread props are safe - still error if props explicitly set to unmigratable values
       var insideNewButton = false;
@@ -349,12 +350,13 @@ var createChecks = exports.createChecks = function createChecks(context) {
         hasManualMigration = true;
       }
       var migrationMapObject = (0, _helpers.getMigrationMapObject)(legacyIconImports[name].packageName);
+      var upcomingIcon = (0, _helpers.getUpcomingIcons)(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) {
+      var isNewIconMigratable = (0, _helpers.canAutoMigrateNewIconBasedOnSize)(upcomingIcon ? upcomingIcon.sizeGuidance[(_size = size) !== null && _size !== void 0 ? _size : 'medium'] : migrationMapObject === null || migrationMapObject === void 0 ? void 0 : migrationMapObject.sizeGuidance[(_size2 = size) !== null && _size2 !== void 0 ? _size2 : 'medium']);
+      if (!hasManualMigration && (newIcon || upcomingIcon) && isNewIconMigratable) {
         (0, _helpers.createAutoMigrationError)(node, legacyIconImports[name].packageName, name, errorsAuto);
-      } else if ((!newIcon || !isNewIconMigratable) && size) {
-        (0, _helpers.createCantFindSuitableReplacementError)(node, legacyIconImports[name].packageName, name, errorsManual, migrationMapObject ? true : false);
+      } else if ((!newIcon && !upcomingIcon || !isNewIconMigratable) && size) {
+        (0, _helpers.createCantFindSuitableReplacementError)(node, legacyIconImports[name].packageName, name, errorsManual, upcomingIcon ? true : migrationMapObject ? true : false);
       }
       guidance[(0, _helpers.locToString)(node)] = (0, _helpers.createGuidance)(legacyIconImports[name].packageName, insideNewButton, size && (0, _helpers.isSize)(size) ? size : undefined);
     }

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

@@ -5,11 +5,12 @@ var _typeof = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.locToString = exports.isSize = exports.getMigrationMapObject = exports.getLiteralStringValue = exports.createHelpers = exports.createGuidance = 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.isSize = exports.getUpcomingIcons = exports.getMigrationMapObject = exports.getLiteralStringValue = exports.createHelpers = exports.createGuidance = 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 _UNSAFE_migrationMap = _interopRequireWildcard(require("@atlaskit/icon/UNSAFE_migration-map"));
 var _getImportName = require("../utils/get-import-name");
+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; }
 var sizes = ['small', 'medium', 'large', 'xlarge'];
@@ -24,11 +25,26 @@ var isSize = exports.isSize = function isSize(size) {
  */
 var getMigrationMapObject = exports.getMigrationMapObject = function getMigrationMapObject(iconPackage) {
   var key = getIconKey(iconPackage);
-  if (key in _UNSAFE_migrationMap.default) {
+  if (Object.keys(_UNSAFE_migrationMap.default).includes(key)) {
     return _UNSAFE_migrationMap.default[key];
   }
   return null;
 };
+var getUpcomingIcons = exports.getUpcomingIcons = function getUpcomingIcons(iconPackage) {
+  var key = getIconKey(iconPackage);
+  if (_upcomingIcons.upcomingIcons.includes(key)) {
+    var retval = {
+      sizeGuidance: {
+        small: 'swap',
+        medium: 'swap',
+        large: 'icon-tile',
+        xlarge: 'icon-tile'
+      }
+    };
+    return retval;
+  }
+  return null;
+};
 
 /**
  * Returns the key of a legacy icon
@@ -54,42 +70,67 @@ var createGuidance = exports.createGuidance = function createGuidance(iconPackag
   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 upcomingIcon = getUpcomingIcons(iconPackage);
+  if (upcomingIcon) {
+    var guidance = '';
+    if (size) {
+      if (upcomingIcon.sizeGuidance[size] && canAutoMigrateNewIconBasedOnSize(upcomingIcon.sizeGuidance[size])) {
+        guidance += "Fix: An upcoming icon release is planned to migrate this legacy icon.";
+      } else {
+        guidance += "No equivalent icon for this size, ".concat(size, ", in the current or upcoming set of icons.");
+      }
+      guidance += "".concat(Object.keys(_UNSAFE_migrationMap.migrationOutcomeDescriptionMap).includes(upcomingIcon.sizeGuidance[size]) ? " Once the upcoming icons are released, please: ".concat(_UNSAFE_migrationMap.migrationOutcomeDescriptionMap[upcomingIcon.sizeGuidance[size]]) : ' No migration size advice given.', "\n");
+    } else {
+      guidance = "Please wait for the upcoming icons released, as it will contain an alternative for this legacy icon.\nMigration suggestions, depending on the legacy icon size:\n";
+      for (var _i = 0, _Object$entries = Object.entries(upcomingIcon.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, ": ");
+        if (!Object.keys(_UNSAFE_migrationMap.migrationOutcomeDescriptionMap).includes(value)) {
+          guidance += 'No migration advice given.\n';
+        } else {
+          guidance += "".concat(_UNSAFE_migrationMap.migrationOutcomeDescriptionMap[value], ".\n");
+        }
+      }
+    }
+    return guidance;
+  } else 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 = '';
+    var _guidance = '';
     if (size) {
       if (migrationMapObject.sizeGuidance[size] && canAutoMigrateNewIconBasedOnSize(migrationMapObject.sizeGuidance[size])) {
-        guidance += "Fix: Use ".concat(newIcon.name, " from ").concat(newIcon.package, "/").concat(newIcon.type, "/").concat(newIcon.name, " instead.");
+        _guidance += "Fix: Use ".concat(newIcon.name, " from ").concat(newIcon.package, "/").concat(newIcon.type, "/").concat(newIcon.name, " instead.");
       } else {
-        guidance += "No equivalent icon for this size, ".concat(size, ", in new set.");
+        _guidance += "No equivalent icon for this size, ".concat(size, ", in new set.");
       }
-      guidance += "".concat(migrationMapObject.sizeGuidance[size] in _UNSAFE_migrationMap.migrationOutcomeDescriptionMap ? " Please: ".concat(_UNSAFE_migrationMap.migrationOutcomeDescriptionMap[migrationMapObject.sizeGuidance[size]]) : ' No migration size advice given.', "\n");
+      _guidance += "".concat(migrationMapObject.sizeGuidance[size] in _UNSAFE_migrationMap.migrationOutcomeDescriptionMap ? " Please: ".concat(_UNSAFE_migrationMap.migrationOutcomeDescriptionMap[migrationMapObject.sizeGuidance[size]]) : ' No migration size advice given.', "\n");
     } else {
-      guidance = "Use ".concat(newIcon.name, " from ").concat(newIcon.package, "/").concat(newIcon.type, "/").concat(newIcon.name, " instead.\nMigration suggestions, depending on the legacy icon size:\n");
+      _guidance = "Use ".concat(newIcon.name, " from ").concat(newIcon.package, "/").concat(newIcon.type, "/").concat(newIcon.name, " instead.\nMigration suggestions, depending on the legacy icon size:\n");
       Object.entries(migrationMapObject.sizeGuidance).forEach(function (_ref) {
         var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
           size = _ref2[0],
           value = _ref2[1];
-        guidance += "\t- ".concat(size, ": ");
+        _guidance += "\t- ".concat(size, ": ");
         if (!(value in _UNSAFE_migrationMap.migrationOutcomeDescriptionMap)) {
-          guidance += 'No migration advice given.\n';
+          _guidance += 'No migration advice given.\n';
         } else {
-          guidance += "".concat(_UNSAFE_migrationMap.migrationOutcomeDescriptionMap[value], ".\n");
+          _guidance += "".concat(_UNSAFE_migrationMap.migrationOutcomeDescriptionMap[value], ".\n");
         }
       });
     }
     if (insideNewButton) {
-      guidance += buttonGuidanceStr;
+      _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";
+      _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";
+      _guidance += "In the new icon, please use spacing='none'.\n";
     }
-    return guidance;
+    return _guidance;
   } else {
     return "Migration suggestions not found for \"".concat(iconPackage, "\".\n");
   }

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

@@ -0,0 +1,7 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.upcomingIcons = void 0;
+var upcomingIcons = exports.upcomingIcons = ['app-switcher', 'check-circle-outline', 'export', 'file', 'flag-filled', 'lightbulb-filled', 'lock-filled', 'menu-expand', 'menu', 'notification-direct', 'notification', 'people-group', 'people', 'refresh', 'switcher', 'editor/align-image-center', 'editor/align-image-left', 'editor/align-image-right', 'editor/background-color', 'editor/bold', 'editor/indent', 'editor/italic', 'editor/horizontal-rule', 'editor-layout-three-equal', 'editor-layout-three-with-sidebars', 'editor/layout-two-equal', 'editor/layout-two-left-sidebars', 'editor/layout-two-right-sidebar', 'editor/media-center', 'editor/media-full-width', 'editor/media-wide', 'editor/number-list', 'emoji/activity', 'editor/file', 'emoji/flags', 'emoji/food', 'emoji/nature', 'emoji/people', 'emoji/productivity', 'emoji/travel', 'bitbucket/repos'];

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, createGuidance, createHelpers, getMigrationMapObject, isSize, locToString } from './helpers';
+import { canAutoMigrateNewIconBasedOnSize, canMigrateColor, createAutoMigrationError, createCantFindSuitableReplacementError, createCantMigrateColorError, createCantMigrateFunctionUnknownError, createCantMigrateIdentifierError, createCantMigrateReExportError, createCantMigrateSizeUnknown, createCantMigrateSpreadPropsError, createGuidance, createHelpers, getMigrationMapObject, getUpcomingIcons, isSize, locToString } from './helpers';
 export const createChecks = context => {
   //create global variables to be shared by the checks
   const {
@@ -164,13 +164,14 @@ export const createChecks = context => {
     if (node.name in legacyIconImports && isNodeOfType(node.parent.parent.name, 'JSXIdentifier') && node.parent.parent.name.name !== 'LEGACY_fallbackIcon') {
       var _migrationMapObject$s;
       const migrationMapObject = getMigrationMapObject(legacyIconImports[node.name].packageName);
+      const upcomingIcon = getUpcomingIcons(legacyIconImports[node.name].packageName);
       const newIcon = migrationMapObject === null || migrationMapObject === void 0 ? void 0 : migrationMapObject.newIcon;
-      const isNewIconMigratable = canAutoMigrateNewIconBasedOnSize(migrationMapObject === null || migrationMapObject === void 0 ? void 0 : (_migrationMapObject$s = migrationMapObject.sizeGuidance) === null || _migrationMapObject$s === void 0 ? void 0 : _migrationMapObject$s.medium);
+      const isNewIconMigratable = canAutoMigrateNewIconBasedOnSize(upcomingIcon ? upcomingIcon.sizeGuidance.medium : migrationMapObject === null || migrationMapObject === void 0 ? void 0 : (_migrationMapObject$s = migrationMapObject.sizeGuidance) === null || _migrationMapObject$s === void 0 ? void 0 : _migrationMapObject$s.medium);
       const isInNewButton = isNodeOfType(node.parent.parent.parent.name, 'JSXIdentifier') && newButtonImports.has(node.parent.parent.parent.name.name);
-      if (newIcon && isInNewButton && isNewIconMigratable) {
+      if (newIcon && isInNewButton && isNewIconMigratable || upcomingIcon && isInNewButton && isNewIconMigratable) {
         createAutoMigrationError(node, legacyIconImports[node.name].packageName, node.name, errorsAuto);
         guidance[locToString(node)] = createGuidance(legacyIconImports[node.name].packageName, isInNewButton, 'medium');
-      } else if (!newIcon || !isNewIconMigratable) {
+      } else if (!newIcon && !upcomingIcon || !isNewIconMigratable) {
         createCantFindSuitableReplacementError(node, legacyIconImports[node.name].packageName, node.name, errorsManual);
         guidance[locToString(node)] = createGuidance(legacyIconImports[node.name].packageName, isInNewButton);
       } else if (!isInNewButton) {
@@ -197,7 +198,7 @@ export const createChecks = context => {
     const name = node.openingElement.name.name;
     // Legacy icons rendered as JSX elements
     if (name in legacyIconImports) {
-      var _node$parent2, _node$parent2$parent, _node$parent3, _node$parent3$parent, _node$parent3$parent$, _size;
+      var _node$parent2, _node$parent2$parent, _node$parent3, _node$parent3$parent, _node$parent3$parent$, _size, _size2;
       // Determine if inside a new button - if so:
       // - Assume spread props are safe - still error if props explicitly set to unmigratable values
       let insideNewButton = false;
@@ -268,12 +269,13 @@ export const createChecks = context => {
         hasManualMigration = true;
       }
       const migrationMapObject = getMigrationMapObject(legacyIconImports[name].packageName);
+      const upcomingIcon = getUpcomingIcons(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) {
+      const isNewIconMigratable = canAutoMigrateNewIconBasedOnSize(upcomingIcon ? upcomingIcon.sizeGuidance[(_size = size) !== null && _size !== void 0 ? _size : 'medium'] : migrationMapObject === null || migrationMapObject === void 0 ? void 0 : migrationMapObject.sizeGuidance[(_size2 = size) !== null && _size2 !== void 0 ? _size2 : 'medium']);
+      if (!hasManualMigration && (newIcon || upcomingIcon) && isNewIconMigratable) {
         createAutoMigrationError(node, legacyIconImports[name].packageName, name, errorsAuto);
-      } else if ((!newIcon || !isNewIconMigratable) && size) {
-        createCantFindSuitableReplacementError(node, legacyIconImports[name].packageName, name, errorsManual, migrationMapObject ? true : false);
+      } else if ((!newIcon && !upcomingIcon || !isNewIconMigratable) && size) {
+        createCantFindSuitableReplacementError(node, legacyIconImports[name].packageName, name, errorsManual, upcomingIcon ? true : migrationMapObject ? true : false);
       }
       guidance[locToString(node)] = createGuidance(legacyIconImports[name].packageName, insideNewButton, size && isSize(size) ? size : undefined);
     }

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

@@ -1,6 +1,7 @@
 import { isNodeOfType } from 'eslint-codemod-utils';
 import baseMigrationMap, { migrationOutcomeDescriptionMap } from '@atlaskit/icon/UNSAFE_migration-map';
 import { getImportName } from '../utils/get-import-name';
+import { upcomingIcons } from './upcoming-icons';
 const sizes = ['small', 'medium', 'large', 'xlarge'];
 export const isSize = size => sizes.includes(size);
 
@@ -11,11 +12,26 @@ export const isSize = size => sizes.includes(size);
  */
 export const getMigrationMapObject = iconPackage => {
   const key = getIconKey(iconPackage);
-  if (key in baseMigrationMap) {
+  if (Object.keys(baseMigrationMap).includes(key)) {
     return baseMigrationMap[key];
   }
   return null;
 };
+export const getUpcomingIcons = iconPackage => {
+  const key = getIconKey(iconPackage);
+  if (upcomingIcons.includes(key)) {
+    const retval = {
+      sizeGuidance: {
+        small: 'swap',
+        medium: 'swap',
+        large: 'icon-tile',
+        xlarge: 'icon-tile'
+      }
+    };
+    return retval;
+  }
+  return null;
+};
 
 /**
  * Returns the key of a legacy icon
@@ -39,7 +55,29 @@ export const canAutoMigrateNewIconBasedOnSize = guidance => {
  */
 export const createGuidance = (iconPackage, insideNewButton = false, size) => {
   const migrationMapObject = getMigrationMapObject(iconPackage);
-  if (migrationMapObject) {
+  const upcomingIcon = getUpcomingIcons(iconPackage);
+  if (upcomingIcon) {
+    let guidance = '';
+    if (size) {
+      if (upcomingIcon.sizeGuidance[size] && canAutoMigrateNewIconBasedOnSize(upcomingIcon.sizeGuidance[size])) {
+        guidance += `Fix: An upcoming icon release is planned to migrate this legacy icon.`;
+      } else {
+        guidance += `No equivalent icon for this size, ${size}, in the current or upcoming set of icons.`;
+      }
+      guidance += `${Object.keys(migrationOutcomeDescriptionMap).includes(upcomingIcon.sizeGuidance[size]) ? ` Once the upcoming icons are released, please: ${migrationOutcomeDescriptionMap[upcomingIcon.sizeGuidance[size]]}` : ' No migration size advice given.'}\n`;
+    } else {
+      guidance = `Please wait for the upcoming icons released, as it will contain an alternative for this legacy icon.\nMigration suggestions, depending on the legacy icon size:\n`;
+      for (const [size, value] of Object.entries(upcomingIcon.sizeGuidance)) {
+        guidance += `\t- ${size}: `;
+        if (!Object.keys(migrationOutcomeDescriptionMap).includes(value)) {
+          guidance += 'No migration advice given.\n';
+        } else {
+          guidance += `${migrationOutcomeDescriptionMap[value]}.\n`;
+        }
+      }
+    }
+    return guidance;
+  } else if (migrationMapObject) {
     const 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';

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

@@ -0,0 +1 @@
+export const upcomingIcons = ['app-switcher', 'check-circle-outline', 'export', 'file', 'flag-filled', 'lightbulb-filled', 'lock-filled', 'menu-expand', 'menu', 'notification-direct', 'notification', 'people-group', 'people', 'refresh', 'switcher', 'editor/align-image-center', 'editor/align-image-left', 'editor/align-image-right', 'editor/background-color', 'editor/bold', 'editor/indent', 'editor/italic', 'editor/horizontal-rule', 'editor-layout-three-equal', 'editor-layout-three-with-sidebars', 'editor/layout-two-equal', 'editor/layout-two-left-sidebars', 'editor/layout-two-right-sidebar', 'editor/media-center', 'editor/media-full-width', 'editor/media-wide', 'editor/number-list', 'emoji/activity', 'editor/file', 'emoji/flags', 'emoji/food', 'emoji/nature', 'emoji/people', 'emoji/productivity', 'emoji/travel', 'bitbucket/repos'];

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

@@ -3,7 +3,7 @@ function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol
 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; }
 import { isNodeOfType } from 'eslint-codemod-utils';
-import { canAutoMigrateNewIconBasedOnSize, canMigrateColor, createAutoMigrationError, createCantFindSuitableReplacementError, createCantMigrateColorError, createCantMigrateFunctionUnknownError, createCantMigrateIdentifierError, createCantMigrateReExportError, createCantMigrateSizeUnknown, createCantMigrateSpreadPropsError, createGuidance, createHelpers, getMigrationMapObject, isSize, locToString } from './helpers';
+import { canAutoMigrateNewIconBasedOnSize, canMigrateColor, createAutoMigrationError, createCantFindSuitableReplacementError, createCantMigrateColorError, createCantMigrateFunctionUnknownError, createCantMigrateIdentifierError, createCantMigrateReExportError, createCantMigrateSizeUnknown, createCantMigrateSpreadPropsError, createGuidance, createHelpers, getMigrationMapObject, getUpcomingIcons, isSize, locToString } from './helpers';
 export var createChecks = function createChecks(context) {
   //create global variables to be shared by the checks
   var _createHelpers = createHelpers(context),
@@ -225,13 +225,14 @@ export var createChecks = function createChecks(context) {
     if (node.name in legacyIconImports && isNodeOfType(node.parent.parent.name, 'JSXIdentifier') && node.parent.parent.name.name !== 'LEGACY_fallbackIcon') {
       var _migrationMapObject$s;
       var migrationMapObject = getMigrationMapObject(legacyIconImports[node.name].packageName);
+      var upcomingIcon = getUpcomingIcons(legacyIconImports[node.name].packageName);
       var newIcon = migrationMapObject === null || migrationMapObject === void 0 ? void 0 : migrationMapObject.newIcon;
-      var isNewIconMigratable = canAutoMigrateNewIconBasedOnSize(migrationMapObject === null || migrationMapObject === void 0 || (_migrationMapObject$s = migrationMapObject.sizeGuidance) === null || _migrationMapObject$s === void 0 ? void 0 : _migrationMapObject$s.medium);
+      var isNewIconMigratable = canAutoMigrateNewIconBasedOnSize(upcomingIcon ? upcomingIcon.sizeGuidance.medium : migrationMapObject === null || migrationMapObject === void 0 || (_migrationMapObject$s = migrationMapObject.sizeGuidance) === null || _migrationMapObject$s === void 0 ? void 0 : _migrationMapObject$s.medium);
       var isInNewButton = isNodeOfType(node.parent.parent.parent.name, 'JSXIdentifier') && newButtonImports.has(node.parent.parent.parent.name.name);
-      if (newIcon && isInNewButton && isNewIconMigratable) {
+      if (newIcon && isInNewButton && isNewIconMigratable || upcomingIcon && isInNewButton && isNewIconMigratable) {
         createAutoMigrationError(node, legacyIconImports[node.name].packageName, node.name, errorsAuto);
         guidance[locToString(node)] = createGuidance(legacyIconImports[node.name].packageName, isInNewButton, 'medium');
-      } else if (!newIcon || !isNewIconMigratable) {
+      } else if (!newIcon && !upcomingIcon || !isNewIconMigratable) {
         createCantFindSuitableReplacementError(node, legacyIconImports[node.name].packageName, node.name, errorsManual);
         guidance[locToString(node)] = createGuidance(legacyIconImports[node.name].packageName, isInNewButton);
       } else if (!isInNewButton) {
@@ -258,7 +259,7 @@ export var createChecks = function createChecks(context) {
     var name = node.openingElement.name.name;
     // Legacy icons rendered as JSX elements
     if (name in legacyIconImports) {
-      var _node$parent2, _node$parent3, _size;
+      var _node$parent2, _node$parent3, _size, _size2;
       // Determine if inside a new button - if so:
       // - Assume spread props are safe - still error if props explicitly set to unmigratable values
       var insideNewButton = false;
@@ -342,12 +343,13 @@ export var createChecks = function createChecks(context) {
         hasManualMigration = true;
       }
       var migrationMapObject = getMigrationMapObject(legacyIconImports[name].packageName);
+      var upcomingIcon = getUpcomingIcons(legacyIconImports[name].packageName);
       var newIcon = migrationMapObject === null || migrationMapObject === void 0 ? void 0 : migrationMapObject.newIcon;
-      var isNewIconMigratable = canAutoMigrateNewIconBasedOnSize(migrationMapObject === null || migrationMapObject === void 0 ? void 0 : migrationMapObject.sizeGuidance[(_size = size) !== null && _size !== void 0 ? _size : 'medium']);
-      if (!hasManualMigration && newIcon && isNewIconMigratable) {
+      var isNewIconMigratable = canAutoMigrateNewIconBasedOnSize(upcomingIcon ? upcomingIcon.sizeGuidance[(_size = size) !== null && _size !== void 0 ? _size : 'medium'] : migrationMapObject === null || migrationMapObject === void 0 ? void 0 : migrationMapObject.sizeGuidance[(_size2 = size) !== null && _size2 !== void 0 ? _size2 : 'medium']);
+      if (!hasManualMigration && (newIcon || upcomingIcon) && isNewIconMigratable) {
         createAutoMigrationError(node, legacyIconImports[name].packageName, name, errorsAuto);
-      } else if ((!newIcon || !isNewIconMigratable) && size) {
-        createCantFindSuitableReplacementError(node, legacyIconImports[name].packageName, name, errorsManual, migrationMapObject ? true : false);
+      } else if ((!newIcon && !upcomingIcon || !isNewIconMigratable) && size) {
+        createCantFindSuitableReplacementError(node, legacyIconImports[name].packageName, name, errorsManual, upcomingIcon ? true : migrationMapObject ? true : false);
       }
       guidance[locToString(node)] = createGuidance(legacyIconImports[name].packageName, insideNewButton, size && isSize(size) ? size : undefined);
     }

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

@@ -2,6 +2,7 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import { isNodeOfType } from 'eslint-codemod-utils';
 import baseMigrationMap, { migrationOutcomeDescriptionMap } from '@atlaskit/icon/UNSAFE_migration-map';
 import { getImportName } from '../utils/get-import-name';
+import { upcomingIcons } from './upcoming-icons';
 var sizes = ['small', 'medium', 'large', 'xlarge'];
 export var isSize = function isSize(size) {
   return sizes.includes(size);
@@ -14,11 +15,26 @@ export var isSize = function isSize(size) {
  */
 export var getMigrationMapObject = function getMigrationMapObject(iconPackage) {
   var key = getIconKey(iconPackage);
-  if (key in baseMigrationMap) {
+  if (Object.keys(baseMigrationMap).includes(key)) {
     return baseMigrationMap[key];
   }
   return null;
 };
+export var getUpcomingIcons = function getUpcomingIcons(iconPackage) {
+  var key = getIconKey(iconPackage);
+  if (upcomingIcons.includes(key)) {
+    var retval = {
+      sizeGuidance: {
+        small: 'swap',
+        medium: 'swap',
+        large: 'icon-tile',
+        xlarge: 'icon-tile'
+      }
+    };
+    return retval;
+  }
+  return null;
+};
 
 /**
  * Returns the key of a legacy icon
@@ -44,42 +60,67 @@ export var 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 upcomingIcon = getUpcomingIcons(iconPackage);
+  if (upcomingIcon) {
+    var guidance = '';
+    if (size) {
+      if (upcomingIcon.sizeGuidance[size] && canAutoMigrateNewIconBasedOnSize(upcomingIcon.sizeGuidance[size])) {
+        guidance += "Fix: An upcoming icon release is planned to migrate this legacy icon.";
+      } else {
+        guidance += "No equivalent icon for this size, ".concat(size, ", in the current or upcoming set of icons.");
+      }
+      guidance += "".concat(Object.keys(migrationOutcomeDescriptionMap).includes(upcomingIcon.sizeGuidance[size]) ? " Once the upcoming icons are released, please: ".concat(migrationOutcomeDescriptionMap[upcomingIcon.sizeGuidance[size]]) : ' No migration size advice given.', "\n");
+    } else {
+      guidance = "Please wait for the upcoming icons released, as it will contain an alternative for this legacy icon.\nMigration suggestions, depending on the legacy icon size:\n";
+      for (var _i = 0, _Object$entries = Object.entries(upcomingIcon.sizeGuidance); _i < _Object$entries.length; _i++) {
+        var _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2),
+          _size = _Object$entries$_i[0],
+          value = _Object$entries$_i[1];
+        guidance += "\t- ".concat(_size, ": ");
+        if (!Object.keys(migrationOutcomeDescriptionMap).includes(value)) {
+          guidance += 'No migration advice given.\n';
+        } else {
+          guidance += "".concat(migrationOutcomeDescriptionMap[value], ".\n");
+        }
+      }
+    }
+    return guidance;
+  } else 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 = '';
+    var _guidance = '';
     if (size) {
       if (migrationMapObject.sizeGuidance[size] && canAutoMigrateNewIconBasedOnSize(migrationMapObject.sizeGuidance[size])) {
-        guidance += "Fix: Use ".concat(newIcon.name, " from ").concat(newIcon.package, "/").concat(newIcon.type, "/").concat(newIcon.name, " instead.");
+        _guidance += "Fix: Use ".concat(newIcon.name, " from ").concat(newIcon.package, "/").concat(newIcon.type, "/").concat(newIcon.name, " instead.");
       } else {
-        guidance += "No equivalent icon for this size, ".concat(size, ", in new set.");
+        _guidance += "No equivalent icon for this size, ".concat(size, ", in new set.");
       }
-      guidance += "".concat(migrationMapObject.sizeGuidance[size] in migrationOutcomeDescriptionMap ? " Please: ".concat(migrationOutcomeDescriptionMap[migrationMapObject.sizeGuidance[size]]) : ' No migration size advice given.', "\n");
+      _guidance += "".concat(migrationMapObject.sizeGuidance[size] in migrationOutcomeDescriptionMap ? " Please: ".concat(migrationOutcomeDescriptionMap[migrationMapObject.sizeGuidance[size]]) : ' No migration size advice given.', "\n");
     } else {
-      guidance = "Use ".concat(newIcon.name, " from ").concat(newIcon.package, "/").concat(newIcon.type, "/").concat(newIcon.name, " instead.\nMigration suggestions, depending on the legacy icon size:\n");
+      _guidance = "Use ".concat(newIcon.name, " from ").concat(newIcon.package, "/").concat(newIcon.type, "/").concat(newIcon.name, " instead.\nMigration suggestions, depending on the legacy icon size:\n");
       Object.entries(migrationMapObject.sizeGuidance).forEach(function (_ref) {
         var _ref2 = _slicedToArray(_ref, 2),
           size = _ref2[0],
           value = _ref2[1];
-        guidance += "\t- ".concat(size, ": ");
+        _guidance += "\t- ".concat(size, ": ");
         if (!(value in migrationOutcomeDescriptionMap)) {
-          guidance += 'No migration advice given.\n';
+          _guidance += 'No migration advice given.\n';
         } else {
-          guidance += "".concat(migrationOutcomeDescriptionMap[value], ".\n");
+          _guidance += "".concat(migrationOutcomeDescriptionMap[value], ".\n");
         }
       });
     }
     if (insideNewButton) {
-      guidance += buttonGuidanceStr;
+      _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";
+      _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";
+      _guidance += "In the new icon, please use spacing='none'.\n";
     }
-    return guidance;
+    return _guidance;
   } else {
     return "Migration suggestions not found for \"".concat(iconPackage, "\".\n");
   }

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

@@ -0,0 +1 @@
+export var upcomingIcons = ['app-switcher', 'check-circle-outline', 'export', 'file', 'flag-filled', 'lightbulb-filled', 'lock-filled', 'menu-expand', 'menu', 'notification-direct', 'notification', 'people-group', 'people', 'refresh', 'switcher', 'editor/align-image-center', 'editor/align-image-left', 'editor/align-image-right', 'editor/background-color', 'editor/bold', 'editor/indent', 'editor/italic', 'editor/horizontal-rule', 'editor-layout-three-equal', 'editor-layout-three-with-sidebars', 'editor/layout-two-equal', 'editor/layout-two-left-sidebars', 'editor/layout-two-right-sidebar', 'editor/media-center', 'editor/media-full-width', 'editor/media-wide', 'editor/number-list', 'emoji/activity', 'editor/file', 'emoji/flags', 'emoji/food', 'emoji/nature', 'emoji/people', 'emoji/productivity', 'emoji/travel', 'bitbucket/repos'];

package/dist/types/rules/no-legacy-icons/helpers.d.ts

@@ -1,5 +1,6 @@
 import type { Rule } from 'eslint';
 import { type JSXAttribute, type Node } from 'eslint-codemod-utils';
+import { type IconMigrationSizeGuidance } from '@atlaskit/icon/UNSAFE_migration-map';
 export type iconMigrationError = Rule.ReportDescriptor;
 export type errorsListManual = {
     [loc: string]: {
@@ -23,6 +24,9 @@ export declare const isSize: (size: any) => size is "small" | "medium" | "large"
  * @returns The migration map object for the legacy icon or null if not found
  */
 export declare const getMigrationMapObject: (iconPackage: string) => any;
+export declare const getUpcomingIcons: (iconPackage: string) => {
+    sizeGuidance: Record<Size, IconMigrationSizeGuidance>;
+} | null;
 /**
  * Checks if a new icon can be auto-migrated based on guidance from the migration map
  */

package/dist/types/rules/no-legacy-icons/upcoming-icons.d.ts

@@ -0,0 +1 @@
+export declare const upcomingIcons: string[];

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

@@ -1,5 +1,6 @@
 import type { Rule } from 'eslint';
 import { type JSXAttribute, type Node } from 'eslint-codemod-utils';
+import { type IconMigrationSizeGuidance } from '@atlaskit/icon/UNSAFE_migration-map';
 export type iconMigrationError = Rule.ReportDescriptor;
 export type errorsListManual = {
     [loc: string]: {
@@ -28,6 +29,9 @@ export declare const isSize: (size: any) => size is "small" | "medium" | "large"
  * @returns The migration map object for the legacy icon or null if not found
  */
 export declare const getMigrationMapObject: (iconPackage: string) => any;
+export declare const getUpcomingIcons: (iconPackage: string) => {
+    sizeGuidance: Record<Size, IconMigrationSizeGuidance>;
+} | null;
 /**
  * Checks if a new icon can be auto-migrated based on guidance from the migration map
  */

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

@@ -0,0 +1 @@
+export declare const upcomingIcons: string[];

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@atlaskit/eslint-plugin-design-system",
 	"description": "The essential plugin for use with the Atlassian Design System.",
-	"version": "10.12.3",
+	"version": "10.12.4",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
 	"publishConfig": {