@storybook/codemod 6.4.0-beta.20 → 6.4.0-beta.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/codemod",
-  "version": "6.4.0-beta.20",
+  "version": "6.4.0-beta.24",
   "description": "A collection of codemod scripts written with JSCodeshift",
   "keywords": [
     "storybook"
@@ -44,8 +44,8 @@
     "@babel/types": "^7.12.11",
     "@mdx-js/mdx": "^1.6.22",
     "@storybook/csf": "0.0.2--canary.87bc651.0",
-    "@storybook/csf-tools": "6.4.0-beta.20",
-    "@storybook/node-logger": "6.4.0-beta.20",
+    "@storybook/csf-tools": "6.4.0-beta.24",
+    "@storybook/node-logger": "6.4.0-beta.24",
     "core-js": "^3.8.2",
     "cross-spawn": "^7.0.3",
     "globby": "^11.0.2",
@@ -62,6 +62,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1a9315fd39f7e4abcdf3eb839dc29aedce346e01",
+  "gitHead": "f53ba4d7210b5c4809d57c74d7a42314172aa63e",
   "sbmodern": "dist/modern/index.js"
 }

package/dist/cjs/index.js

@@ -1,142 +0,0 @@
-"use strict";
-
-require("core-js/modules/es.symbol.description.js");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.listCodemods = listCodemods;
-exports.runCodemod = runCodemod;
-Object.defineProperty(exports, "updateOrganisationName", {
-  enumerable: true,
-  get: function () {
-    return _updateOrganisationName.default;
-  }
-});
-Object.defineProperty(exports, "packageNames", {
-  enumerable: true,
-  get: function () {
-    return _updateOrganisationName.packageNames;
-  }
-});
-Object.defineProperty(exports, "updateAddonInfo", {
-  enumerable: true,
-  get: function () {
-    return _updateAddonInfo.default;
-  }
-});
-
-require("core-js/modules/es.promise.js");
-
-var _fs = _interopRequireDefault(require("fs"));
-
-var _path = _interopRequireDefault(require("path"));
-
-var _util = require("util");
-
-var _globby = _interopRequireDefault(require("globby"));
-
-var _crossSpawn = require("cross-spawn");
-
-var _utils = require("./lib/utils");
-
-var _updateOrganisationName = _interopRequireWildcard(require("./transforms/update-organisation-name"));
-
-var _updateAddonInfo = _interopRequireDefault(require("./transforms/update-addon-info"));
-
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
-
-function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
-
-function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
-
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
-
-function _iterableToArrayLimit(arr, i) { if (typeof Symbol === "undefined" || !(Symbol.iterator in Object(arr))) return; var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
-
-function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
-
-var TRANSFORM_DIR = `${__dirname}/transforms`;
-
-function listCodemods() {
-  return _fs.default.readdirSync(TRANSFORM_DIR).filter(function (fname) {
-    return fname.endsWith('.js');
-  }).map(function (fname) {
-    return fname.slice(0, -3);
-  });
-}
-
-var renameAsync = (0, _util.promisify)(_fs.default.rename);
-
-async function renameFile(file, from, to, {
-  logger: logger
-}) {
-  var newFile = file.replace(from, to);
-  logger.log(`Rename: ${file} ${newFile}`);
-  return renameAsync(file, newFile);
-}
-
-async function runCodemod(codemod, {
-  glob: glob,
-  logger: logger,
-  dryRun: dryRun,
-  rename: rename,
-  parser: parser
-}) {
-  var codemods = listCodemods();
-
-  if (!codemods.includes(codemod)) {
-    throw new Error(`Unknown codemod ${codemod}. Run --list for options.`);
-  }
-
-  var renameParts = null;
-
-  if (rename) {
-    renameParts = rename.split(':');
-
-    if (renameParts.length !== 2) {
-      throw new Error(`Codemod rename: expected format "from:to", got "${rename}"`);
-    }
-  } // jscodeshift/prettier know how to handle .ts/.tsx extensions,
-  // so if the user uses one of those globs, we can auto-infer
-
-
-  var inferredParser = parser;
-
-  if (!parser) {
-    var extension = _path.default.extname(glob).slice(1);
-
-    var knownParser = (0, _utils.jscodeshiftToPrettierParser)(extension);
-    if (knownParser !== 'babel') inferredParser = extension;
-  }
-
-  var files = await (0, _globby.default)([glob, '!**/node_modules', '!**/dist']);
-  logger.log(`=> Applying ${codemod}: ${files.length} files`);
-
-  if (!dryRun) {
-    var parserArgs = inferredParser ? ['--parser', inferredParser] : [];
-    (0, _crossSpawn.sync)('npx', ['jscodeshift', '-t', `${TRANSFORM_DIR}/${codemod}.js`, ...parserArgs, ...files], {
-      stdio: 'inherit'
-    });
-  }
-
-  if (renameParts) {
-    var _renameParts = renameParts,
-        _renameParts2 = _slicedToArray(_renameParts, 2),
-        from = _renameParts2[0],
-        to = _renameParts2[1];
-
-    logger.log(`=> Renaming ${rename}: ${files.length} files`);
-    await Promise.all(files.map(function (file) {
-      return renameFile(file, new RegExp(`${from}$`), to, {
-        logger: logger
-      });
-    }));
-  }
-}

package/dist/cjs/lib/utils.js

@@ -1,40 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.jscodeshiftToPrettierParser = jscodeshiftToPrettierParser;
-exports.sanitizeName = void 0;
-
-var _camelCase = _interopRequireDefault(require("lodash/camelCase"));
-
-var _upperFirst = _interopRequireDefault(require("lodash/upperFirst"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-var sanitizeName = function (name) {
-  var key = (0, _upperFirst.default)((0, _camelCase.default)(name)); // prepend _ if name starts with a digit
-
-  if (/^\d/.test(key)) {
-    key = `_${key}`;
-  } // prepend _ if name starts with a digit
-
-
-  if (/^\d/.test(key)) {
-    key = `_${key}`;
-  }
-
-  return key;
-};
-
-exports.sanitizeName = sanitizeName;
-
-function jscodeshiftToPrettierParser(parser) {
-  var parserMap = {
-    babylon: 'babel',
-    flow: 'flow',
-    ts: 'typescript',
-    tsx: 'typescript'
-  };
-  return parserMap[parser] || 'babel';
-}

package/dist/cjs/transforms/add-component-parameters.js

@@ -1,64 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = transformer;
-
-/**
- * Adds a `component` parameter for each storiesOf(...) call.
- *
- * For example:
- *
- * input { Button } from './Button';
- * storiesOf('Button', module).add('story', () => <Button label="The Button" />);
- *
- * Becomes:
- *
- * input { Button } from './Button';
- * storiesOf('Button', module)
- *   .addParameters({ component: Button })
- *   .add('story', () => <Button label="The Button" />);
- *
- * Heuristics:
- * - The storiesOf "kind" name must be Button
- * - Button must be imported in the file
- */
-function transformer(file, api) {
-  var j = api.jscodeshift;
-  var root = j(file.source); //  Create a dictionary whose keys are all the named imports in the file.
-  //  For instance:
-  //
-  //  import foo from 'foo';
-  //  import { bar, baz } from 'zoo';
-  //
-  //  => { foo: true, bar: true, baz: true }
-
-  var importMap = {};
-  root.find(j.ImportDeclaration).forEach(function (imp) {
-    return imp.node.specifiers.forEach(function (spec) {
-      importMap[spec.local.name] = true;
-    });
-  });
-
-  function getLeafName(string) {
-    var parts = string.split(/\/|\.|\|/);
-    return parts[parts.length - 1];
-  }
-
-  function addComponentParameter(call) {
-    var node = call.node;
-    var leafName = getLeafName(node.arguments[0].value);
-    return j.callExpression(j.memberExpression(node, j.identifier('addParameters')), [j.objectExpression([j.property('init', j.identifier('component'), j.identifier(leafName))])]);
-  }
-
-  var storiesOfCalls = root.find(j.CallExpression).filter(function (call) {
-    return call.node.callee.name === 'storiesOf';
-  }).filter(function (call) {
-    return call.node.arguments.length > 0 && call.node.arguments[0].type === 'Literal';
-  }).filter(function (call) {
-    var leafName = getLeafName(call.node.arguments[0].value);
-    return importMap[leafName];
-  }).replaceWith(addComponentParameter);
-  return root.toSource();
-}

package/dist/cjs/transforms/csf-2-to-3.js

@@ -1,169 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _prettier = _interopRequireDefault(require("prettier"));
-
-var t = _interopRequireWildcard(require("@babel/types"));
-
-var _csfTools = require("@storybook/csf-tools");
-
-var _utils = require("../lib/utils");
-
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
-
-function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-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 _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) { _defineProperty(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 _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-var logger = console;
-
-var _rename = function (annotation) {
-  return annotation === 'storyName' ? 'name' : annotation;
-};
-
-var getTemplateBindVariable = function (init) {
-  return t.isCallExpression(init) && t.isMemberExpression(init.callee) && t.isIdentifier(init.callee.object) && t.isIdentifier(init.callee.property) && init.callee.property.name === 'bind' && (init.arguments.length === 0 || init.arguments.length === 1 && t.isObjectExpression(init.arguments[0]) && init.arguments[0].properties.length === 0) ? init.callee.object.name : null;
-}; // export const A = ...
-// A.parameters = { ... }; <===
-
-
-var isStoryAnnotation = function (stmt, objectExports) {
-  return t.isExpressionStatement(stmt) && t.isAssignmentExpression(stmt.expression) && t.isMemberExpression(stmt.expression.left) && t.isIdentifier(stmt.expression.left.object) && objectExports[stmt.expression.left.object.name];
-};
-
-var isTemplateDeclaration = function (stmt, templates) {
-  return t.isVariableDeclaration(stmt) && stmt.declarations.length === 1 && t.isIdentifier(stmt.declarations[0].id) && templates[stmt.declarations[0].id.name];
-};
-
-var getNewExport = function (stmt, objectExports) {
-  if (t.isExportNamedDeclaration(stmt) && t.isVariableDeclaration(stmt.declaration) && stmt.declaration.declarations.length === 1) {
-    var decl = stmt.declaration.declarations[0];
-
-    if (t.isVariableDeclarator(decl) && t.isIdentifier(decl.id)) {
-      return objectExports[decl.id.name];
-    }
-  }
-
-  return null;
-}; // Remove render function when it matches the global render function in react
-// export default { component: Cat };
-// export const A = (args) => <Cat {...args} />;
-
-
-var isReactGlobalRenderFn = function (csf, storyFn) {
-  var _csf$_meta;
-
-  if ((_csf$_meta = csf._meta) !== null && _csf$_meta !== void 0 && _csf$_meta.component && t.isArrowFunctionExpression(storyFn) && storyFn.params.length === 1 && t.isJSXElement(storyFn.body)) {
-    var openingElement = storyFn.body.openingElement;
-
-    if (openingElement.selfClosing && t.isJSXIdentifier(openingElement.name) && openingElement.attributes.length === 1) {
-      var attr = openingElement.attributes[0];
-      var param = storyFn.params[0];
-
-      if (t.isJSXSpreadAttribute(attr) && t.isIdentifier(attr.argument) && t.isIdentifier(param) && param.name === attr.argument.name && csf._meta.component === openingElement.name.name) {
-        return true;
-      }
-    }
-  }
-
-  return false;
-}; // A simple CSF story is a no-arg story without any extra annotations (params, args, etc.)
-
-
-var isSimpleCSFStory = function (init, annotations) {
-  return annotations.length === 0 && t.isArrowFunctionExpression(init) && init.params.length === 0;
-};
-
-function transform({
-  source: source
-}, api, options) {
-  var csf = (0, _csfTools.loadCsf)(source, {
-    defaultTitle: 'FIXME'
-  });
-
-  try {
-    csf.parse();
-  } catch (err) {
-    logger.log(`Error ${err}, skipping`);
-    return source;
-  }
-
-  var objectExports = {};
-  Object.entries(csf._storyExports).forEach(function ([key, decl]) {
-    var annotations = Object.entries(csf._storyAnnotations[key]).map(function ([annotation, val]) {
-      return t.objectProperty(t.identifier(_rename(annotation)), val);
-    });
-    var init = decl.init,
-        id = decl.id; // only replace arrow function expressions && template
-    // ignore no-arg stories without annotations
-
-    var template = getTemplateBindVariable(init);
-
-    if (!t.isArrowFunctionExpression(init) && !template || isSimpleCSFStory(init, annotations)) {
-      return;
-    } // Remove the render function when we can hoist the template
-    // const Template = (args) => <Cat {...args} />;
-    // export const A = Template.bind({});
-
-
-    var storyFn = template && csf._templates[template];
-    if (!storyFn) storyFn = init;
-    var keyId = t.identifier(key); // @ts-ignore
-
-    var typeAnnotation = id.typeAnnotation;
-
-    if (typeAnnotation) {
-      keyId.typeAnnotation = typeAnnotation;
-    }
-
-    var renderAnnotation = isReactGlobalRenderFn(csf, storyFn) ? [] : [t.objectProperty(t.identifier('render'), storyFn)];
-    objectExports[key] = t.exportNamedDeclaration(t.variableDeclaration('const', [t.variableDeclarator(keyId, t.objectExpression([...renderAnnotation, ...annotations]))]));
-  });
-
-  var updatedBody = csf._ast.program.body.reduce(function (acc, stmt) {
-    // remove story annotations & template declarations
-    if (isStoryAnnotation(stmt, objectExports) || isTemplateDeclaration(stmt, csf._templates)) {
-      return acc;
-    } // replace story exports with new object exports
-
-
-    var newExport = getNewExport(stmt, objectExports);
-
-    if (newExport) {
-      acc.push(newExport);
-      return acc;
-    } // include unknown statements
-
-
-    acc.push(stmt);
-    return acc;
-  }, []);
-
-  csf._ast.program.body = updatedBody;
-  var output = (0, _csfTools.formatCsf)(csf);
-  var prettierConfig = _prettier.default.resolveConfig.sync('.', {
-    editorconfig: true
-  }) || {
-    printWidth: 100,
-    tabWidth: 2,
-    bracketSpacing: true,
-    trailingComma: 'es5',
-    singleQuote: true
-  };
-  return _prettier.default.format(output, _objectSpread(_objectSpread({}, prettierConfig), {}, {
-    parser: (0, _utils.jscodeshiftToPrettierParser)(options === null || options === void 0 ? void 0 : options.parser)
-  }));
-}
-
-var _default = transform;
-exports.default = _default;

package/dist/cjs/transforms/csf-hoist-story-annotations.js

@@ -1,93 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = transformer;
-
-var getContainingStatement = function (n) {
-  if (n.node.type.endsWith('Statement')) {
-    return n;
-  }
-
-  return getContainingStatement(n.parent);
-};
-/**
- * Hoist CSF .story annotations
- *
- * For example:
- *
- * ```
- * export const Basic = () => <Button />
- * Basic.story = {
- *   name: 'foo',
- *   parameters: { ... },
- *   decorators = [ ... ],
- * };
- * ```
- *
- * Becomes:
- *
- * ```
- * export const Basic = () => <Button />
- * Basic.storyName = 'foo';
- * Basic.parameters = { ... };
- * Basic.decorators = [ ... ];
- * ```
- */
-
-
-function transformer(file, api) {
-  var j = api.jscodeshift;
-  var root = j(file.source);
-
-  var renameKey = function (exp) {
-    return exp.type === 'Identifier' && exp.name === 'name' ? j.identifier('storyName') : exp;
-  }; // 1. If the program does not have `export default { title: '....' }, skip it
-
-
-  var defaultExportWithTitle = root.find(j.ExportDefaultDeclaration).filter(function (def) {
-    return def.node.declaration.type === 'ObjectExpression' && def.node.declaration.properties.map(function (p) {
-      return p.key.name;
-    }).includes('title');
-  });
-
-  if (defaultExportWithTitle.size() === 0) {
-    return root.toSource();
-  } // 2. Replace each Foo.story = { x: xVal } with Foo.x = xVal;
-
-
-  var storyAssignments = root.find(j.AssignmentExpression).filter(function (exp) {
-    var _exp$node = exp.node,
-        left = _exp$node.left,
-        right = _exp$node.right;
-    return left.type === 'MemberExpression' && left.object.type === 'Identifier' && left.property.type === 'Identifier' && left.property.name === 'story' && right.type === 'ObjectExpression';
-  });
-  storyAssignments.forEach(function (exp) {
-    var _exp$node2 = exp.node,
-        left = _exp$node2.left,
-        right = _exp$node2.right;
-    right.properties.forEach(function (prop) {
-      var stmt = getContainingStatement(exp);
-      stmt.insertBefore(j.assignmentStatement('=', j.memberExpression(left.object, renameKey(prop.key)), prop.value));
-    });
-  }); // 3. Remove the .story annotations
-
-  storyAssignments.remove(); // 4. Replace each Foo.story.x with Foo.x;
-
-  var storyOverrides = root.find(j.AssignmentExpression).filter(function (exp) {
-    var left = exp.node.left;
-    return left.type === 'MemberExpression' && left.object.type === 'MemberExpression' && left.object.property.type === 'Identifier' && left.object.property.name === 'story' && left.property.type === 'Identifier' // ?? ANNOTATION_FIELDS.includes(right.property.name)
-    ;
-  });
-  storyOverrides.replaceWith(function (exp) {
-    var _exp$node3 = exp.node,
-        left = _exp$node3.left,
-        right = _exp$node3.right;
-    return j.assignmentExpression('=', j.memberExpression(left.object.object, renameKey(left.property)), right);
-  }); // 4. Render the updated tree
-
-  return root.toSource({
-    quote: 'single'
-  });
-}