@atlaskit/codemod-cli 0.13.3 → 0.13.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/codemod-cli
 
+## 0.13.4
+
+### Patch Changes
+
+- [`9c4335f135d`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9c4335f135d) - Updated README.md
+
 ## 0.13.3
 
 ### Patch Changes

package/README.md

@@ -1,6 +1,114 @@
-# Codemod CLI
+# Codemods
 
-Detailed docs and example usage can be found [here](../../../repo-docs/content/cloud/framework/atlassian-frontend/codemods/atlassian-codemods.md)
+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.
+
+**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.
+
+---
+
+## Usage
+
+`$ npx @atlaskit/codemod-cli /project/src/file.js`
+
+## Options
+
+### --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.
+
+**example:**
+
+- `npx @atlaskit/codemod-cli -n theme-to-design-tokens --extensions tsx,ts,js --parser tsx /project/src`
+
+### --transform, -t
+
+The transform to run, transforms can be either a single file or directory with an index.
+
+**example:**
+
+- `npx @atlaskit/codemod-cli --transform codemods/my-special-mod /project/src/file.js`
+- `npx @atlaskit/codemod-cli --transform codemods/my-special-mod/index.ts /project/src/file.js`
+
+### --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.
+
+**example:**
+
+- `npx @atlaskit/codemod-cli --since-ref HEAD /project/src`
+- `npx @atlaskit/codemod-cli --since-ref abcdef123 /project/src`
+
+### --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
+
+**example:**
+
+- `npx @atlaskit/codemod-cli --packages @atlaskit/button /project/src`
+- `npx @atlaskit/codemod-cli --packages @atlaskit/button@3.0.0,@atlaskit/range@4.0.0 /project/src`
+
+### --parser, -p
+
+Parser to use for parsing the source files you are code modding.
+
+**options:**
+
+- babel (default)
+- babylon
+- flow
+- ts
+- tsx
+
+**example:**
+
+- `npx @atlaskit/codemod-cli --parser tsx /project/src/file.js`
+- `npx @atlaskit/codemod-cli -p babel /project/src/file.js`
+
+### --extensions, -e
+
+Transform files with these file extensions (comma separated list) (default: js)
+
+**example:**
+
+- `npx @atlaskit/codemod-cli --extensions ts,tsx /project/src/file.js`
+- `npx @atlaskit/codemod-cli -e js /project/src/file.js`
+
+### --ignore-pattern
+
+Ignore files that match a provided glob expression
+
+**example:**
+
+- `@atlaskit/codemod-cli --ignore-pattern node_modules /project/src/file.js`
+
+### --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.
+
+**example:**
+
+- `npx @atlaskit/codemod-cli --no-filter-paths ./packages`
+
+### --version, -v
+
+Get current version number
+
+**example:**
+
+- `@atlaskit/codemod-cli --version`
+- `@atlaskit/codemod-cli -v`
+
+### --help
+
+Print all help text to the command line
+
+**example:**
+
+- `@atlaskit/codemod-cli --help`
+
+---
 
 ## Testing locally
 
@@ -10,4 +118,10 @@ When wanting to run the CLI before it has been published you can run the start c
 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/atlassian-codemods.md).
+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)._

package/dist/cjs/cli.js

@@ -5,84 +5,79 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.run = run;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _meow = _interopRequireDefault(require("meow"));
 var _types = require("./types");
 var _main = _interopRequireDefault(require("./main"));
 var _chalk = _interopRequireDefault(require("chalk"));
