@turbo/codemod 1.7.1-canary.1 → 1.7.1-canary.3

package/dist/transforms/set-default-outputs.js

@@ -23,87 +23,280 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/transforms/set-default-outputs.ts
 var set_default_outputs_exports = {};
 __export(set_default_outputs_exports, {
-  default: () => addDefaultOutputs
+  default: () => set_default_outputs_default,
+  transformer: () => transformer
 });
 module.exports = __toCommonJS(set_default_outputs_exports);
-var import_path = __toESM(require("path"));
-var import_fs_extra = __toESM(require("fs-extra"));
+var import_path2 = __toESM(require("path"));
+var import_fs_extra2 = __toESM(require("fs-extra"));
+
+// src/runner/Runner.ts
+var import_chalk3 = __toESM(require("chalk"));
 
-// src/logger.ts
+// src/runner/FileTransform.ts
 var import_chalk = __toESM(require("chalk"));
-function skip(...args) {
-  console.log(import_chalk.default.yellow.inverse(` SKIP `), ...args);
-}
-function error(...args) {
-  console.log(import_chalk.default.red.inverse(` ERROR `), ...args);
-}
-function ok(...args) {
-  console.log(import_chalk.default.green.inverse(` OK `), ...args);
+var import_diff = require("diff");
+var import_fs_extra = __toESM(require("fs-extra"));
+var import_os = __toESM(require("os"));
+var import_path = __toESM(require("path"));
+var FileTransform = class {
+  constructor(args) {
+    this.changes = [];
+    this.filePath = args.filePath;
+    this.rootPath = args.rootPath;
+    this.after = args.after;
+    this.error = args.error;
+    if (args.before === void 0) {
+      try {
+        if (import_path.default.extname(args.filePath) === ".json") {
+          this.before = import_fs_extra.default.readJsonSync(args.filePath);
+        } else {
+          this.before = import_fs_extra.default.readFileSync(args.filePath);
+        }
+      } catch (err) {
+        this.before = "";
+      }
+    } else if (args.before === null) {
+      this.before = "";
+    } else {
+      this.before = args.before;
+    }
+    if (args.after) {
+      if (typeof this.before === "object" || typeof args.after === "object") {
+        this.changes = (0, import_diff.diffJson)(this.before, args.after);
+      } else {
+        this.changes = (0, import_diff.diffLines)(this.before, args.after);
+      }
+    } else {
+      this.changes = [];
+    }
+  }
+  fileName() {
+    return import_path.default.relative(this.rootPath, this.filePath);
+  }
+  write() {
+    if (this.after) {
+      if (typeof this.after === "object") {
+        import_fs_extra.default.writeJsonSync(this.filePath, this.after, { spaces: 2 });
+      } else {
+        import_fs_extra.default.writeFileSync(this.filePath, this.after);
+      }
+    }
+  }
+  additions() {
+    return this.changes.filter((c) => c.added).length;
+  }
+  deletions() {
+    return this.changes.filter((c) => c.removed).length;
+  }
+  hasChanges() {
+    return this.additions() > 0 || this.deletions() > 0;
+  }
+  log(args) {
+    if (args.diff) {
+      this.changes.forEach((part) => {
+        if (part.added) {
+          process.stdout.write(import_chalk.default.green(part.value));
+        } else if (part.removed) {
+          process.stdout.write(import_chalk.default.red(part.value));
+        } else {
+          process.stdout.write(import_chalk.default.dim(part.value));
+        }
+      });
+      console.log(import_os.default.EOL);
+    } else {
+      console.log(this.after);
+    }
+  }
+};
+
+// src/utils/logger.ts
+var import_chalk2 = __toESM(require("chalk"));
+var Logger = class {
+  constructor(args) {
+    this.transform = args.transformer;
+    this.dry = args.dry;
+  }
+  modified(...args) {
+    console.log(import_chalk2.default.green(` MODIFIED `), ...args, this.dry ? import_chalk2.default.dim(`(dry run)`) : "");
+  }
+  unchanged(...args) {
+    console.log(import_chalk2.default.gray(` UNCHANGED `), ...args, this.dry ? import_chalk2.default.dim(`(dry run)`) : "");
+  }
+  skipped(...args) {
+    console.log(import_chalk2.default.yellow(` SKIPPED `), ...args, this.dry ? import_chalk2.default.dim(`(dry run)`) : "");
+  }
+  error(...args) {
+    console.log(import_chalk2.default.red(` ERROR `), ...args, this.dry ? import_chalk2.default.dim(`(dry run)`) : "");
+  }
+  info(...args) {
+    console.log(import_chalk2.default.bold(` INFO `), ...args, this.dry ? import_chalk2.default.dim(`(dry run)`) : "");
+  }
+};
+
+// src/runner/Runner.ts
+var Runner = class {
+  constructor(options) {
+    this.modifications = {};
+    this.transform = options.transformer;
+    this.rootPath = options.rootPath;
+    this.dry = options.dry;
+    this.print = options.print;
+    this.logger = new Logger(options);
+  }
+  abortTransform(args) {
+    this.logger.error(args.reason);
+    return {
+      fatalError: new Error(args.reason),
+      changes: args.changes || {}
+    };
+  }
+  modifyFile(args) {
+    this.modifications[args.filePath] = new FileTransform({
+      rootPath: this.rootPath,
+      ...args
+    });
+  }
+  finish() {
+    const results = { changes: {} };
+    Object.keys(this.modifications).forEach((filePath) => {
+      const mod = this.modifications[filePath];
+      const result = {
+        action: "unchanged",
+        additions: mod.additions(),
+        deletions: mod.deletions()
+      };
+      if (mod.hasChanges()) {
+        if (this.dry) {
+          result.action = "skipped";
+          this.logger.skipped(import_chalk3.default.dim(mod.fileName()));
+        } else {
+          try {
+            mod.write();
+            result.action = "modified";
+            this.logger.modified(import_chalk3.default.bold(mod.fileName()));
+          } catch (err) {
+            let message = "Unknown error";
+            if (err instanceof Error) {
+              message = err.message;
+            }
+            result.error = new Error(message);
+            result.action = "error";
+            this.logger.error(mod.fileName(), message);
+          }
+        }
+        if (this.print) {
+          mod.log({ diff: true });
+        }
+      } else {
+        this.logger.unchanged(import_chalk3.default.dim(mod.fileName()));
+      }
+      results.changes[mod.fileName()] = result;
+    });
+    const encounteredError = Object.keys(results.changes).some((fileName) => {
+      return results.changes[fileName].action === "error";
+    });
+    if (encounteredError) {
+      return this.abortTransform({
+        reason: "Encountered an error while transforming files",
+        changes: results.changes
+      });
+    }
+    return results;
+  }
+  static logResults(results) {
+    const changedFiles = Object.keys(results.changes);
+    console.log();
+    if (changedFiles.length > 0) {
+      console.log(import_chalk3.default.bold(`Results:`));
+      const table = {};
+      changedFiles.forEach((fileName) => {
+        var _a;
+        const fileChanges = results.changes[fileName];
+        table[fileName] = {
+          action: fileChanges.action,
+          additions: fileChanges.additions,
+          deletions: fileChanges.deletions,
+          error: ((_a = fileChanges.error) == null ? void 0 : _a.message) || "None"
+        };
+      });
+      console.table(table);
+      console.log();
+    }
+  }
+};
+var Runner_default = Runner;
+
+// src/utils/getTransformerHelpers.ts
+function getTransformerHelpers({
+  transformer: transformer2,
+  rootPath,
+  options
+}) {
+  const utilArgs = {
+    transformer: transformer2,
+    rootPath,
+    ...options
+  };
+  const log = new Logger(utilArgs);
+  const runner = new Runner_default(utilArgs);
+  return { log, runner };
 }
 
 // src/transforms/set-default-outputs.ts
-var import_chalk2 = __toESM(require("chalk"));
 var DEFAULT_OUTPUTS = ["dist/**", "build/**"];
-function addDefaultOutputs(files, flags) {
-  if (files.length !== 1) {
-    return;
-  }
-  const dir = files[0];
-  const root = import_path.default.resolve(process.cwd(), dir);
-  const packageJsonPath = import_path.default.join(root, "package.json");
+var TRANSFORMER = "set-default-outputs";
+var DESCRIPTION = 'Add the "outputs" key with defaults where it is missing in `turbo.json`';
+var INTRODUCED_IN = "1.7.0";
+function transformer({
+  root,
+  options
+}) {
+  const { log, runner } = getTransformerHelpers({
+    transformer: TRANSFORMER,
+    rootPath: root,
+    options
+  });
+  const packageJsonPath = import_path2.default.join(root, "package.json");
   let packageJSON = {};
   try {
-    packageJSON = import_fs_extra.default.readJSONSync(packageJsonPath);
+    packageJSON = import_fs_extra2.default.readJSONSync(packageJsonPath);
   } catch (e) {
   }
   if ("turbo" in packageJSON) {
-    throw new Error('"turbo" key detected in package.json. Run `npx @turbo/codemod create-turbo-config` first');
-  }
-  console.log(`Adding default \`outputs\` key into tasks if it doesn't exist`);
-  const turboConfigPath = import_path.default.join(root, "turbo.json");
-  if (!import_fs_extra.default.existsSync(turboConfigPath)) {
-    error(`No turbo.json found at ${root}. Is the path correct?`);
-    process.exit(1);
-  }
-  const rootTurboJson = import_fs_extra.default.readJsonSync(turboConfigPath);
-  let skippedCount = 0;
-  let modifiedCount = 0;
-  let unmodifiedCount = 0;
-  for (const [taskName, taskDef] of Object.entries(rootTurboJson.pipeline)) {
+    return runner.abortTransform({
+      reason: '"turbo" key detected in package.json. Run `npx @turbo/codemod transform create-turbo-config` first'
+    });
+  }
+  log.info(`Adding default \`outputs\` key into tasks if it doesn't exist`);
+  const turboConfigPath = import_path2.default.join(root, "turbo.json");
+  if (!import_fs_extra2.default.existsSync(turboConfigPath)) {
+    return runner.abortTransform({
+      reason: `No turbo.json found at ${root}. Is the path correct?`
+    });
+  }
+  const turboJson = import_fs_extra2.default.readJsonSync(turboConfigPath);
+  for (const [_, taskDef] of Object.entries(turboJson.pipeline)) {
     if (!taskDef.outputs) {
-      ok(`Updating outputs for ${taskName}`);
-      if (flags.dry) {
-        skippedCount++;
-      } else {
-        taskDef.outputs = DEFAULT_OUTPUTS;
-        modifiedCount++;
-      }
+      taskDef.outputs = DEFAULT_OUTPUTS;
     } else if (Array.isArray(taskDef.outputs) && taskDef.outputs.length === 0) {
-      ok(`Removing outputs: [] from ${taskName} as that is now the default behavior`);
-      if (flags.dry) {
-        skippedCount++;
-      } else {
-        delete taskDef.outputs;
-        modifiedCount++;
-      }
-    } else {
-      unmodifiedCount++;
-      skip(`Skipping "${taskName}", it already has an outputs key defined`);
+      delete taskDef.outputs;
     }
   }
-  if (flags.dry) {
-    console.log(JSON.stringify(rootTurboJson, null, 2));
-  } else {
-    import_fs_extra.default.writeJsonSync(turboConfigPath, rootTurboJson, {
-      spaces: 2
-    });
-  }
-  console.log("All done.");
-  console.log("Results:");
-  console.log(import_chalk2.default.red(`0 errors`));
-  console.log(import_chalk2.default.yellow(`${skippedCount} skipped`));
-  console.log(import_chalk2.default.yellow(`${unmodifiedCount} unmodified`));
-  console.log(import_chalk2.default.green(`${modifiedCount} modified`));
+  runner.modifyFile({
+    filePath: turboConfigPath,
+    after: turboJson
+  });
+  return runner.finish();
 }
+var transformerMeta = {
+  name: `${TRANSFORMER}: ${DESCRIPTION}`,
+  value: TRANSFORMER,
+  introducedIn: INTRODUCED_IN,
+  transformer
+};
+var set_default_outputs_default = transformerMeta;
 // Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {});
+0 && (module.exports = {
+  transformer
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turbo/codemod",
-  "version": "1.7.1-canary.1",
+  "version": "1.7.1-canary.3",
   "description": "Provides Codemod transformations to help upgrade your Turborepo codebase when a feature is deprecated.",
   "homepage": "https://turbo.build/repo",
   "license": "MPL-2.0",
@@ -12,51 +12,56 @@
   "bugs": {
     "url": "https://github.com/vercel/turbo/issues"
   },
-  "bin": "dist/index.js",
-  "scripts": {
-    "build": "tsup",
-    "test": "jest",
-    "lint": "eslint src/**/*.ts",
-    "check-types": "tsc --noEmit"
-  },
+  "bin": "dist/cli.js",
   "dependencies": {
+    "axios": "0.27.2",
     "chalk": "2.4.2",
-    "execa": "5.1.1",
+    "commander": "^9.5.0",
+    "diff": "^5.1.0",
     "find-up": "4.1.0",
     "fs-extra": "^10.0.0",
-    "globby": "11.1.0",
     "gradient-string": "^2.0.0",
-    "inquirer": "^8.0.0",
+    "inquirer": "^8.2.4",
+    "inquirer-file-tree-selection-prompt": "^1.0.19",
     "is-git-clean": "^1.1.0",
-    "meow": "^7.1.1",
     "ora": "4.1.1",
-    "rimraf": "^3.0.2",
-    "semver": "^7.3.5",
+    "semver": "^7.3.7",
+    "turbo-utils": "0.0.0",
     "update-check": "^1.5.4"
   },
   "devDependencies": {
     "@types/chalk-animation": "^1.6.0",
+    "@types/diff": "^5.0.2",
     "@types/fs-extra": "^9.0.13",
     "@types/gradient-string": "^1.1.2",
-    "@types/inquirer": "^7.3.1",
+    "@types/inquirer": "^8.2.0",
     "@types/jest": "^27.4.0",
     "@types/node": "^16.11.12",
     "@types/semver": "^7.3.9",
+    "@types/uuid": "^9.0.0",
     "deepmerge": "^4.2.2",
     "eslint": "^7.23.0",
     "jest": "^27.4.3",
+    "plop": "^3.1.1",
     "semver": "^7.3.5",
-    "strip-ansi": "^6.0.1",
     "ts-jest": "^27.1.1",
-    "tsconfig": "workspace:*",
+    "tsconfig": "0.0.0",
     "tsup": "^5.10.3",
-    "turbo-types": "workspace:*",
-    "typescript": "^4.5.5"
+    "turbo-types": "0.0.0",
+    "typescript": "^4.5.5",
+    "uuid": "^9.0.0"
   },
   "files": [
     "dist"
   ],
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "jest",
+    "lint": "eslint src/**/*.ts",
+    "check-types": "tsc --noEmit",
+    "add-transformer": "plop"
   }
-}
+}

package/dist/getPackageManagerVersion.js

@@ -1,42 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/getPackageManagerVersion.ts
-var getPackageManagerVersion_exports = {};
-__export(getPackageManagerVersion_exports, {
-  getPackageManagerVersion: () => getPackageManagerVersion
-});
-module.exports = __toCommonJS(getPackageManagerVersion_exports);
-var import_child_process = require("child_process");
-var getPackageManagerVersion = (ws) => {
-  switch (ws) {
-    case "yarn":
-      return (0, import_child_process.execSync)("yarn --version").toString().trim();
-    case "pnpm":
-      return (0, import_child_process.execSync)("pnpm --version").toString().trim();
-    case "npm":
-      return (0, import_child_process.execSync)("npm --version").toString().trim();
-    default:
-      throw new Error(`${ws} is not supported`);
-  }
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  getPackageManagerVersion
-});

