@atlaskit/codemod-cli 0.26.3 → 0.27.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/codemod-cli
 
+## 0.27.0
+
+### Minor Changes
+
+- [#163865](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/163865)
+  [`e66453c2716df`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/e66453c2716df) -
+  Added new codemod for migrating to Link component from `@atlaskit/link`.
+
 ## 0.26.3
 
 ### Patch Changes

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.26.3", _PACKAGE_VERSION_ = _process$env$_PACKAGE === void 0 ? '0.0.0-dev' : _process$env$_PACKAGE;
+          _process$env$_PACKAGE = "0.27.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/index.js

@@ -8,6 +8,7 @@ exports.default = void 0;
 var _path = _interopRequireDefault(require("path"));
 require("./styled-to-emotion/styled-to-emotion");
 require("./theme-remove-deprecated-mixins/theme-remove-deprecated-mixins");
+require("./migrate-to-link/migrate-to-link");
 require("./migrate-to-new-buttons/migrate-to-new-buttons");
 require("./upgrade-pragmatic-drag-and-drop-to-stable/upgrade-pragmatic-drag-and-drop-to-stable");
 require("./remove-dark-theme-vr-options/remove-dark-theme-vr-options");
@@ -16,7 +17,7 @@ require("./remove-dark-theme-vr-options/remove-dark-theme-vr-options");
  * in the final bundle.
  */
 
-var presets = ['styled-to-emotion', 'theme-remove-deprecated-mixins', 'migrate-to-new-buttons', 'upgrade-pragmatic-drag-and-drop-to-stable', 'remove-dark-theme-vr-options'].map(function (preset) {
+var presets = ['styled-to-emotion', 'theme-remove-deprecated-mixins', 'migrate-to-link', 'migrate-to-new-buttons', 'upgrade-pragmatic-drag-and-drop-to-stable', 'remove-dark-theme-vr-options'].map(function (preset) {
   return _path.default.join(__dirname, preset, "".concat(preset, ".@(ts|js|tsx)"));
 });
 var _default = exports.default = presets;

package/dist/cjs/presets/migrate-to-link/codemods/migrate-to-link.js

@@ -0,0 +1,139 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = transformer;
+var _codemodUtils = require("@atlaskit/codemod-utils");
+var _utils = require("@hypermod/utils");
+var _constants = require("../utils/constants");
+var _comments = require("../utils/comments");
+var _findAttributeWithValue = require("../utils/find-attribute-with-value");
+/* eslint-disable @repo/internal/fs/filename-pattern-match */
+
+function transformer(file, api) {
+  var j = api.jscodeshift;
+  var source = j(file.source);
+
+  // Find all native links
+  var nativeLinks = source.find(j.JSXElement).filter(function (path) {
+    return path.value.openingElement.name.type === 'JSXIdentifier' && /^[a-z]+$/.test(path.value.openingElement.name.name) && (path.value.openingElement.name.name === 'a' || (0, _findAttributeWithValue.findJSXAttributeWithValue)(path.value.openingElement, 'role', 'link'));
+  });
+
+  // No native links are found, exit early
+  if (!nativeLinks.length) {
+    return file.source;
+  }
+
+  // Links we can migrate
+  var nativeLinksSupportedForMigration = [];
+
+  // Links we can't migrate, but will leave a code comment as a suggestion for manual migration
+  var nativeLinksUnsupportedForMigration = [];
+
+  // Check for existing imports
+  var existingLinkImports = (0, _utils.getImportDeclaration)(j, source, _constants.LINK_ENTRY_POINT);
+
+  // Sets import name to be used. May be updated if an existing import is found with a different name
+  var linkImportName = _constants.LINK_EXPORT_NAME;
+  nativeLinks.forEach(function (path) {
+    var _path$value$openingEl;
+    var unsupportedMigrations = (_path$value$openingEl = path.value.openingElement) === null || _path$value$openingEl === void 0 || (_path$value$openingEl = _path$value$openingEl.attributes) === null || _path$value$openingEl === void 0 ? void 0 : _path$value$openingEl.reduce(function (acc, attribute) {
+      if (attribute.type === 'JSXSpreadAttribute') {
+        acc.push({
+          name: '',
+          reason: 'spreadProps'
+        });
+      } else if (_constants.UNSUPPORTED_STYLE_PROPS.includes(attribute.name.name.toString())) {
+        acc.push({
+          name: attribute.name.name.toString(),
+          reason: 'styleProp'
+        });
+      }
+      return acc;
+    }, []);
+    if (unsupportedMigrations !== null && unsupportedMigrations !== void 0 && unsupportedMigrations.length) {
+      nativeLinksUnsupportedForMigration.push({
+        path: path,
+        unsupportedMigrations: unsupportedMigrations
+      });
+    } else {
+      nativeLinksSupportedForMigration.push(path);
+    }
+  });
+  if (nativeLinksSupportedForMigration.length) {
+    // Generate a unique import name if there is a different existing import named "Link"
+    var importNameSuffix = 1;
+    var uniqueLinkImportName = linkImportName;
+    while (source.find(j.ImportDeclaration).some(function (importDecl) {
+      var _importDecl$value$spe;
+      return Boolean((_importDecl$value$spe = importDecl.value.specifiers) === null || _importDecl$value$spe === void 0 ? void 0 : _importDecl$value$spe.some(function (specifier) {
+        var _specifier$local;
+        return ((_specifier$local = specifier.local) === null || _specifier$local === void 0 ? void 0 : _specifier$local.name) === uniqueLinkImportName;
+      }));
+    })) {
+      uniqueLinkImportName = "".concat(linkImportName).concat(importNameSuffix);
+      importNameSuffix++;
+    }
+    linkImportName = uniqueLinkImportName;
+
+    // Add link import
+    // If no existing link imports are found, add a new import
+    if (!existingLinkImports.length) {
+      var linkImport = j.importDeclaration([j.importDefaultSpecifier(j.identifier(linkImportName))], j.stringLiteral(_constants.LINK_ENTRY_POINT));
+      var importDeclarations = source.find(j.ImportDeclaration);
+      if (importDeclarations.length) {
+        importDeclarations.at(importDeclarations.length - 1).get().insertAfter(linkImport);
+      } else {
+        source.get().node.program.body.unshift(linkImport);
+      }
+    }
+    // If an existing `@atlaskit/link import` is found, import Link if it's not already imported
+    else {
+      var hasExistingSpecifier = existingLinkImports.some(function (importDecl) {
+        var _importDecl$value$spe2;
+        return Boolean((_importDecl$value$spe2 = importDecl.value.specifiers) === null || _importDecl$value$spe2 === void 0 ? void 0 : _importDecl$value$spe2.some(function (specifier) {
+          var _specifier$local2;
+          var isDefaultImport = specifier.type === 'ImportDefaultSpecifier';
+          if (isDefaultImport && (_specifier$local2 = specifier.local) !== null && _specifier$local2 !== void 0 && _specifier$local2.name) {
+            var _specifier$local3;
+            linkImportName = (_specifier$local3 = specifier.local) === null || _specifier$local3 === void 0 ? void 0 : _specifier$local3.name;
+            return true;
+          }
+        }));
+      });
+      if (!hasExistingSpecifier) {
+        existingLinkImports.at(0).get().node.specifiers.push(j.importDefaultSpecifier(j.identifier(linkImportName)));
+      }
+    }
+    nativeLinksSupportedForMigration.forEach(function (link) {
+      var attributes = link.node.openingElement.attributes;
+
+      // Remove role="link" attributes
+      var filteredAttributes = attributes === null || attributes === void 0 ? void 0 : attributes.filter(function (attr) {
+        var _attr$value;
+        return !(attr.type === 'JSXAttribute' && attr.name.name === 'role' && ((_attr$value = attr.value) === null || _attr$value === void 0 ? void 0 : _attr$value.type) === 'StringLiteral' && attr.value.value === 'link');
+      });
+      j(link).replaceWith(j.jsxElement.from({
+        openingElement: j.jsxOpeningElement(j.jsxIdentifier(linkImportName), filteredAttributes, false),
+        closingElement: j.jsxClosingElement(j.jsxIdentifier(linkImportName)),
+        children: link.node.children
+      }));
+    });
+  }
+  nativeLinksUnsupportedForMigration.forEach(function (link) {
+    (0, _codemodUtils.addCommentBefore)(j, j(link.path), "\n".concat(link.unsupportedMigrations.map(function (unsupported) {
+      switch (unsupported.reason) {
+        case 'styleProp':
+          return (0, _comments.stylePropComment)({
+            propName: unsupported.name
+          });
+        case 'spreadProps':
+          return _comments.spreadPropsComment;
+        default:
+          break;
+      }
+    }).join('\n'), "\n").concat((0, _comments.genericUnsupportedMigrationComment)(), "\n\n"));
+  });
+  return source.toSource(_constants.PRINT_SETTINGS);
+}

package/dist/cjs/presets/migrate-to-link/migrate-to-link.js

@@ -0,0 +1,44 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = transformer;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _migrateToLink = _interopRequireDefault(require("./codemods/migrate-to-link"));
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function transformer(_x, _x2) {
+  return _transformer.apply(this, arguments);
+}
+function _transformer() {
+  _transformer = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(file, api) {
+    var transformers, src;
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          transformers = [_migrateToLink.default];
+          src = file.source;
+          transformers.forEach(function (transformer) {
+            if (typeof src === 'undefined') {
+              return;
+            }
+            var nextSrc = transformer(_objectSpread(_objectSpread({}, file), {}, {
+              source: src
+            }), api);
+            if (nextSrc) {
+              src = nextSrc;
+            }
+          });
+          return _context.abrupt("return", src);
+        case 4:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  }));
+  return _transformer.apply(this, arguments);
+}

package/dist/cjs/presets/migrate-to-link/utils/comments.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.stylePropComment = exports.spreadPropsComment = exports.genericUnsupportedMigrationComment = void 0;
+var _constants = require("./constants");
+var stylePropComment = exports.stylePropComment = function stylePropComment(_ref) {
+  var propName = _ref.propName,
+    _ref$prefix = _ref.prefix,
+    prefix = _ref$prefix === void 0 ? '' : _ref$prefix;
+  return "".concat(prefix, "This link could not be migrated due to custom styles in `").concat(propName, "` prop.");
+};
+var spreadPropsComment = exports.spreadPropsComment = "This link could not be migrated due to usage of spread props. The codemod cannot determine the props being spread. Please manually migrate.";
+var genericUnsupportedMigrationComment = exports.genericUnsupportedMigrationComment = function genericUnsupportedMigrationComment() {
+  var prefix = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
+  return "".concat(prefix, "- If this is a simple text-based link, replace with `").concat(_constants.LINK_ENTRY_POINT, "`.\n").concat(prefix, "- If this is a button-like link style, replace with a link button from `@atlaskit/button`.\n").concat(prefix, "- If this needs to retain custom styles, use the `Anchor` primitive from `@atlaskit/primitives`.");
+};

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

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.UNSUPPORTED_STYLE_PROPS = exports.PRINT_SETTINGS = exports.LINK_EXPORT_NAME = exports.LINK_ENTRY_POINT = void 0;
+var PRINT_SETTINGS = exports.PRINT_SETTINGS = {
+  quote: 'single'
+};
+var LINK_ENTRY_POINT = exports.LINK_ENTRY_POINT = '@atlaskit/link';
+var LINK_EXPORT_NAME = exports.LINK_EXPORT_NAME = 'Link';
+var UNSUPPORTED_STYLE_PROPS = exports.UNSUPPORTED_STYLE_PROPS = ['css', 'style', 'className'];

package/dist/cjs/presets/migrate-to-link/utils/find-attribute-with-value.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.findJSXAttributeWithValue = void 0;
+var findJSXAttributeWithValue = exports.findJSXAttributeWithValue = function findJSXAttributeWithValue(path, attributeName, attributeValue) {
+  var _path$attributes;
+  if (!path || path.type === 'JSXSpreadAttribute') {
+    return false;
+  }
+  var attribute = path === null || path === void 0 || (_path$attributes = path.attributes) === null || _path$attributes === void 0 ? void 0 : _path$attributes.find(function (attribute) {
+    var _attribute$value;
+    return attribute.type === 'JSXAttribute' && attribute.name.name === attributeName && ((_attribute$value = attribute.value) === null || _attribute$value === void 0 ? void 0 : _attribute$value.type) === 'StringLiteral' && attribute.value.value === attributeValue;
+  });
+  return Boolean(attribute);
+};

package/dist/es2019/presets/index.js

@@ -6,8 +6,9 @@ import path from 'path';
  */
 import './styled-to-emotion/styled-to-emotion';
 import './theme-remove-deprecated-mixins/theme-remove-deprecated-mixins';
+import './migrate-to-link/migrate-to-link';
 import './migrate-to-new-buttons/migrate-to-new-buttons';
 import './upgrade-pragmatic-drag-and-drop-to-stable/upgrade-pragmatic-drag-and-drop-to-stable';
 import './remove-dark-theme-vr-options/remove-dark-theme-vr-options';
-const presets = ['styled-to-emotion', 'theme-remove-deprecated-mixins', 'migrate-to-new-buttons', 'upgrade-pragmatic-drag-and-drop-to-stable', 'remove-dark-theme-vr-options'].map(preset => path.join(__dirname, preset, `${preset}.@(ts|js|tsx)`));
+const presets = ['styled-to-emotion', 'theme-remove-deprecated-mixins', 'migrate-to-link', 'migrate-to-new-buttons', 'upgrade-pragmatic-drag-and-drop-to-stable', 'remove-dark-theme-vr-options'].map(preset => path.join(__dirname, preset, `${preset}.@(ts|js|tsx)`));
 export default presets;

package/dist/es2019/presets/migrate-to-link/codemods/migrate-to-link.js

@@ -0,0 +1,136 @@
+/* eslint-disable @repo/internal/fs/filename-pattern-match */
+
+import { addCommentBefore } from '@atlaskit/codemod-utils';
+import { getImportDeclaration } from '@hypermod/utils';
+import { LINK_ENTRY_POINT, LINK_EXPORT_NAME, PRINT_SETTINGS, UNSUPPORTED_STYLE_PROPS } from '../utils/constants';
+import { genericUnsupportedMigrationComment, spreadPropsComment, stylePropComment } from '../utils/comments';
+import { findJSXAttributeWithValue } from '../utils/find-attribute-with-value';
+export default function transformer(file, api) {
+  const j = api.jscodeshift;
+  const source = j(file.source);
+
+  // Find all native links
+  const nativeLinks = source.find(j.JSXElement).filter(path => path.value.openingElement.name.type === 'JSXIdentifier' && /^[a-z]+$/.test(path.value.openingElement.name.name) && (path.value.openingElement.name.name === 'a' || findJSXAttributeWithValue(path.value.openingElement, 'role', 'link')));
+
+  // No native links are found, exit early
+  if (!nativeLinks.length) {
+    return file.source;
+  }
+
+  // Links we can migrate
+  const nativeLinksSupportedForMigration = [];
+
+  // Links we can't migrate, but will leave a code comment as a suggestion for manual migration
+  const nativeLinksUnsupportedForMigration = [];
+
+  // Check for existing imports
+  const existingLinkImports = getImportDeclaration(j, source, LINK_ENTRY_POINT);
+
+  // Sets import name to be used. May be updated if an existing import is found with a different name
+  let linkImportName = LINK_EXPORT_NAME;
+  nativeLinks.forEach(path => {
+    var _path$value$openingEl, _path$value$openingEl2;
+    const unsupportedMigrations = (_path$value$openingEl = path.value.openingElement) === null || _path$value$openingEl === void 0 ? void 0 : (_path$value$openingEl2 = _path$value$openingEl.attributes) === null || _path$value$openingEl2 === void 0 ? void 0 : _path$value$openingEl2.reduce((acc, attribute) => {
+      if (attribute.type === 'JSXSpreadAttribute') {
+        acc.push({
+          name: '',
+          reason: 'spreadProps'
+        });
+      } else if (UNSUPPORTED_STYLE_PROPS.includes(attribute.name.name.toString())) {
+        acc.push({
+          name: attribute.name.name.toString(),
+          reason: 'styleProp'
+        });
+      }
+      return acc;
+    }, []);
+    if (unsupportedMigrations !== null && unsupportedMigrations !== void 0 && unsupportedMigrations.length) {
+      nativeLinksUnsupportedForMigration.push({
+        path,
+        unsupportedMigrations
+      });
+    } else {
+      nativeLinksSupportedForMigration.push(path);
+    }
+  });
+  if (nativeLinksSupportedForMigration.length) {
+    // Generate a unique import name if there is a different existing import named "Link"
+    let importNameSuffix = 1;
+    let uniqueLinkImportName = linkImportName;
+    while (source.find(j.ImportDeclaration).some(importDecl => {
+      var _importDecl$value$spe;
+      return Boolean((_importDecl$value$spe = importDecl.value.specifiers) === null || _importDecl$value$spe === void 0 ? void 0 : _importDecl$value$spe.some(specifier => {
+        var _specifier$local;
+        return ((_specifier$local = specifier.local) === null || _specifier$local === void 0 ? void 0 : _specifier$local.name) === uniqueLinkImportName;
+      }));
+    })) {
+      uniqueLinkImportName = `${linkImportName}${importNameSuffix}`;
+      importNameSuffix++;
+    }
+    linkImportName = uniqueLinkImportName;
+
+    // Add link import
+    // If no existing link imports are found, add a new import
+    if (!existingLinkImports.length) {
+      const linkImport = j.importDeclaration([j.importDefaultSpecifier(j.identifier(linkImportName))], j.stringLiteral(LINK_ENTRY_POINT));
+      const importDeclarations = source.find(j.ImportDeclaration);
+      if (importDeclarations.length) {
+        importDeclarations.at(importDeclarations.length - 1).get().insertAfter(linkImport);
+      } else {
+        source.get().node.program.body.unshift(linkImport);
+      }
+    }
+    // If an existing `@atlaskit/link import` is found, import Link if it's not already imported
+    else {
+      const hasExistingSpecifier = existingLinkImports.some(importDecl => {
+        var _importDecl$value$spe2;
+        return Boolean((_importDecl$value$spe2 = importDecl.value.specifiers) === null || _importDecl$value$spe2 === void 0 ? void 0 : _importDecl$value$spe2.some(specifier => {
+          var _specifier$local2;
+          const isDefaultImport = specifier.type === 'ImportDefaultSpecifier';
+          if (isDefaultImport && (_specifier$local2 = specifier.local) !== null && _specifier$local2 !== void 0 && _specifier$local2.name) {
+            var _specifier$local3;
+            linkImportName = (_specifier$local3 = specifier.local) === null || _specifier$local3 === void 0 ? void 0 : _specifier$local3.name;
+            return true;
+          }
+        }));
+      });
+      if (!hasExistingSpecifier) {
+        existingLinkImports.at(0).get().node.specifiers.push(j.importDefaultSpecifier(j.identifier(linkImportName)));
+      }
+    }
+    nativeLinksSupportedForMigration.forEach(link => {
+      const {
+        attributes
+      } = link.node.openingElement;
+
+      // Remove role="link" attributes
+      const filteredAttributes = attributes === null || attributes === void 0 ? void 0 : attributes.filter(attr => {
+        var _attr$value;
+        return !(attr.type === 'JSXAttribute' && attr.name.name === 'role' && ((_attr$value = attr.value) === null || _attr$value === void 0 ? void 0 : _attr$value.type) === 'StringLiteral' && attr.value.value === 'link');
+      });
+      j(link).replaceWith(j.jsxElement.from({
+        openingElement: j.jsxOpeningElement(j.jsxIdentifier(linkImportName), filteredAttributes, false),
+        closingElement: j.jsxClosingElement(j.jsxIdentifier(linkImportName)),
+        children: link.node.children
+      }));
+    });
+  }
+  nativeLinksUnsupportedForMigration.forEach(link => {
+    addCommentBefore(j, j(link.path), `
+${link.unsupportedMigrations.map(unsupported => {
+      switch (unsupported.reason) {
+        case 'styleProp':
+          return stylePropComment({
+            propName: unsupported.name
+          });
+        case 'spreadProps':
+          return spreadPropsComment;
+        default:
+          break;
+      }
+    }).join('\n')}
+${genericUnsupportedMigrationComment()}\n
+`);
+  });
+  return source.toSource(PRINT_SETTINGS);
+}

package/dist/es2019/presets/migrate-to-link/migrate-to-link.js

@@ -0,0 +1,18 @@
+import migrateToLinkTransformer from './codemods/migrate-to-link';
+export default async function transformer(file, api) {
+  const transformers = [migrateToLinkTransformer];
+  let src = file.source;
+  transformers.forEach(transformer => {
+    if (typeof src === 'undefined') {
+      return;
+    }
+    const nextSrc = transformer({
+      ...file,
+      source: src
+    }, api);
+    if (nextSrc) {
+      src = nextSrc;
+    }
+  });
+  return src;
+}

package/dist/es2019/presets/migrate-to-link/utils/comments.js

@@ -0,0 +1,11 @@
+import { LINK_ENTRY_POINT } from './constants';
+export const stylePropComment = ({
+  propName,
+  prefix = ''
+}) => {
+  return `${prefix}This link could not be migrated due to custom styles in \`${propName}\` prop.`;
+};
+export const spreadPropsComment = `This link could not be migrated due to usage of spread props. The codemod cannot determine the props being spread. Please manually migrate.`;
+export const genericUnsupportedMigrationComment = (prefix = '') => `${prefix}- If this is a simple text-based link, replace with \`${LINK_ENTRY_POINT}\`.
+${prefix}- If this is a button-like link style, replace with a link button from \`@atlaskit/button\`.
+${prefix}- If this needs to retain custom styles, use the \`Anchor\` primitive from \`@atlaskit/primitives\`.`;

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

@@ -0,0 +1,6 @@
+export const PRINT_SETTINGS = {
+  quote: 'single'
+};
+export const LINK_ENTRY_POINT = '@atlaskit/link';
+export const LINK_EXPORT_NAME = 'Link';
+export const UNSUPPORTED_STYLE_PROPS = ['css', 'style', 'className'];

package/dist/es2019/presets/migrate-to-link/utils/find-attribute-with-value.js

@@ -0,0 +1,11 @@
+export const findJSXAttributeWithValue = (path, attributeName, attributeValue) => {
+  var _path$attributes;
+  if (!path || path.type === 'JSXSpreadAttribute') {
+    return false;
+  }
+  const attribute = path === null || path === void 0 ? void 0 : (_path$attributes = path.attributes) === null || _path$attributes === void 0 ? void 0 : _path$attributes.find(attribute => {
+    var _attribute$value;
+    return attribute.type === 'JSXAttribute' && attribute.name.name === attributeName && ((_attribute$value = attribute.value) === null || _attribute$value === void 0 ? void 0 : _attribute$value.type) === 'StringLiteral' && attribute.value.value === attributeValue;
+  });
+  return Boolean(attribute);
+};

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.26.3", _PACKAGE_VERSION_ = _process$env$_PACKAGE === void 0 ? '0.0.0-dev' : _process$env$_PACKAGE;
+          _process$env$_PACKAGE = "0.27.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/index.js

@@ -6,10 +6,11 @@ import path from 'path';
  */
 import './styled-to-emotion/styled-to-emotion';
 import './theme-remove-deprecated-mixins/theme-remove-deprecated-mixins';
+import './migrate-to-link/migrate-to-link';
 import './migrate-to-new-buttons/migrate-to-new-buttons';
 import './upgrade-pragmatic-drag-and-drop-to-stable/upgrade-pragmatic-drag-and-drop-to-stable';
 import './remove-dark-theme-vr-options/remove-dark-theme-vr-options';
-var presets = ['styled-to-emotion', 'theme-remove-deprecated-mixins', 'migrate-to-new-buttons', 'upgrade-pragmatic-drag-and-drop-to-stable', 'remove-dark-theme-vr-options'].map(function (preset) {
+var presets = ['styled-to-emotion', 'theme-remove-deprecated-mixins', 'migrate-to-link', 'migrate-to-new-buttons', 'upgrade-pragmatic-drag-and-drop-to-stable', 'remove-dark-theme-vr-options'].map(function (preset) {
   return path.join(__dirname, preset, "".concat(preset, ".@(ts|js|tsx)"));
 });
 export default presets;

package/dist/esm/presets/migrate-to-link/codemods/migrate-to-link.js

@@ -0,0 +1,133 @@
+/* eslint-disable @repo/internal/fs/filename-pattern-match */
+
+import { addCommentBefore } from '@atlaskit/codemod-utils';
+import { getImportDeclaration } from '@hypermod/utils';
+import { LINK_ENTRY_POINT, LINK_EXPORT_NAME, PRINT_SETTINGS, UNSUPPORTED_STYLE_PROPS } from '../utils/constants';
+import { genericUnsupportedMigrationComment, spreadPropsComment, stylePropComment } from '../utils/comments';
+import { findJSXAttributeWithValue } from '../utils/find-attribute-with-value';
+export default function transformer(file, api) {
+  var j = api.jscodeshift;
+  var source = j(file.source);
+
+  // Find all native links
+  var nativeLinks = source.find(j.JSXElement).filter(function (path) {
+    return path.value.openingElement.name.type === 'JSXIdentifier' && /^[a-z]+$/.test(path.value.openingElement.name.name) && (path.value.openingElement.name.name === 'a' || findJSXAttributeWithValue(path.value.openingElement, 'role', 'link'));
+  });
+
+  // No native links are found, exit early
+  if (!nativeLinks.length) {
+    return file.source;
+  }
+
+  // Links we can migrate
+  var nativeLinksSupportedForMigration = [];
+
+  // Links we can't migrate, but will leave a code comment as a suggestion for manual migration
+  var nativeLinksUnsupportedForMigration = [];
+
+  // Check for existing imports
+  var existingLinkImports = getImportDeclaration(j, source, LINK_ENTRY_POINT);
+
+  // Sets import name to be used. May be updated if an existing import is found with a different name
+  var linkImportName = LINK_EXPORT_NAME;
+  nativeLinks.forEach(function (path) {
+    var _path$value$openingEl;
+    var unsupportedMigrations = (_path$value$openingEl = path.value.openingElement) === null || _path$value$openingEl === void 0 || (_path$value$openingEl = _path$value$openingEl.attributes) === null || _path$value$openingEl === void 0 ? void 0 : _path$value$openingEl.reduce(function (acc, attribute) {
+      if (attribute.type === 'JSXSpreadAttribute') {
+        acc.push({
+          name: '',
+          reason: 'spreadProps'
+        });
+      } else if (UNSUPPORTED_STYLE_PROPS.includes(attribute.name.name.toString())) {
+        acc.push({
+          name: attribute.name.name.toString(),
+          reason: 'styleProp'
+        });
+      }
+      return acc;
+    }, []);
+    if (unsupportedMigrations !== null && unsupportedMigrations !== void 0 && unsupportedMigrations.length) {
+      nativeLinksUnsupportedForMigration.push({
+        path: path,
+        unsupportedMigrations: unsupportedMigrations
+      });
+    } else {
+      nativeLinksSupportedForMigration.push(path);
+    }
+  });
+  if (nativeLinksSupportedForMigration.length) {
+    // Generate a unique import name if there is a different existing import named "Link"
+    var importNameSuffix = 1;
+    var uniqueLinkImportName = linkImportName;
+    while (source.find(j.ImportDeclaration).some(function (importDecl) {
+      var _importDecl$value$spe;
+      return Boolean((_importDecl$value$spe = importDecl.value.specifiers) === null || _importDecl$value$spe === void 0 ? void 0 : _importDecl$value$spe.some(function (specifier) {
+        var _specifier$local;
+        return ((_specifier$local = specifier.local) === null || _specifier$local === void 0 ? void 0 : _specifier$local.name) === uniqueLinkImportName;
+      }));
+    })) {
+      uniqueLinkImportName = "".concat(linkImportName).concat(importNameSuffix);
+      importNameSuffix++;
+    }
+    linkImportName = uniqueLinkImportName;
+
+    // Add link import
+    // If no existing link imports are found, add a new import
+    if (!existingLinkImports.length) {
+      var linkImport = j.importDeclaration([j.importDefaultSpecifier(j.identifier(linkImportName))], j.stringLiteral(LINK_ENTRY_POINT));
+      var importDeclarations = source.find(j.ImportDeclaration);
+      if (importDeclarations.length) {
+        importDeclarations.at(importDeclarations.length - 1).get().insertAfter(linkImport);
+      } else {
+        source.get().node.program.body.unshift(linkImport);
+      }
+    }
+    // If an existing `@atlaskit/link import` is found, import Link if it's not already imported
+    else {
+      var hasExistingSpecifier = existingLinkImports.some(function (importDecl) {
+        var _importDecl$value$spe2;
+        return Boolean((_importDecl$value$spe2 = importDecl.value.specifiers) === null || _importDecl$value$spe2 === void 0 ? void 0 : _importDecl$value$spe2.some(function (specifier) {
+          var _specifier$local2;
+          var isDefaultImport = specifier.type === 'ImportDefaultSpecifier';
+          if (isDefaultImport && (_specifier$local2 = specifier.local) !== null && _specifier$local2 !== void 0 && _specifier$local2.name) {
+            var _specifier$local3;
+            linkImportName = (_specifier$local3 = specifier.local) === null || _specifier$local3 === void 0 ? void 0 : _specifier$local3.name;
+            return true;
+          }
+        }));
+      });
+      if (!hasExistingSpecifier) {
+        existingLinkImports.at(0).get().node.specifiers.push(j.importDefaultSpecifier(j.identifier(linkImportName)));
+      }
+    }
+    nativeLinksSupportedForMigration.forEach(function (link) {
+      var attributes = link.node.openingElement.attributes;
+
+      // Remove role="link" attributes
+      var filteredAttributes = attributes === null || attributes === void 0 ? void 0 : attributes.filter(function (attr) {
+        var _attr$value;
+        return !(attr.type === 'JSXAttribute' && attr.name.name === 'role' && ((_attr$value = attr.value) === null || _attr$value === void 0 ? void 0 : _attr$value.type) === 'StringLiteral' && attr.value.value === 'link');
+      });
+      j(link).replaceWith(j.jsxElement.from({
+        openingElement: j.jsxOpeningElement(j.jsxIdentifier(linkImportName), filteredAttributes, false),
+        closingElement: j.jsxClosingElement(j.jsxIdentifier(linkImportName)),
+        children: link.node.children
+      }));
+    });
+  }
+  nativeLinksUnsupportedForMigration.forEach(function (link) {
+    addCommentBefore(j, j(link.path), "\n".concat(link.unsupportedMigrations.map(function (unsupported) {
+      switch (unsupported.reason) {
+        case 'styleProp':
+          return stylePropComment({
+            propName: unsupported.name
+          });
+        case 'spreadProps':
+          return spreadPropsComment;
+        default:
+          break;
+      }
+    }).join('\n'), "\n").concat(genericUnsupportedMigrationComment(), "\n\n"));
+  });
+  return source.toSource(PRINT_SETTINGS);
+}

package/dist/esm/presets/migrate-to-link/migrate-to-link.js

@@ -0,0 +1,37 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import migrateToLinkTransformer from './codemods/migrate-to-link';
+export default function transformer(_x, _x2) {
+  return _transformer.apply(this, arguments);
+}
+function _transformer() {
+  _transformer = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(file, api) {
+    var transformers, src;
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          transformers = [migrateToLinkTransformer];
+          src = file.source;
+          transformers.forEach(function (transformer) {
+            if (typeof src === 'undefined') {
+              return;
+            }
+            var nextSrc = transformer(_objectSpread(_objectSpread({}, file), {}, {
+              source: src
+            }), api);
+            if (nextSrc) {
+              src = nextSrc;
+            }
+          });
+          return _context.abrupt("return", src);
+        case 4:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  }));
+  return _transformer.apply(this, arguments);
+}

package/dist/esm/presets/migrate-to-link/utils/comments.js

@@ -0,0 +1,12 @@
+import { LINK_ENTRY_POINT } from './constants';
+export var stylePropComment = function stylePropComment(_ref) {
+  var propName = _ref.propName,
+    _ref$prefix = _ref.prefix,
+    prefix = _ref$prefix === void 0 ? '' : _ref$prefix;
+  return "".concat(prefix, "This link could not be migrated due to custom styles in `").concat(propName, "` prop.");
+};
+export var spreadPropsComment = "This link could not be migrated due to usage of spread props. The codemod cannot determine the props being spread. Please manually migrate.";
+export var genericUnsupportedMigrationComment = function genericUnsupportedMigrationComment() {
+  var prefix = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
+  return "".concat(prefix, "- If this is a simple text-based link, replace with `").concat(LINK_ENTRY_POINT, "`.\n").concat(prefix, "- If this is a button-like link style, replace with a link button from `@atlaskit/button`.\n").concat(prefix, "- If this needs to retain custom styles, use the `Anchor` primitive from `@atlaskit/primitives`.");
+};

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

@@ -0,0 +1,6 @@
+export var PRINT_SETTINGS = {
+  quote: 'single'
+};
+export var LINK_ENTRY_POINT = '@atlaskit/link';
+export var LINK_EXPORT_NAME = 'Link';
+export var UNSUPPORTED_STYLE_PROPS = ['css', 'style', 'className'];

package/dist/esm/presets/migrate-to-link/utils/find-attribute-with-value.js

@@ -0,0 +1,11 @@
+export var findJSXAttributeWithValue = function findJSXAttributeWithValue(path, attributeName, attributeValue) {
+  var _path$attributes;
+  if (!path || path.type === 'JSXSpreadAttribute') {
+    return false;
+  }
+  var attribute = path === null || path === void 0 || (_path$attributes = path.attributes) === null || _path$attributes === void 0 ? void 0 : _path$attributes.find(function (attribute) {
+    var _attribute$value;
+    return attribute.type === 'JSXAttribute' && attribute.name.name === attributeName && ((_attribute$value = attribute.value) === null || _attribute$value === void 0 ? void 0 : _attribute$value.type) === 'StringLiteral' && attribute.value.value === attributeValue;
+  });
+  return Boolean(attribute);
+};

package/dist/types/presets/index.d.ts

@@ -4,6 +4,7 @@
  */
 import './styled-to-emotion/styled-to-emotion';
 import './theme-remove-deprecated-mixins/theme-remove-deprecated-mixins';
+import './migrate-to-link/migrate-to-link';
 import './migrate-to-new-buttons/migrate-to-new-buttons';
 import './upgrade-pragmatic-drag-and-drop-to-stable/upgrade-pragmatic-drag-and-drop-to-stable';
 import './remove-dark-theme-vr-options/remove-dark-theme-vr-options';

package/dist/types/presets/migrate-to-link/codemods/migrate-to-link.d.ts

@@ -0,0 +1,2 @@
+import { type API, type FileInfo } from 'jscodeshift';
+export default function transformer(file: FileInfo, api: API): string;

package/dist/types/presets/migrate-to-link/migrate-to-link.d.ts

@@ -0,0 +1,2 @@
+import type { API, FileInfo } from 'jscodeshift';
+export default function transformer(file: FileInfo, api: API): Promise<string>;

package/dist/types/presets/migrate-to-link/utils/comments.d.ts

@@ -0,0 +1,6 @@
+export declare const stylePropComment: ({ propName, prefix, }: {
+    propName: string;
+    prefix?: string | undefined;
+}) => string;
+export declare const spreadPropsComment = "This link could not be migrated due to usage of spread props. The codemod cannot determine the props being spread. Please manually migrate.";
+export declare const genericUnsupportedMigrationComment: (prefix?: string) => string;

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

@@ -0,0 +1,6 @@
+export declare const PRINT_SETTINGS: {
+    quote: "single";
+};
+export declare const LINK_ENTRY_POINT = "@atlaskit/link";
+export declare const LINK_EXPORT_NAME = "Link";
+export declare const UNSUPPORTED_STYLE_PROPS: string[];

package/dist/types/presets/migrate-to-link/utils/find-attribute-with-value.d.ts

@@ -0,0 +1,2 @@
+import { type JSXOpeningElement, type JSXSpreadAttribute } from 'jscodeshift';
+export declare const findJSXAttributeWithValue: (path: JSXOpeningElement | JSXSpreadAttribute | undefined, attributeName: string, attributeValue: string) => boolean;

package/dist/types-ts4.5/presets/index.d.ts

@@ -4,6 +4,7 @@
  */
 import './styled-to-emotion/styled-to-emotion';
 import './theme-remove-deprecated-mixins/theme-remove-deprecated-mixins';
+import './migrate-to-link/migrate-to-link';
 import './migrate-to-new-buttons/migrate-to-new-buttons';
 import './upgrade-pragmatic-drag-and-drop-to-stable/upgrade-pragmatic-drag-and-drop-to-stable';
 import './remove-dark-theme-vr-options/remove-dark-theme-vr-options';

package/dist/types-ts4.5/presets/migrate-to-link/codemods/migrate-to-link.d.ts

@@ -0,0 +1,2 @@
+import { type API, type FileInfo } from 'jscodeshift';
+export default function transformer(file: FileInfo, api: API): string;

package/dist/types-ts4.5/presets/migrate-to-link/migrate-to-link.d.ts

@@ -0,0 +1,2 @@
+import type { API, FileInfo } from 'jscodeshift';
+export default function transformer(file: FileInfo, api: API): Promise<string>;

package/dist/types-ts4.5/presets/migrate-to-link/utils/comments.d.ts

@@ -0,0 +1,6 @@
+export declare const stylePropComment: ({ propName, prefix, }: {
+    propName: string;
+    prefix?: string | undefined;
+}) => string;
+export declare const spreadPropsComment = "This link could not be migrated due to usage of spread props. The codemod cannot determine the props being spread. Please manually migrate.";
+export declare const genericUnsupportedMigrationComment: (prefix?: string) => string;

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

@@ -0,0 +1,6 @@
+export declare const PRINT_SETTINGS: {
+    quote: "single";
+};
+export declare const LINK_ENTRY_POINT = "@atlaskit/link";
+export declare const LINK_EXPORT_NAME = "Link";
+export declare const UNSUPPORTED_STYLE_PROPS: string[];

package/dist/types-ts4.5/presets/migrate-to-link/utils/find-attribute-with-value.d.ts

@@ -0,0 +1,2 @@
+import { type JSXOpeningElement, type JSXSpreadAttribute } from 'jscodeshift';
+export declare const findJSXAttributeWithValue: (path: JSXOpeningElement | JSXSpreadAttribute | undefined, attributeName: string, attributeValue: string) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/codemod-cli",
-	"version": "0.26.3",
+	"version": "0.27.0",
 	"description": "A cli for distributing codemods for atlassian-frontend components and services",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -39,7 +39,7 @@
 	"bin": "./bin/codemod-cli.js",
 	"dependencies": {
 		"@atlaskit/codemod-utils": "^4.2.0",
-		"@atlaskit/tokens": "^2.0.0",
+		"@atlaskit/tokens": "^2.3.0",
 		"@babel/runtime": "^7.0.0",
 		"@codeshift/utils": "^0.2.4",
 		"@hypermod/utils": "^0.4.2",