-async function run() {
-  const cli = (0, _meow.default)(`
-Usage
-  $ npx @atlaskit/codemod-cli [options] <file-paths>...
-
-Options
-  --preset, -n select transform by preset name, avoid user interaction
-  --transform, -t the transform to run, will prompt for a transform if not provided and no module is passed
-  --since-ref, runs transforms for all packages that have been upgraded since the specified git ref
-  --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
-  --parser, -p babel|babylon|flow|ts|tsx parser to use for parsing the source files (default: babel)
-  --extensions, -e transform files with these file extensions (comma separated list) (default: js)
-  --ignore-pattern, ignore files that match a provided glob expression
-  --fail-on-error, return a 1 exit code when errors were found during execution of codemods
-  --version, -v version number
-  --no-filter-paths disables dependant package file path filtering logic   
-  --help Help me 😱
-
-Examples
-  # Run a codemod over the /project/src directory, will be prompted for which codemod to run
-  $ npx @atlaskit/codemod-cli /project/src
-
-  # Run the "4.0.0-remove-appearance-prop" transform of the "button" package
-  $ npx @atlaskit/codemod-cli -t button@4.0.0-remove-appearance-prop /project/src
-
-  # Run all transforms for "@atlaskit/button" greater than version 3.0.0 and @atlaskit/range greater than 4.0.0
-  $ npx @atlaskit/codemod-cli --packages @atlaskit/button@3.0.0,@atlaskit/range@4.0.0 /project/src
-`, {
-    flags: {
-      transform: {
-        type: 'string',
-        alias: 't'
-      },
-      preset: {
-        type: 'string',
-        alias: 'n'
-      },
-      packages: {
-        type: 'string'
-      },
-      parser: {
-        type: 'string',
-        alias: 'p'
-      },
-      extensions: {
-        type: 'string',
-        alias: 'e'
-      },
-      ignorePattern: {
-        type: 'string'
-      },
-      sinceRef: {
-        type: 'string'
-      },
-      failOnError: {
-        type: 'boolean'
-      },
-      filterPaths: {
-        type: 'boolean',
-        default: true
+function run() {
+  return _run.apply(this, arguments);
+}
+function _run() {
+  _run = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+    var cli;
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          cli = (0, _meow.default)("\nUsage\n  $ npx @atlaskit/codemod-cli [options] <file-paths>...\n\nOptions\n  --preset, -n select transform by preset name, avoid user interaction\n  --transform, -t the transform to run, will prompt for a transform if not provided and no module is passed\n  --since-ref, runs transforms for all packages that have been upgraded since the specified git ref\n  --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\n  --parser, -p babel|babylon|flow|ts|tsx parser to use for parsing the source files (default: babel)\n  --extensions, -e transform files with these file extensions (comma separated list) (default: js)\n  --ignore-pattern, ignore files that match a provided glob expression\n  --fail-on-error, return a 1 exit code when errors were found during execution of codemods\n  --version, -v version number\n  --no-filter-paths disables dependant package file path filtering logic   \n  --help Help me \uD83D\uDE31\n\nExamples\n  # Run a codemod over the /project/src directory, will be prompted for which codemod to run\n  $ npx @atlaskit/codemod-cli /project/src\n\n  # Run the \"4.0.0-remove-appearance-prop\" transform of the \"button\" package\n  $ npx @atlaskit/codemod-cli -t button@4.0.0-remove-appearance-prop /project/src\n\n  # Run all transforms for \"@atlaskit/button\" greater than version 3.0.0 and @atlaskit/range greater than 4.0.0\n  $ npx @atlaskit/codemod-cli --packages @atlaskit/button@3.0.0,@atlaskit/range@4.0.0 /project/src\n", {
+            flags: {
+              transform: {
+                type: 'string',
+                alias: 't'
+              },
+              preset: {
+                type: 'string',
+                alias: 'n'
+              },
+              packages: {
+                type: 'string'
+              },
+              parser: {
+                type: 'string',
+                alias: 'p'
+              },
+              extensions: {
+                type: 'string',
+                alias: 'e'
+              },
+              ignorePattern: {
+                type: 'string'
+              },
+              sinceRef: {
+                type: 'string'
+              },
+              failOnError: {
+                type: 'boolean'
+              },
+              filterPaths: {
+                type: 'boolean',
+                default: true
+              }
+            }
+          });
+          (0, _main.default)(cli.input, cli.flags).catch(function (e) {
+            if (e instanceof _types.ValidationError) {
+              // eslint-disable-next-line no-console
+              console.error(cli.help);
+              // eslint-disable-next-line no-console
+              console.error(_chalk.default.red(e.message));
+              process.exit(1);
+            } else if (e instanceof _types.NoTransformsExistError) {
+              // eslint-disable-next-line no-console
+              console.warn(_chalk.default.yellow(e.message));
+              process.exit(0);
+            } else {
+              // eslint-disable-next-line no-console
+              console.error(_chalk.default.red(e));
+              process.exit(3);
+            }
+          });
+        case 2:
+        case "end":
+          return _context.stop();
       }
-    }
-  });
-  (0, _main.default)(cli.input, cli.flags).catch(e => {
-    if (e instanceof _types.ValidationError) {
-      console.error(cli.help);
-      console.error(_chalk.default.red(e.message));
-      process.exit(1);
-    } else if (e instanceof _types.NoTransformsExistError) {
-      console.warn(_chalk.default.yellow(e.message));
-      process.exit(0);
-    } else {
-      console.error(_chalk.default.red(e));
-      process.exit(3);
-    }
-  });
+    }, _callee);
+  }));
+  return _run.apply(this, arguments);
 }

package/dist/cjs/filepath.js

@@ -1,40 +1,76 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.findDependentPackagePaths = findDependentPackagePaths;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _glob = require("glob");
 var _fs = require("fs");