package/dist/getWorkspaceImplementation.js

@@ -1,73 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/getWorkspaceImplementation.ts
-var getWorkspaceImplementation_exports = {};
-__export(getWorkspaceImplementation_exports, {
-  getWorkspaceImplementation: () => getWorkspaceImplementation,
-  getWorkspaceImplementationAndLockFile: () => getWorkspaceImplementationAndLockFile
-});
-module.exports = __toCommonJS(getWorkspaceImplementation_exports);
-var import_find_up = __toESM(require("find-up"));
-var import_path = __toESM(require("path"));
-var cache = {};
-function getWorkspaceImplementationAndLockFile(cwd) {
-  if (cache[cwd]) {
-    return cache[cwd];
-  }
-  const lockFile = import_find_up.default.sync(["yarn.lock", "pnpm-workspace.yaml", "package-lock.json"], {
-    cwd
-  });
-  if (!lockFile) {
-    return;
-  }
-  switch (import_path.default.basename(lockFile)) {
-    case "yarn.lock":
-      cache[cwd] = {
-        implementation: "yarn",
-        lockFile
-      };
-      break;
-    case "pnpm-workspace.yaml":
-      cache[cwd] = {
-        implementation: "pnpm",
-        lockFile
-      };
-      break;
-    case "package-lock.json":
-      cache[cwd] = {
-        implementation: "npm",
-        lockFile
-      };
-      break;
-  }
-  return cache[cwd];
-}
-function getWorkspaceImplementation(cwd) {
-  var _a;
-  return (_a = getWorkspaceImplementationAndLockFile(cwd)) == null ? void 0 : _a.implementation;
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  getWorkspaceImplementation,
-  getWorkspaceImplementationAndLockFile
-});

package/dist/git.js

@@ -1,56 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/git.ts
-var git_exports = {};
-__export(git_exports, {
-  checkGitStatus: () => checkGitStatus
-});
-module.exports = __toCommonJS(git_exports);
-var import_chalk = __toESM(require("chalk"));
-var import_is_git_clean = __toESM(require("is-git-clean"));
-function checkGitStatus(force) {
-  let clean = false;
-  let errorMessage = "Unable to determine if git directory is clean";
-  try {
-    clean = import_is_git_clean.default.sync(process.cwd());
-    errorMessage = "Git directory is not clean";
-  } catch (err) {
-    if (err && err.stderr && err.stderr.indexOf("not a git repository") >= 0) {
-      clean = true;
-    }
-  }
-  if (!clean) {
-    if (force) {
-      console.log(`WARNING: ${errorMessage}. Forcibly continuing...`);
-    } else {
-      console.log("Thank you for using @turbo/codemod!");
-      console.log(import_chalk.default.yellow("\nBut before we continue, please stash or commit your git changes."));
-      console.log("\nYou may use the --force flag to override this safety check.");
-      process.exit(1);
-    }
-  }
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  checkGitStatus
-});