@atlaskit/codemod-cli 0.24.3 → 0.25.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/codemod-cli
 
+## 0.25.0
+
+### Minor Changes
+
+- [#111403](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/111403)
+  [`cc57d517bca2a`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/cc57d517bca2a) -
+  Migrate to new buttons codemod now adds comment for deprecated `overlay` props.
+
+## 0.24.4
+
+### Patch Changes
+
+- [#108929](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/108929)
+  [`a25122bc3dc8f`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/a25122bc3dc8f) -
+  Fixed the duplicated "Button" imports after migrating loading buttons to default buttons.
+
 ## 0.24.3
 
 ### Patch Changes

package/README.md

@@ -1,10 +1,13 @@
 # Codemods
 
-To easily download and run codemods associated with atlassian-frontend components and services, we provide a CLI tool called `@atlaskit/codemod-cli`.
+To easily download and run codemods associated with atlassian-frontend components and services, we
+provide a CLI tool called `@atlaskit/codemod-cli`.
 
-The idea is that upgrading major versions can be **assisted** by codemods, reducing upgrade-pain, improving adoption and giving component authors the flexibility to improve API and component design.
+The idea is that upgrading major versions can be **assisted** by codemods, reducing upgrade-pain,
+improving adoption and giving component authors the flexibility to improve API and component design.
 
-**Note:** Codemods will be designed to do the heavy lifting, but they'll often not be perfect so some manual work may still be required in order to successfully migrate.
+**Note:** Codemods will be designed to do the heavy lifting, but they'll often not be perfect so
+some manual work may still be required in order to successfully migrate.
 
 ---
 
@@ -16,7 +19,8 @@ The idea is that upgrading major versions can be **assisted** by codemods, reduc
 
 ### --preset, -n
 
-Select which transform to run from existing transform list by providing the preset name. This will allow you run the transfrom without any interaction.
+Select which transform to run from existing transform list by providing the preset name. This will
+allow you run the transfrom without any interaction.
 
 **example:**
 
@@ -33,7 +37,8 @@ The transform to run, transforms can be either a single file or directory with a
 
 ### --since-ref <git-ref>
 
-Determines changed packages since the specified git ref and runs all codemods for them. The automatic version of `--packages`. The ref can be any valid git ref, e.g. a commit hash, HEAD etc.
+Determines changed packages since the specified git ref and runs all codemods for them. The
+automatic version of `--packages`. The ref can be any valid git ref, e.g. a commit hash, HEAD etc.
 
 **example:**
 
@@ -42,7 +47,8 @@ Determines changed packages since the specified git ref and runs all codemods fo
 
 ### --packages
 
-Runs transforms for the specified comma separated list of packages, optionally include a version for each package to run all transforms since that version
+Runs transforms for the specified comma separated list of packages, optionally include a version for
+each package to run all transforms since that version
 
 **example:**
 
@@ -85,7 +91,9 @@ Ignore files that match a provided glob expression
 
 ### --no-filter-paths
 
-The codemod CLI filters supplied file paths by default, improving runtime by preventing codemods from running in non-dependent packages. Add this flag if there are problems with the filtering logic.
+The codemod CLI filters supplied file paths by default, improving runtime by preventing codemods
+from running in non-dependent packages. Add this flag if there are problems with the filtering
+logic.
 
 **example:**
 
@@ -110,7 +118,8 @@ Print all help text to the command line
 
 ### Custom options
 
-All options are passed to the transformer, which means you can supply custom options that are not listed here.
+All options are passed to the transformer, which means you can supply custom options that are not
+listed here.
 
 **examples:**
 
@@ -132,4 +141,5 @@ For a list of commands run it with `-h` or refer to the documentation above.
 
 ## For internal Atlassians
 
-_Internal Atlassians can access [additional documentation on Confluence](https://hello.atlassian.net/wiki/spaces/AF/pages/2627171992/Codemods)._
+_Internal Atlassians can access
+[additional documentation on Confluence](https://hello.atlassian.net/wiki/spaces/AF/pages/2627171992/Codemods)._

package/bin/codemod-cli.js

@@ -8,16 +8,16 @@ const project = path.join(__dirname, '../tsconfig.json');
 const dev = fs.existsSync(project);
 
 if (dev && !require.extensions['.ts']) {
-  // ts-node can only handle being registered once, see https://github.com/TypeStrong/ts-node/issues/409
-  require('ts-node').register({ project });
+	// ts-node can only handle being registered once, see https://github.com/TypeStrong/ts-node/issues/409
+	require('ts-node').register({ project });
 }
 
 require(path.join('..', dev ? 'src/cli' : 'dist/cjs/cli'))
-  .run()
-  .catch((error) => {
-    if (typeof error === 'number') {
-      process.exit(error);
-    }
-    console.error(error);
-    process.exit(1);
-  });
+	.run()
+	.catch((error) => {
+		if (typeof error === 'number') {
+			process.exit(error);
+		}
+		console.error(error);
+		process.exit(1);
+	});

package/dist/cjs/main.js

@@ -305,7 +305,7 @@ function _main() {
         case 4:
           _yield$parseArgs = _context5.sent;
           packages = _yield$parseArgs.packages;
-          _process$env$_PACKAGE = "0.24.3", _PACKAGE_VERSION_ = _process$env$_PACKAGE === void 0 ? '0.0.0-dev' : _process$env$_PACKAGE;
+          _process$env$_PACKAGE = "0.25.0", _PACKAGE_VERSION_ = _process$env$_PACKAGE === void 0 ? '0.0.0-dev' : _process$env$_PACKAGE;
           logger.log(_chalk.default.bgBlue(_chalk.default.black("\uD83D\uDCDA Atlassian-Frontend codemod library @ ".concat(_PACKAGE_VERSION_, " \uD83D\uDCDA"))));
           if (packages && packages.length > 0) {
             logger.log(_chalk.default.gray("Searching for codemods for newer versions of the following packages: ".concat(packages.map(function (pkg) {

package/dist/cjs/presets/migrate-to-new-buttons/codemods/next-migrate-to-new-button-variants.js

@@ -18,6 +18,7 @@ var _renameDefaultButtonToLegacyButton = require("../utils/rename-default-button
 var _migrateFitContainerIconButton = require("../utils/migrate-fit-container-icon-button");
 var _importTypesFromNewEntryPoint = require("../utils/import-types-from-new-entry-point");
 var _addCommentForCustomThemeButtons = require("../utils/add-comment-for-custom-theme-buttons");
+var _addCommentForOverlayProp = require("../utils/add-comment-for-overlay-prop");
 var transformer = function transformer(file, api) {
   var j = api.jscodeshift;
   var fileSource = j(file.source);
@@ -56,6 +57,7 @@ var transformer = function transformer(file, api) {
   var oldButtonElements = fileSource.find(j.JSXElement).filter(function (path) {
     return path.value.openingElement.name.type === 'JSXIdentifier' && ((oldDefaultImportSpecifiers === null || oldDefaultImportSpecifiers === void 0 ? void 0 : oldDefaultImportSpecifiers.includes(path.value.openingElement.name.name)) || Object.values(_constants.OLD_BUTTON_VARIANTS).includes(path.value.openingElement.name.name));
   });
+  (0, _addCommentForOverlayProp.addCommentForOverlayProp)(oldButtonElements, j);
   var oldButtonsWithoutUnsupportedProps = oldButtonElements.filter(function (path) {
     return !(0, _hasUnsupportedProps.ifHasUnsupportedProps)(path.value.openingElement.attributes);
   });
@@ -115,6 +117,33 @@ var transformer = function transformer(file, api) {
         hasVariant.iconButton = true;
       } else {
         hasVariant.defaultButton = true;
+
+        // rename existing Button to LegacyButton
+        var existingDefaultButtonSpecifier = fileSource.find(j.ImportDefaultSpecifier).filter(function (path) {
+          var _path$value$local;
+          return ((_path$value$local = path.value.local) === null || _path$value$local === void 0 ? void 0 : _path$value$local.name) === _constants.NEW_BUTTON_VARIANTS.default;
+        });
+        if (existingDefaultButtonSpecifier.length > 0) {
+          fileSource.find(j.JSXElement).filter(function (path) {
+            return path.value.openingElement.name.type === 'JSXIdentifier' && path.value.openingElement.name.name === _constants.NEW_BUTTON_VARIANTS.default;
+          }).forEach(function (element) {
+            var _element$value$childr2, _element$value$childr3;
+            // find all default <Button> JSX elements and replace with <LegacyButton>
+            j(element).replaceWith(j.jsxElement(j.jsxOpeningElement(j.jsxIdentifier('LegacyButton'), element.value.openingElement.attributes, ((_element$value$childr2 = element.value.children) === null || _element$value$childr2 === void 0 ? void 0 : _element$value$childr2.length) === 0), ((_element$value$childr3 = element.value.children) === null || _element$value$childr3 === void 0 ? void 0 : _element$value$childr3.length) === 0 ? null : j.jsxClosingElement(j.jsxIdentifier('LegacyButton')), element.value.children));
+          });
+
+          // rename Button to LegacyButton in all call expressions i.e. render(Button), find(Button)
+          fileSource.find(j.CallExpression).find(j.Identifier).forEach(function (path) {
+            if (path.node.name === _constants.NEW_BUTTON_VARIANTS.default) {
+              path.node.name = 'LegacyButton';
+            }
+          });
+
+          // rename Button to LegacyButton in import declaration
+          existingDefaultButtonSpecifier.forEach(function (specifier) {
+            return j(specifier).replaceWith(j.importDefaultSpecifier(j.identifier('LegacyButton')));
+          });
+        }
       }
       j(element).replaceWith(newElement);
       if (hasHref || linkAppearanceAttribute) {
@@ -240,6 +269,7 @@ var transformer = function transformer(file, api) {
   fileSource.find(j.ImportDeclaration).filter(function (path) {
     return (path.node.source.value === '@atlaskit/button' || path.node.source.value === '@atlaskit/button/types') && !!path.node.specifiers && path.node.specifiers.length === 0;
   }).remove();
+  (0, _addCommentForCustomThemeButtons.addCommentForCustomThemeButtons)(fileSource, j);
   return fileSource.toSource(_constants.PRINT_SETTINGS);
 };
 var _default = exports.default = transformer;

package/dist/cjs/presets/migrate-to-new-buttons/utils/add-comment-for-custom-theme-buttons.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.addCommentForCustomThemeButtons = void 0;
 var _codemodUtils = require("@atlaskit/codemod-utils");
 var _constants = require("./constants");
+var _addCommentForOverlayProp = require("./add-comment-for-overlay-prop");
 var addCommentForCustomThemeButtons = exports.addCommentForCustomThemeButtons = function addCommentForCustomThemeButtons(fileSource, j) {
   var _fileSource$find$filt;
   var customThemeButtonImportName;
@@ -29,5 +30,6 @@ var addCommentForCustomThemeButtons = exports.addCommentForCustomThemeButtons =
   if (!customThemeButtonElement.length) {
     return;
   }
-  (0, _codemodUtils.addCommentBefore)(j, j(customThemeButtonElement.get(0).node.openingElement), _constants.customThemeButtonComment, 'line');
+  (0, _addCommentForOverlayProp.addCommentForOverlayProp)(customThemeButtonElement, j);
+  (0, _codemodUtils.addCommentBefore)(j, j(customThemeButtonElement.get(0).node.openingElement), _constants.customThemeButtonComment, 'block');
 };

package/dist/cjs/presets/migrate-to-new-buttons/utils/add-comment-for-overlay-prop.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.addCommentForOverlayProp = void 0;
+var _codemodUtils = require("@atlaskit/codemod-utils");
+var _constants = require("./constants");
+var addCommentForOverlayProp = exports.addCommentForOverlayProp = function addCommentForOverlayProp(oldButtons, j) {
+  oldButtons.find(j.JSXAttribute).filter(function (attribute) {
+    return attribute.node.name.name === 'overlay';
+  }).forEach(function (attribute) {
+    (0, _codemodUtils.addCommentBefore)(j, j(attribute), _constants.overlayPropComment, 'block');
+  });
+};

package/dist/cjs/presets/migrate-to-new-buttons/utils/constants.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.unsupportedProps = exports.migrateFitContainerButtonToIconButtonComment = exports.migrateFitContainerButtonToDefaultButtonComment = exports.loadingButtonComment = exports.linkButtonMissingHrefComment = exports.entryPointsMapping = exports.customThemeButtonComment = exports.buttonPropsNoLongerSupportedComment = exports.UNSAFE_SIZE_PROPS_MAP = exports.PRINT_SETTINGS = exports.OLD_BUTTON_VARIANTS = exports.OLD_BUTTON_ENTRY_POINT = exports.NEW_BUTTON_VARIANTS = exports.NEW_BUTTON_ENTRY_POINT = exports.BUTTON_TYPES = void 0;
+exports.unsupportedProps = exports.overlayPropComment = exports.migrateFitContainerButtonToIconButtonComment = exports.migrateFitContainerButtonToDefaultButtonComment = exports.loadingButtonComment = exports.linkButtonMissingHrefComment = exports.entryPointsMapping = exports.customThemeButtonComment = exports.buttonPropsNoLongerSupportedComment = exports.UNSAFE_SIZE_PROPS_MAP = exports.PRINT_SETTINGS = exports.OLD_BUTTON_VARIANTS = exports.OLD_BUTTON_ENTRY_POINT = exports.NEW_BUTTON_VARIANTS = exports.NEW_BUTTON_ENTRY_POINT = exports.BUTTON_TYPES = void 0;
 var PRINT_SETTINGS = exports.PRINT_SETTINGS = {
   quote: 'single'
 };
@@ -40,6 +40,7 @@ var buttonPropsNoLongerSupportedComment = exports.buttonPropsNoLongerSupportedCo
 var migrateFitContainerButtonToDefaultButtonComment = exports.migrateFitContainerButtonToDefaultButtonComment = "Migrated to a default button with text which is from the icon label.";
 var migrateFitContainerButtonToIconButtonComment = exports.migrateFitContainerButtonToIconButtonComment = "\"shouldFitContainer\" is not available in icon buttons, please consider using a default button with text.";
 var customThemeButtonComment = exports.customThemeButtonComment = "CustomThemeButton will be deprecated. Please consider migrating to Pressable or Anchor Primitives with custom styles.";
+var overlayPropComment = exports.overlayPropComment = "The 'overlay' prop has been deprecated. This only existed in legacy buttons for supporting loading spinners, which can now be achieved in new buttons using the `isLoading` prop. Please remove the `overlay` prop and consider using the new `isLoading` prop.";
 var loadingButtonComment = exports.loadingButtonComment = function loadingButtonComment(_ref) {
   var hasLinkAppearance = _ref.hasLinkAppearance,
     hasHref = _ref.hasHref;

package/dist/es2019/presets/migrate-to-new-buttons/codemods/next-migrate-to-new-button-variants.js

@@ -10,6 +10,7 @@ import { renameDefaultButtonToLegacyButtonImport } from '../utils/rename-default
 import { migrateFitContainerIconButton } from '../utils/migrate-fit-container-icon-button';
 import { importTypesFromNewEntryPoint } from '../utils/import-types-from-new-entry-point';
 import { addCommentForCustomThemeButtons } from '../utils/add-comment-for-custom-theme-buttons';
+import { addCommentForOverlayProp } from '../utils/add-comment-for-overlay-prop';
 const transformer = (file, api) => {
   const j = api.jscodeshift;
   const fileSource = j(file.source);
@@ -44,6 +45,7 @@ const transformer = (file, api) => {
   const oldButtonElements = fileSource.find(j.JSXElement).filter(path => {
     return path.value.openingElement.name.type === 'JSXIdentifier' && ((oldDefaultImportSpecifiers === null || oldDefaultImportSpecifiers === void 0 ? void 0 : oldDefaultImportSpecifiers.includes(path.value.openingElement.name.name)) || Object.values(OLD_BUTTON_VARIANTS).includes(path.value.openingElement.name.name));
   });
+  addCommentForOverlayProp(oldButtonElements, j);
   const oldButtonsWithoutUnsupportedProps = oldButtonElements.filter(path => !ifHasUnsupportedProps(path.value.openingElement.attributes));
   oldButtonsWithoutUnsupportedProps.forEach(element => {
     var _element$value$childr;
@@ -101,6 +103,29 @@ const transformer = (file, api) => {
         hasVariant.iconButton = true;
       } else {
         hasVariant.defaultButton = true;
+
+        // rename existing Button to LegacyButton
+        const existingDefaultButtonSpecifier = fileSource.find(j.ImportDefaultSpecifier).filter(path => {
+          var _path$value$local;
+          return ((_path$value$local = path.value.local) === null || _path$value$local === void 0 ? void 0 : _path$value$local.name) === NEW_BUTTON_VARIANTS.default;
+        });
+        if (existingDefaultButtonSpecifier.length > 0) {
+          fileSource.find(j.JSXElement).filter(path => path.value.openingElement.name.type === 'JSXIdentifier' && path.value.openingElement.name.name === NEW_BUTTON_VARIANTS.default).forEach(element => {
+            var _element$value$childr2, _element$value$childr3;
+            // find all default <Button> JSX elements and replace with <LegacyButton>
+            j(element).replaceWith(j.jsxElement(j.jsxOpeningElement(j.jsxIdentifier('LegacyButton'), element.value.openingElement.attributes, ((_element$value$childr2 = element.value.children) === null || _element$value$childr2 === void 0 ? void 0 : _element$value$childr2.length) === 0), ((_element$value$childr3 = element.value.children) === null || _element$value$childr3 === void 0 ? void 0 : _element$value$childr3.length) === 0 ? null : j.jsxClosingElement(j.jsxIdentifier('LegacyButton')), element.value.children));
+          });
+
+          // rename Button to LegacyButton in all call expressions i.e. render(Button), find(Button)
+          fileSource.find(j.CallExpression).find(j.Identifier).forEach(path => {
+            if (path.node.name === NEW_BUTTON_VARIANTS.default) {
+              path.node.name = 'LegacyButton';
+            }
+          });
+
+          // rename Button to LegacyButton in import declaration
+          existingDefaultButtonSpecifier.forEach(specifier => j(specifier).replaceWith(j.importDefaultSpecifier(j.identifier('LegacyButton'))));
+        }
       }
       j(element).replaceWith(newElement);
       if (hasHref || linkAppearanceAttribute) {
@@ -205,6 +230,7 @@ const transformer = (file, api) => {
 
   // remove empty import declarations
   fileSource.find(j.ImportDeclaration).filter(path => (path.node.source.value === '@atlaskit/button' || path.node.source.value === '@atlaskit/button/types') && !!path.node.specifiers && path.node.specifiers.length === 0).remove();
+  addCommentForCustomThemeButtons(fileSource, j);
   return fileSource.toSource(PRINT_SETTINGS);
 };
 export default transformer;

package/dist/es2019/presets/migrate-to-new-buttons/utils/add-comment-for-custom-theme-buttons.js

@@ -1,5 +1,6 @@
 import { addCommentBefore } from '@atlaskit/codemod-utils';
 import { entryPointsMapping, customThemeButtonComment } from './constants';
+import { addCommentForOverlayProp } from './add-comment-for-overlay-prop';
 export const addCommentForCustomThemeButtons = (fileSource, j) => {
   var _fileSource$find$filt;
   let customThemeButtonImportName;
@@ -19,5 +20,6 @@ export const addCommentForCustomThemeButtons = (fileSource, j) => {
   if (!customThemeButtonElement.length) {
     return;
   }
-  addCommentBefore(j, j(customThemeButtonElement.get(0).node.openingElement), customThemeButtonComment, 'line');
+  addCommentForOverlayProp(customThemeButtonElement, j);
+  addCommentBefore(j, j(customThemeButtonElement.get(0).node.openingElement), customThemeButtonComment, 'block');
 };

package/dist/es2019/presets/migrate-to-new-buttons/utils/add-comment-for-overlay-prop.js

@@ -0,0 +1,7 @@
+import { addCommentBefore } from '@atlaskit/codemod-utils';
+import { overlayPropComment } from './constants';
+export const addCommentForOverlayProp = (oldButtons, j) => {
+  oldButtons.find(j.JSXAttribute).filter(attribute => attribute.node.name.name === 'overlay').forEach(attribute => {
+    addCommentBefore(j, j(attribute), overlayPropComment, 'block');
+  });
+};

package/dist/es2019/presets/migrate-to-new-buttons/utils/constants.js

@@ -34,6 +34,7 @@ export const buttonPropsNoLongerSupportedComment = `Buttons with "component", "c
 export const migrateFitContainerButtonToDefaultButtonComment = `Migrated to a default button with text which is from the icon label.`;
 export const migrateFitContainerButtonToIconButtonComment = `"shouldFitContainer" is not available in icon buttons, please consider using a default button with text.`;
 export const customThemeButtonComment = `CustomThemeButton will be deprecated. Please consider migrating to Pressable or Anchor Primitives with custom styles.`;
+export const overlayPropComment = `The 'overlay' prop has been deprecated. This only existed in legacy buttons for supporting loading spinners, which can now be achieved in new buttons using the \`isLoading\` prop. Please remove the \`overlay\` prop and consider using the new \`isLoading\` prop.`;
 export const loadingButtonComment = ({
   hasLinkAppearance,
   hasHref

package/dist/esm/main.js

@@ -298,7 +298,7 @@ function _main() {
         case 4:
           _yield$parseArgs = _context5.sent;
           packages = _yield$parseArgs.packages;
-          _process$env$_PACKAGE = "0.24.3", _PACKAGE_VERSION_ = _process$env$_PACKAGE === void 0 ? '0.0.0-dev' : _process$env$_PACKAGE;
+          _process$env$_PACKAGE = "0.25.0", _PACKAGE_VERSION_ = _process$env$_PACKAGE === void 0 ? '0.0.0-dev' : _process$env$_PACKAGE;
           logger.log(chalk.bgBlue(chalk.black("\uD83D\uDCDA Atlassian-Frontend codemod library @ ".concat(_PACKAGE_VERSION_, " \uD83D\uDCDA"))));
           if (packages && packages.length > 0) {
             logger.log(chalk.gray("Searching for codemods for newer versions of the following packages: ".concat(packages.map(function (pkg) {

package/dist/esm/presets/migrate-to-new-buttons/codemods/next-migrate-to-new-button-variants.js

@@ -11,6 +11,7 @@ import { renameDefaultButtonToLegacyButtonImport } from '../utils/rename-default
 import { migrateFitContainerIconButton } from '../utils/migrate-fit-container-icon-button';
 import { importTypesFromNewEntryPoint } from '../utils/import-types-from-new-entry-point';
 import { addCommentForCustomThemeButtons } from '../utils/add-comment-for-custom-theme-buttons';
+import { addCommentForOverlayProp } from '../utils/add-comment-for-overlay-prop';
 var transformer = function transformer(file, api) {
   var j = api.jscodeshift;
   var fileSource = j(file.source);
@@ -49,6 +50,7 @@ var transformer = function transformer(file, api) {
   var oldButtonElements = fileSource.find(j.JSXElement).filter(function (path) {
     return path.value.openingElement.name.type === 'JSXIdentifier' && ((oldDefaultImportSpecifiers === null || oldDefaultImportSpecifiers === void 0 ? void 0 : oldDefaultImportSpecifiers.includes(path.value.openingElement.name.name)) || Object.values(OLD_BUTTON_VARIANTS).includes(path.value.openingElement.name.name));
   });
+  addCommentForOverlayProp(oldButtonElements, j);
   var oldButtonsWithoutUnsupportedProps = oldButtonElements.filter(function (path) {
     return !ifHasUnsupportedProps(path.value.openingElement.attributes);
   });
@@ -108,6 +110,33 @@ var transformer = function transformer(file, api) {
         hasVariant.iconButton = true;
       } else {
         hasVariant.defaultButton = true;
+
+        // rename existing Button to LegacyButton
+        var existingDefaultButtonSpecifier = fileSource.find(j.ImportDefaultSpecifier).filter(function (path) {
+          var _path$value$local;
+          return ((_path$value$local = path.value.local) === null || _path$value$local === void 0 ? void 0 : _path$value$local.name) === NEW_BUTTON_VARIANTS.default;
+        });
+        if (existingDefaultButtonSpecifier.length > 0) {
+          fileSource.find(j.JSXElement).filter(function (path) {
+            return path.value.openingElement.name.type === 'JSXIdentifier' && path.value.openingElement.name.name === NEW_BUTTON_VARIANTS.default;
+          }).forEach(function (element) {
+            var _element$value$childr2, _element$value$childr3;
+            // find all default <Button> JSX elements and replace with <LegacyButton>
+            j(element).replaceWith(j.jsxElement(j.jsxOpeningElement(j.jsxIdentifier('LegacyButton'), element.value.openingElement.attributes, ((_element$value$childr2 = element.value.children) === null || _element$value$childr2 === void 0 ? void 0 : _element$value$childr2.length) === 0), ((_element$value$childr3 = element.value.children) === null || _element$value$childr3 === void 0 ? void 0 : _element$value$childr3.length) === 0 ? null : j.jsxClosingElement(j.jsxIdentifier('LegacyButton')), element.value.children));
+          });
+
+          // rename Button to LegacyButton in all call expressions i.e. render(Button), find(Button)
+          fileSource.find(j.CallExpression).find(j.Identifier).forEach(function (path) {
+            if (path.node.name === NEW_BUTTON_VARIANTS.default) {
+              path.node.name = 'LegacyButton';
+            }
+          });
+
+          // rename Button to LegacyButton in import declaration
+          existingDefaultButtonSpecifier.forEach(function (specifier) {
+            return j(specifier).replaceWith(j.importDefaultSpecifier(j.identifier('LegacyButton')));
+          });
+        }
       }
       j(element).replaceWith(newElement);
       if (hasHref || linkAppearanceAttribute) {
@@ -233,6 +262,7 @@ var transformer = function transformer(file, api) {
   fileSource.find(j.ImportDeclaration).filter(function (path) {
     return (path.node.source.value === '@atlaskit/button' || path.node.source.value === '@atlaskit/button/types') && !!path.node.specifiers && path.node.specifiers.length === 0;
   }).remove();
+  addCommentForCustomThemeButtons(fileSource, j);
   return fileSource.toSource(PRINT_SETTINGS);
 };
 export default transformer;

package/dist/esm/presets/migrate-to-new-buttons/utils/add-comment-for-custom-theme-buttons.js

@@ -1,5 +1,6 @@
 import { addCommentBefore } from '@atlaskit/codemod-utils';
 import { entryPointsMapping, customThemeButtonComment } from './constants';
+import { addCommentForOverlayProp } from './add-comment-for-overlay-prop';
 export var addCommentForCustomThemeButtons = function addCommentForCustomThemeButtons(fileSource, j) {
   var _fileSource$find$filt;
   var customThemeButtonImportName;
@@ -23,5 +24,6 @@ export var addCommentForCustomThemeButtons = function addCommentForCustomThemeBu
   if (!customThemeButtonElement.length) {
     return;
   }
-  addCommentBefore(j, j(customThemeButtonElement.get(0).node.openingElement), customThemeButtonComment, 'line');
+  addCommentForOverlayProp(customThemeButtonElement, j);
+  addCommentBefore(j, j(customThemeButtonElement.get(0).node.openingElement), customThemeButtonComment, 'block');
 };

package/dist/esm/presets/migrate-to-new-buttons/utils/add-comment-for-overlay-prop.js

@@ -0,0 +1,9 @@
+import { addCommentBefore } from '@atlaskit/codemod-utils';
+import { overlayPropComment } from './constants';
+export var addCommentForOverlayProp = function addCommentForOverlayProp(oldButtons, j) {
+  oldButtons.find(j.JSXAttribute).filter(function (attribute) {
+    return attribute.node.name.name === 'overlay';
+  }).forEach(function (attribute) {
+    addCommentBefore(j, j(attribute), overlayPropComment, 'block');
+  });
+};

package/dist/esm/presets/migrate-to-new-buttons/utils/constants.js

@@ -34,6 +34,7 @@ export var buttonPropsNoLongerSupportedComment = "Buttons with \"component\", \"
 export var migrateFitContainerButtonToDefaultButtonComment = "Migrated to a default button with text which is from the icon label.";
 export var migrateFitContainerButtonToIconButtonComment = "\"shouldFitContainer\" is not available in icon buttons, please consider using a default button with text.";
 export var customThemeButtonComment = "CustomThemeButton will be deprecated. Please consider migrating to Pressable or Anchor Primitives with custom styles.";
+export var overlayPropComment = "The 'overlay' prop has been deprecated. This only existed in legacy buttons for supporting loading spinners, which can now be achieved in new buttons using the `isLoading` prop. Please remove the `overlay` prop and consider using the new `isLoading` prop.";
 export var loadingButtonComment = function loadingButtonComment(_ref) {
   var hasLinkAppearance = _ref.hasLinkAppearance,
     hasHref = _ref.hasHref;

package/dist/types/presets/migrate-to-new-buttons/utils/add-comment-for-overlay-prop.d.ts

@@ -0,0 +1,2 @@
+import type { API, Collection, JSXElement } from 'jscodeshift';
+export declare const addCommentForOverlayProp: (oldButtons: Collection<JSXElement>, j: API['jscodeshift']) => void;

package/dist/types/presets/migrate-to-new-buttons/utils/constants.d.ts

@@ -22,6 +22,7 @@ export declare const buttonPropsNoLongerSupportedComment = "Buttons with \"compo
 export declare const migrateFitContainerButtonToDefaultButtonComment = "Migrated to a default button with text which is from the icon label.";
 export declare const migrateFitContainerButtonToIconButtonComment = "\"shouldFitContainer\" is not available in icon buttons, please consider using a default button with text.";
 export declare const customThemeButtonComment = "CustomThemeButton will be deprecated. Please consider migrating to Pressable or Anchor Primitives with custom styles.";
+export declare const overlayPropComment = "The 'overlay' prop has been deprecated. This only existed in legacy buttons for supporting loading spinners, which can now be achieved in new buttons using the `isLoading` prop. Please remove the `overlay` prop and consider using the new `isLoading` prop.";
 export declare const loadingButtonComment: ({ hasLinkAppearance, hasHref, }: {
     hasLinkAppearance: boolean;
     hasHref: boolean;

package/dist/types-ts4.5/presets/migrate-to-new-buttons/utils/add-comment-for-overlay-prop.d.ts

@@ -0,0 +1,2 @@
+import type { API, Collection, JSXElement } from 'jscodeshift';
+export declare const addCommentForOverlayProp: (oldButtons: Collection<JSXElement>, j: API['jscodeshift']) => void;

package/dist/types-ts4.5/presets/migrate-to-new-buttons/utils/constants.d.ts

@@ -22,6 +22,7 @@ export declare const buttonPropsNoLongerSupportedComment = "Buttons with \"compo
 export declare const migrateFitContainerButtonToDefaultButtonComment = "Migrated to a default button with text which is from the icon label.";
 export declare const migrateFitContainerButtonToIconButtonComment = "\"shouldFitContainer\" is not available in icon buttons, please consider using a default button with text.";
 export declare const customThemeButtonComment = "CustomThemeButton will be deprecated. Please consider migrating to Pressable or Anchor Primitives with custom styles.";
+export declare const overlayPropComment = "The 'overlay' prop has been deprecated. This only existed in legacy buttons for supporting loading spinners, which can now be achieved in new buttons using the `isLoading` prop. Please remove the `overlay` prop and consider using the new `isLoading` prop.";
 export declare const loadingButtonComment: ({ hasLinkAppearance, hasHref, }: {
     hasLinkAppearance: boolean;
     hasHref: boolean;

package/index.js

@@ -11,12 +11,12 @@ const dev = fs.existsSync(project);
 
 let entrypoint = path.join(__dirname, 'dist', 'cjs', 'index');
 if (dev) {
-  if (!require.extensions['.ts']) {
-    // ts-node can only handle being registered once, see https://github.com/TypeStrong/ts-node/issues/409
-    // eslint-disable-next-line import/no-extraneous-dependencies
-    require('ts-node').register({ project });
-  }
-  entrypoint = path.join(__dirname, 'src', 'index');
+	if (!require.extensions['.ts']) {
+		// ts-node can only handle being registered once, see https://github.com/TypeStrong/ts-node/issues/409
+		// eslint-disable-next-line import/no-extraneous-dependencies
+		require('ts-node').register({ project });
+	}
+	entrypoint = path.join(__dirname, 'src', 'index');
 }
 
 module.exports = require(entrypoint);

package/package.json

@@ -1,64 +1,64 @@
 {
-  "name": "@atlaskit/codemod-cli",
-  "version": "0.24.3",
-  "description": "A cli for distributing codemods for atlassian-frontend components and services",
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/"
-  },
-  "repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
-  "author": "Atlassian Pty Ltd",
-  "license": "Apache-2.0",
-  "main": "index.js",
-  "types": "dist/types/index.d.ts",
-  "typesVersions": {
-    ">=4.5 <4.9": {
-      "*": [
-        "dist/types-ts4.5/*",
-        "dist/types-ts4.5/index.d.ts"
-      ]
-    }
-  },
-  "atlaskit:src": "src/index.ts",
-  "af:exports": {
-    ".": "./src/index.ts",
-    "./cli": "./src/cli.ts",
-    "./filepath": "./src/filepath.ts",
-    "./main": "./src/main.ts",
-    "./sinceRef": "./src/sinceRef.ts",
-    "./transforms": "./src/transforms.ts",
-    "./types": "./src/types.ts",
-    "./utils": "./src/utils.ts"
-  },
-  "atlassian": {
-    "team": "Design System Team",
-    "releaseModel": "continuous"
-  },
-  "scripts": {
-    "prestart": "cd ../../ && yarn build @atlaskit/codemod-utils tokens",
-    "start": "./bin/codemod-cli.js"
-  },
-  "bin": "./bin/codemod-cli.js",
-  "dependencies": {
-    "@atlaskit/codemod-utils": "^4.2.0",
-    "@atlaskit/tokens": "^1.49.0",
-    "@babel/runtime": "^7.0.0",
-    "@codeshift/utils": "^0.2.4",
-    "@hypermod/utils": "^0.4.2",
-    "@types/jscodeshift": "^0.11.0",
-    "chalk": "^4.1.2",
-    "enquirer": "^2.3.4",
-    "glob": "9.0.0",
-    "jscodeshift": "^0.13.0",
-    "meow": "^8.1.1",
-    "projector-spawn": "^1.0.1",
-    "semver": "^7.5.2",
-    "simple-git": "^3.16.0"
-  },
-  "devDependencies": {
-    "@af/formatting": "*",
-    "prettier": "^3.2.5",
-    "ts-node": "^10.9.1",
-    "typescript": "~5.4.2"
-  },
-  "homepage": "https://atlaskit.atlassian.com/packages/monorepo-tooling/codemod-cli"
-}
+	"name": "@atlaskit/codemod-cli",
+	"version": "0.25.0",
+	"description": "A cli for distributing codemods for atlassian-frontend components and services",
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/"
+	},
+	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
+	"author": "Atlassian Pty Ltd",
+	"license": "Apache-2.0",
+	"main": "index.js",
+	"types": "dist/types/index.d.ts",
+	"typesVersions": {
+		">=4.5 <4.9": {
+			"*": [
+				"dist/types-ts4.5/*",
+				"dist/types-ts4.5/index.d.ts"
+			]
+		}
+	},
+	"atlaskit:src": "src/index.ts",
+	"af:exports": {
+		".": "./src/index.ts",
+		"./cli": "./src/cli.ts",
+		"./filepath": "./src/filepath.ts",
+		"./main": "./src/main.ts",
+		"./sinceRef": "./src/sinceRef.ts",
+		"./transforms": "./src/transforms.ts",
+		"./types": "./src/types.ts",
+		"./utils": "./src/utils.ts"
+	},
+	"atlassian": {
+		"team": "Design System Team",
+		"releaseModel": "continuous"
+	},
+	"scripts": {
+		"prestart": "cd ../../ && yarn build @atlaskit/codemod-utils tokens",
+		"start": "./bin/codemod-cli.js"
+	},
+	"bin": "./bin/codemod-cli.js",
+	"dependencies": {
+		"@atlaskit/codemod-utils": "^4.2.0",
+		"@atlaskit/tokens": "^1.51.0",
+		"@babel/runtime": "^7.0.0",
+		"@codeshift/utils": "^0.2.4",
+		"@hypermod/utils": "^0.4.2",
+		"@types/jscodeshift": "^0.11.0",
+		"chalk": "^4.1.2",
+		"enquirer": "^2.3.4",
+		"glob": "9.0.0",
+		"jscodeshift": "^0.13.0",
+		"meow": "^8.1.1",
+		"projector-spawn": "^1.0.1",
+		"semver": "^7.5.2",
+		"simple-git": "^3.16.0"
+	},
+	"devDependencies": {
+		"@af/formatting": "*",
+		"prettier": "^3.2.5",
+		"ts-node": "^10.9.1",
+		"typescript": "~5.4.2"
+	},
+	"homepage": "https://atlaskit.atlassian.com/packages/monorepo-tooling/codemod-cli"
+}

package/report.api.md

@@ -2,7 +2,8 @@
 
 ## API Report File for "@atlaskit/codemod-cli"
 
-> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> Do not edit this file. This report is auto-generated using
+> [API Extractor](https://api-extractor.com/).
 > [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
 ### Table of contents
@@ -17,15 +18,15 @@
 ```ts
 // @public (undocumented)
 type CliFlags = {
-  transform?: string;
-  preset?: string;
-  packages?: string;
-  parser: 'babel' | 'babylon' | 'flow' | 'ts' | 'tsx';
-  extensions: string;
-  ignorePattern: string;
-  sinceRef?: string;
-  failOnError?: boolean;
-  filterPaths?: boolean;
+	transform?: string;
+	preset?: string;
+	packages?: string;
+	parser: 'babel' | 'babylon' | 'flow' | 'ts' | 'tsx';
+	extensions: string;
+	ignorePattern: string;
+	sinceRef?: string;
+	failOnError?: boolean;
+	filterPaths?: boolean;
 };
 
 // @public
@@ -33,34 +34,34 @@ type Default<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 
 // @public (undocumented)
 const defaultFlags: {
-  parser: 'babel';
-  extensions: string;
-  ignorePattern: string;
-  logger: Console;
+	parser: 'babel';
+	extensions: string;
+	ignorePattern: string;
+	logger: Console;
 };
 
 // @public (undocumented)
 type Flags_2 = CliFlags & {
-  logger: {
-    log: (...args: any) => void;
-    warn: (...args: any) => void;
-  };
+	logger: {
+		log: (...args: any) => void;
+		warn: (...args: any) => void;
+	};
 };
 export { Flags_2 as Flags };
 
 // @public (undocumented)
 function main(
-  input: string[],
-  userFlags: UserFlags,
+	input: string[],
+	userFlags: UserFlags,
 ): Promise<{
-  transforms: {
-    module: string;
-    root: string;
-    dir: string;
-    base: string;
-    ext: string;
-    name: string;
-  }[];
+	transforms: {
+		module: string;
+		root: string;
+		dir: string;
+		base: string;
+		ext: string;
+		name: string;
+	}[];
 }>;
 export default main;