-const {
-  readFile
-} = _fs.promises;
+var readFile = _fs.promises.readFile;
 
 /** Return products packages filePaths for running codemods from specified dependent package */
-async function findDependentPackagePaths(crawlPaths, dependencyPackage) {
-  // Get file paths leading to package.jsons
-  const searchStrings = crawlPaths.map(crawlPath => {
-    //Replace leading './' due to bug with node-glob not properly ignoring files https://github.com/isaacs/node-glob/issues/309
-    return `${crawlPath.replace(/^\.\//, '')}/**/package.json`;
-  });
-
-  // Convert array into glob string
-  const globString = searchStrings.length > 1 ? `{${searchStrings.join(',')}}` : searchStrings[0];
-  const packageJsonPaths = _glob.glob.sync(globString, {
-    ignore: '**/node_modules/**',
-    nodir: true
-  });
-  let productPackageJsonPathPromises = packageJsonPaths.map(async filePath => {
-    const fileContents = readFile(filePath, 'utf8');
-    // Grep for installedPackage
-    const isMatch = (await fileContents).toString().split(/\n/).some(function (line) {
-      return line.match(dependencyPackage);
-    });
-    return isMatch && filePath;
-  });
-  const productPackageJsonPaths = (await Promise.all(productPackageJsonPathPromises)).filter(path => path !== false);
-
-  // Get directory
-  const productPackagePaths = productPackageJsonPaths.map(line => line.replace('/package.json', ''));
-  return productPackagePaths;
+function findDependentPackagePaths(_x, _x2) {
+  return _findDependentPackagePaths.apply(this, arguments);
+}
+function _findDependentPackagePaths() {
+  _findDependentPackagePaths = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(crawlPaths, dependencyPackage) {
+    var searchStrings, globString, packageJsonPaths, productPackageJsonPathPromises, productPackageJsonPaths, productPackagePaths;
+    return _regenerator.default.wrap(function _callee2$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          // Get file paths leading to package.jsons
+          searchStrings = crawlPaths.map(function (crawlPath) {
+            //Replace leading './' due to bug with node-glob not properly ignoring files https://github.com/isaacs/node-glob/issues/309
+            return "".concat(crawlPath.replace(/^\.\//, ''), "/**/package.json");
+          }); // Convert array into glob string
+          globString = searchStrings.length > 1 ? "{".concat(searchStrings.join(','), "}") : searchStrings[0];
+          packageJsonPaths = _glob.glob.sync(globString, {
+            ignore: '**/node_modules/**',
+            nodir: true
+          });
+          productPackageJsonPathPromises = packageJsonPaths.map( /*#__PURE__*/function () {
+            var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(filePath) {
+              var fileContents, isMatch;
+              return _regenerator.default.wrap(function _callee$(_context) {
+                while (1) switch (_context.prev = _context.next) {
+                  case 0:
+                    fileContents = readFile(filePath, 'utf8'); // Grep for installedPackage
+                    _context.next = 3;
+                    return fileContents;
+                  case 3:
+                    isMatch = _context.sent.toString().split(/\n/).some(function (line) {
+                      return line.match(dependencyPackage);
+                    });
+                    return _context.abrupt("return", isMatch && filePath);
+                  case 5:
+                  case "end":
+                    return _context.stop();
+                }
+              }, _callee);
+            }));
+            return function (_x3) {
+              return _ref.apply(this, arguments);
+            };
+          }());
+          _context2.next = 6;
+          return Promise.all(productPackageJsonPathPromises);
+        case 6:
+          productPackageJsonPaths = _context2.sent.filter(function (path) {
+            return path !== false;
+          });
+          // Get directory
+          productPackagePaths = productPackageJsonPaths.map(function (line) {
+            return line.replace('/package.json', '');
+          });
+          return _context2.abrupt("return", productPackagePaths);
+        case 9:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2);
+  }));
+  return _findDependentPackagePaths.apply(this, arguments);
 }

package/dist/cjs/index.js

@@ -6,19 +6,19 @@ Object.defineProperty(exports, "__esModule", {
 });
 Object.defineProperty(exports, "NoTransformsExistError", {
   enumerable: true,
-  get: function () {
+  get: function get() {
     return _types.NoTransformsExistError;
   }
 });
 Object.defineProperty(exports, "ValidationError", {
   enumerable: true,
-  get: function () {
+  get: function get() {
     return _types.ValidationError;
   }
 });
 Object.defineProperty(exports, "default", {
   enumerable: true,
-  get: function () {
+  get: function get() {
     return _main.default;
   }
 });