@atlaskit/codemod-cli 0.8.3 → 0.8.6

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @atlaskit/codemod-cli
 
+## 0.8.6
+
+### Patch Changes
+
+- Updated dependencies
+
+## 0.8.5
+
+### Patch Changes
+
+- [`e4dd80187f5`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e4dd80187f5) - Refactors theme-to-tokens codemod with new token names + simplifies logic
+
+## 0.8.4
+
+### Patch Changes
+
+- [`19d72473dfb`](https://bitbucket.org/atlassian/atlassian-frontend/commits/19d72473dfb) - Adds a new codemod preset `theme-to-design-tokens` that helps migrate from atlaskit theme to atlaskit tokens.
+- [`19d72473dfb`](https://bitbucket.org/atlassian/atlassian-frontend/commits/19d72473dfb) - Theme preset is now picked up by the CLI.
+- Updated dependencies
+
 ## 0.8.3
 
 ### Patch Changes

package/README.md

@@ -1,3 +1,13 @@
-# Codemods
+# Codemod CLI
 
-For usage and docs see [here](../../../repo-docs/content/cloud/framework/atlassian-frontend/codemods/01-atlassian-codemods.md)
+Detailed docs and example usage can be found [here](../../../repo-docs/content/cloud/framework/atlassian-frontend/codemods/01-atlassian-codemods.md)
+
+## Testing locally
+
+When wanting to run the CLI before it has been published you can run the start command.
+
+```
+yarn start [commands]
+```
+
+For a list of commands run it with `-h` or look at the [documentation](../../../repo-docs/content/cloud/framework/atlassian-frontend/codemods/01-atlassian-codemods.md).

package/dist/cjs/main.js

@@ -41,9 +41,9 @@ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o =
 
 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; }
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
 var jscodeshift = require.resolve('.bin/jscodeshift');
 
@@ -363,7 +363,7 @@ function _main() {
           case 4:
             _yield$parseArgs = _context5.sent;
             packages = _yield$parseArgs.packages;
-            _process$env$_PACKAGE = "0.8.3", _PACKAGE_VERSION_ = _process$env$_PACKAGE === void 0 ? '0.0.0-dev' : _process$env$_PACKAGE;
+            _process$env$_PACKAGE = "0.8.6", _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) {

package/dist/cjs/presets/index.js

@@ -11,12 +11,14 @@ var _path = _interopRequireDefault(require("path"));
 
 require("./styled-to-emotion/styled-to-emotion");
 
+require("./theme-to-design-tokens/theme-to-design-tokens");
+
 /**
  * Manually import presets to make sure typescript includes them
  * in the final bundle
  */
-var presets = ['styled-to-emotion'].map(function (preset) {
-  return _path.default.join(__dirname, preset, "".concat(preset, ".@(ts|js)"));
+var presets = ['styled-to-emotion', 'theme-to-design-tokens'].map(function (preset) {
+  return _path.default.join(__dirname, preset, "".concat(preset, ".@(ts|js|tsx)"));
 });
 var _default = presets;
 exports.default = _default;

package/dist/cjs/presets/theme-to-design-tokens/theme-to-design-tokens.js

@@ -0,0 +1,145 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = transformer;
+
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+
+var _ast = require("./utils/ast");
+
+var _astMeta = require("./utils/ast-meta");
+
+var _color = require("./utils/color");
+
+var _fuzzySearch = _interopRequireDefault(require("./utils/fuzzy-search"));
+
+var _legacyColors = require("./utils/legacy-colors");
+
+var _tokens = require("./utils/tokens");
+
+/* eslint-disable no-console */
+var search = (0, _fuzzySearch.default)(_tokens.tokens, false);
+
+function hasImportDeclaration(j, source, sourcePath) {
+  return !!source.find(j.ImportDeclaration).filter(function (path) {
+    return path.node.source.value === sourcePath;
+  }).length;
+}
+
+function hasImportSpecifier(j, source, specifier, sourcePath) {
+  return !!source.find(j.ImportDeclaration).filter(function (path) {
+    return path.node.source.value === sourcePath;
+  }).find(j.ImportSpecifier, {
+    local: {
+      name: specifier
+    }
+  }).length;
+}
+
+function insertTokenImport(j, source) {
+  if (hasImportDeclaration(j, source, '@atlaskit/tokens')) {
+    return;
+  }
+
+  var newImport = j.importDeclaration([j.importSpecifier(j.identifier('token'))], j.stringLiteral('@atlaskit/tokens'));
+  source.get().node.program.body.unshift(newImport);
+}
+
+function buildToken(j, tokenId, node) {
+  var callExpr = j.callExpression(j.identifier('token'), [j.stringLiteral(tokenId), node].filter(Boolean));
+  return callExpr;
+}
+
+function getTokenFromNode(j, path) {
+  var baseMeta = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : [];
+  var foundMeta = (0, _astMeta.getMetaFromAncestors)(j, path);
+  var meta = (0, _astMeta.cleanMeta)([].concat((0, _toConsumableArray2.default)(foundMeta), (0, _toConsumableArray2.default)(baseMeta)));
+  var results = search.get(meta.join(' '));
+  var tokenId = ['utility.UNSAFE_util.MISSING_TOKEN'];
+
+  if (results) {
+    tokenId = results.map(function (result) {
+      return result[1];
+    });
+  }
+
+  return tokenId[0];
+}
+
+function transformer(file, api) {
+  var debug = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
+  var j = api.jscodeshift;
+  var source = j(file.source);
+  var transformed = false;
+  source // Handle colors.N100
+  .find(j.MemberExpression).filter(function (path) {
+    return path.value.object.type === 'Identifier' && path.value.object.name === 'colors' && path.value.property.type === 'Identifier' && (0, _color.isLegacyColor)(path.value.property.name);
+  }).filter(function (path) {
+    return !(0, _ast.isDecendantOfToken)(j, path);
+  }).forEach(function (path) {
+    debug && console.log('file:', file.path);
+    insertTokenImport(j, source);
+    var key = path.value.property.type === 'Identifier' ? path.value.property.name : undefined;
+    var colorMeta = _legacyColors.legacyColorMetaMap[key] || [];
+    var tokenId = getTokenFromNode(j, path, colorMeta);
+    j(path).replaceWith(buildToken(j, tokenId, path.value));
+    transformed = true;
+  });
+  source.find(j.ObjectProperty).filter(function (path) {
+    return path.value.value.type === 'Identifier' && ((0, _color.isLegacyColor)(path.value.value.name) || (0, _color.isLegacyNamedColor)(path.value.value.name));
+  }).filter(function (path) {
+    return hasImportSpecifier(j, source, path.value.value.type === 'Identifier' ? path.value.value.name : '', '@atlaskit/theme') || hasImportSpecifier(j, source, path.value.value.type === 'Identifier' ? path.value.value.name : '', '@atlaskit/theme/colors');
+  }).filter(function (path) {
+    return !(0, _ast.isDecendantOfToken)(j, path.value.value);
+  }).forEach(function (path) {
+    var valuePath = path.get('value');
+    debug && console.log('file:', file.path);
+    insertTokenImport(j, source);
+    var colorMeta = _legacyColors.legacyColorMetaMap[valuePath.name] || [];
+    var tokenId = getTokenFromNode(j, valuePath, colorMeta);
+    j(path).replaceWith(j.objectProperty(path.value.key, buildToken(j, tokenId, valuePath.value)));
+    transformed = true;
+  });
+  source.find(j.Identifier).filter(function (path) {
+    return (0, _color.isLegacyColor)(path.value.name) || (0, _color.isLegacyNamedColor)(path.value.name);
+  }).filter(function (path) {
+    return hasImportSpecifier(j, source, path.value.name, '@atlaskit/theme') || hasImportSpecifier(j, source, path.value.name, '@atlaskit/theme/colors');
+  }).filter(function (path) {
+    return !['ImportSpecifier', 'MemberExpression', 'ObjectProperty'].includes(path.parentPath.value.type);
+  }).filter(function (path) {
+    return !(0, _ast.isDecendantOfToken)(j, path);
+  }).forEach(function (path) {
+    debug && console.log('file:', file.path);
+    insertTokenImport(j, source);
+    var colorMeta = _legacyColors.legacyColorMetaMap[path.value.name] || [];
+    var tokenId = getTokenFromNode(j, path, colorMeta);
+    j(path).replaceWith(buildToken(j, tokenId, path.value));
+    transformed = true;
+  });
+  source.find(j.Literal).filter(function (path) {
+    return typeof path.value.value === 'string' && ((0, _color.includesHardCodedColor)(path.value.value) || (0, _color.isHardCodedColor)(path.value.value));
+  }).filter(function (path) {
+    return !(0, _ast.isDecendantOfToken)(j, path);
+  }).forEach(function (path) {
+    var _path$value, _path$value$value;
+
+    debug && console.log('file:', file.path);
+    insertTokenImport(j, source);
+    var value = path === null || path === void 0 ? void 0 : (_path$value = path.value) === null || _path$value === void 0 ? void 0 : (_path$value$value = _path$value.value) === null || _path$value$value === void 0 ? void 0 : _path$value$value.toString();
+    var colorMeta = _legacyColors.legacyColorMetaMap[value] || [];
+    var tokenId = getTokenFromNode(j, path, colorMeta);
+    var tokenNode = buildToken(j, tokenId, path.value);
+    j(path).replaceWith((0, _ast.isDecendantOfType)(j, path, j.JSXAttribute) ? j.jsxExpressionContainer(tokenNode) : tokenNode);
+    transformed = true;
+  });
+
+  if (transformed) {
+    return source.toSource();
+  }
+
+  return file.source;
+}

package/dist/cjs/presets/theme-to-design-tokens/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/cjs/presets/theme-to-design-tokens/utils/ast-meta.js

@@ -0,0 +1,88 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.cleanMeta = cleanMeta;
+exports.getMetaFromAncestors = getMetaFromAncestors;
+
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+
+var _tokens = require("./tokens");
+
+function getMetaFromAncestors(j, path) {
+  var meta = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : [];
+  var parent = path.parentPath;
+  var grandParent = parent && parent.parentPath;
+
+  if (parent && parent.value.type === 'ObjectProperty') {
+    var value = '';
+
+    if (parent.value.key.type === 'Literal' || parent.value.key.type === 'StringLiteral' || parent.value.key.type === 'NumericLiteral') {
+      value = parent.value.key.value.toString();
+    } else {
+      value = parent.value.key.name;
+    }
+
+    meta.push(value);
+  }
+
+  if (parent && grandParent && grandParent.value.type === 'TemplateLiteral') {
+    var expressionIndex = grandParent.value.expressions.findIndex(function (exp) {
+      return exp.name === path.value.name;
+    });
+    var quasi = grandParent.value.quasis[expressionIndex];
+    var propertyName = (quasi.value.cooked || quasi.value.raw || '').replace(/\n/g, '').split(/;|{|}/).filter(function (el) {
+      return !el.match(/\.|\@|\(|\)/);
+    }).pop().split(/:/g)[0].trim();
+    grandParent.value.quasis.slice(0, expressionIndex + 1).map(function (q) {
+      return q.value.cooked;
+    }) // We reverse so the most nested one is first which we're more likely than not interested in
+    .reverse().some(function (str) {
+      var result = /(hover|active|disabled|focus)/.exec(str.toLowerCase());
+
+      if (result) {
+        meta.push(result[0]);
+        return true;
+      }
+    });
+    meta.push(propertyName);
+  }
+
+  if (parent && parent.value.type === 'JSXAttribute') {
+    if (!['css', 'styles', 'style'].includes(parent.value.name.name)) {
+      meta.push(parent.value.name.name);
+    }
+  }
+
+  if (parent && parent.value.type === 'VariableDeclarator') {
+    meta.push(parent.value.id.name);
+  }
+
+  if (parent) {
+    return getMetaFromAncestors(j, parent, meta);
+  }
+
+  return meta;
+}
+
+function cleanMeta(meta) {
+  return meta.reduce(function (accum, val) {
+    return [].concat((0, _toConsumableArray2.default)(accum), (0, _toConsumableArray2.default)(typeof val === 'string' ? val.split(/(?=[A-Z])/g).map(function (e) {
+      return e.toLowerCase();
+    }) : []));
+  }, []).reduce(function (accum, val) {
+    accum.push(val.replace(/:/g, '').replace(/,/g, '').replace('grey', 'neutral').replace('skeleton', 'neutral').replace('texts', 'text').replace('red', 'danger').replace('error', 'danger').replace('invalid', 'danger').replace('removed', 'danger').replace('removal', 'danger').replace('remove', 'danger').replace('focus', 'focused').replace('valid', 'success').replace('successful', 'success').replace('risk', 'warning').replace('caution', 'warning').replace('warn', 'warning').replace('primary', 'bold').replace('info', 'bold').replace('secondary', 'subtle').replace('hyperlink', 'link').replace('anchor', 'link').replace('active', 'pressed').replace('hover', 'hovered').replace('dragged', 'overlay').replace('dragging', 'overlay').replace('drag', 'overlay').replace('background-color', 'background').replace('color', 'text').replace('icons', 'icon').replace('glyph', 'icon').replace('stroke', 'border').replace('border-left', 'border').replace('border-right', 'border').replace('border-top', 'border').replace('border-bottom', 'border').replace('box-shadow', 'shadow'));
+    return accum;
+  }, []).filter(function (val) {
+    return _tokens.getUniqueWordsFromTokens.includes(val);
+  }).reduce(function (accum, val) {
+    if (!accum.includes(val)) {
+      accum.push(val);
+    }
+
+    return accum;
+  }, []);
+}

package/dist/cjs/presets/theme-to-design-tokens/utils/ast.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isDecendantOfToken = isDecendantOfToken;
+exports.isDecendantOfType = isDecendantOfType;
+
+function isDecendantOfToken(j, path) {
+  return j(path).closest(j.CallExpression, {
+    callee: {
+      name: 'token'
+    }
+  }).length > 0;
+}
+
+function isDecendantOfType(j, path, type) {
+  return j(path).closest(type).length > 0;
+}

package/dist/cjs/presets/theme-to-design-tokens/utils/color.js

@@ -0,0 +1,59 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isLegacyNamedColor = exports.isLegacyColor = exports.isHardCodedColor = exports.includesHardCodedColor = void 0;
+
+var _legacyColors = require("./legacy-colors");
+
+var _namedColors = require("./named-colors");
+
+var isLegacyColor = function isLegacyColor(value) {
+  return _legacyColors.legacyColors.includes(value);
+};
+
+exports.isLegacyColor = isLegacyColor;
+
+var isLegacyNamedColor = function isLegacyNamedColor(value) {
+  return _legacyColors.legacyColorMixins.includes(value);
+};
+
+exports.isLegacyNamedColor = isLegacyNamedColor;
+
+var includesHardCodedColor = function includesHardCodedColor(raw) {
+  var value = raw.toLowerCase();
+
+  if (/#(?:[a-f0-9]{3}|[a-f0-9]{6}|[a-f0-9]{8})\b|(?:rgb|hsl)a?\([^\)]*\)/.exec(value.toLowerCase())) {
+    return true;
+  }
+
+  for (var i = 0; i < _namedColors.namedColors.length; i++) {
+    if (value.includes("".concat(_namedColors.namedColors[i], ";"))) {
+      return true;
+    }
+  }
+
+  return false;
+};
+
+exports.includesHardCodedColor = includesHardCodedColor;
+
+var isHardCodedColor = function isHardCodedColor(value) {
+  if (_namedColors.namedColors.includes(value.toLowerCase())) {
+    return true;
+  }
+
+  if (value.startsWith('rgb(') || value.startsWith('rgba(') || value.startsWith('hsl(') || value.startsWith('hsla(') || value.startsWith('lch(') || value.startsWith('lab(') || value.startsWith('color(')) {
+    return true;
+  }
+
+  if (value.startsWith('#') && ( // short hex, hex, or hex with alpha
+  value.length === 4 || value.length === 7 || value.length === 9)) {
+    return true;
+  }
+
+  return false;
+};
+
+exports.isHardCodedColor = isHardCodedColor;