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

package/dist/transforms/migrate-env-var-dependencies.js

@@ -1,390 +1 @@
-"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/transforms/migrate-env-var-dependencies.ts
-var migrate_env_var_dependencies_exports = {};
-__export(migrate_env_var_dependencies_exports, {
-  default: () => migrate_env_var_dependencies_default,
-  hasLegacyEnvVarDependencies: () => hasLegacyEnvVarDependencies,
-  migrateConfig: () => migrateConfig,
-  migrateDependencies: () => migrateDependencies,
-  migrateGlobal: () => migrateGlobal,
-  migratePipeline: () => migratePipeline,
-  transformer: () => transformer
-});
-module.exports = __toCommonJS(migrate_env_var_dependencies_exports);
-var import_fs_extra2 = __toESM(require("fs-extra"));
-var import_path2 = __toESM(require("path"));
-
-// src/runner/Runner.ts
-var import_chalk3 = __toESM(require("chalk"));
-
-// src/runner/FileTransform.ts
-var import_chalk = __toESM(require("chalk"));
-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/migrate-env-var-dependencies.ts
-var TRANSFORMER = "migrate-env-var-dependencies";
-var DESCRIPTION = 'Migrate environment variable dependencies from "dependsOn" to "env" in `turbo.json`';
-var INTRODUCED_IN = "1.5.0";
-function hasLegacyEnvVarDependencies(config) {
-  const dependsOn = [
-    config.globalDependencies,
-    Object.values(config.pipeline).flatMap((pipeline) => {
-      var _a;
-      return (_a = pipeline.dependsOn) != null ? _a : [];
-    })
-  ].flat();
-  const envVars = dependsOn.filter((dep) => dep == null ? void 0 : dep.startsWith("$"));
-  return { hasKeys: !!envVars.length, envVars };
-}
-function migrateDependencies({
-  env,
-  deps
-}) {
-  const envDeps = new Set(env);
-  const otherDeps = [];
-  deps == null ? void 0 : deps.forEach((dep) => {
-    if (dep.startsWith("$")) {
-      envDeps.add(dep.slice(1));
-    } else {
-      otherDeps.push(dep);
-    }
-  });
-  if (envDeps.size) {
-    return {
-      deps: otherDeps,
-      env: Array.from(envDeps)
-    };
-  } else {
-    return { env, deps };
-  }
-}
-function migratePipeline(pipeline) {
-  const { deps: dependsOn, env } = migrateDependencies({
-    env: pipeline.env,
-    deps: pipeline.dependsOn
-  });
-  const migratedPipeline = { ...pipeline };
-  if (dependsOn) {
-    migratedPipeline.dependsOn = dependsOn;
-  } else {
-    delete migratedPipeline.dependsOn;
-  }
-  if (env && env.length) {
-    migratedPipeline.env = env;
-  } else {
-    delete migratedPipeline.env;
-  }
-  return migratedPipeline;
-}
-function migrateGlobal(config) {
-  const { deps: globalDependencies, env } = migrateDependencies({
-    env: config.globalEnv,
-    deps: config.globalDependencies
-  });
-  const migratedConfig = { ...config };
-  if (globalDependencies && globalDependencies.length) {
-    migratedConfig.globalDependencies = globalDependencies;
-  } else {
-    delete migratedConfig.globalDependencies;
-  }
-  if (env && env.length) {
-    migratedConfig.globalEnv = env;
-  } else {
-    delete migratedConfig.globalEnv;
-  }
-  return migratedConfig;
-}
-function migrateConfig(config) {
-  let migratedConfig = migrateGlobal(config);
-  Object.keys(config.pipeline).forEach((pipelineKey) => {
-    config.pipeline;
-    if (migratedConfig.pipeline && config.pipeline[pipelineKey]) {
-      const pipeline = migratedConfig.pipeline[pipelineKey];
-      migratedConfig.pipeline[pipelineKey] = {
-        ...pipeline,
-        ...migratePipeline(pipeline)
-      };
-    }
-  });
-  return migratedConfig;
-}
-function transformer({
-  root,
-  options
-}) {
-  const { log, runner } = getTransformerHelpers({
-    transformer: TRANSFORMER,
-    rootPath: root,
-    options
-  });
-  log.info(`Migrating environment variable dependencies from "globalDependencies" and "dependsOn" to "env" in "turbo.json"...`);
-  const turboConfigPath = import_path2.default.join(root, "turbo.json");
-  const packageJsonPath = import_path2.default.join(root, "package.json");
-  if (!import_fs_extra2.default.existsSync(turboConfigPath)) {
-    return runner.abortTransform({
-      reason: `No turbo.json found at ${root}. Is the path correct?`
-    });
-  }
-  let packageJSON = {};
-  try {
-    packageJSON = import_fs_extra2.default.readJSONSync(packageJsonPath);
-  } catch (e) {
-  }
-  if ("turbo" in packageJSON) {
-    return runner.abortTransform({
-      reason: '"turbo" key detected in package.json. Run `npx @turbo/codemod transform create-turbo-config` first'
-    });
-  }
-  let turboJson = import_fs_extra2.default.readJsonSync(turboConfigPath);
-  if (hasLegacyEnvVarDependencies(turboJson).hasKeys) {
-    turboJson = migrateConfig(turboJson);
-  }
-  runner.modifyFile({
-    filePath: turboConfigPath,
-    after: turboJson
-  });
-  return runner.finish();
-}
-var transformerMeta = {
-  name: `${TRANSFORMER}: ${DESCRIPTION}`,
-  value: TRANSFORMER,
-  introducedIn: INTRODUCED_IN,
-  transformer
-};
-var migrate_env_var_dependencies_default = transformerMeta;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  hasLegacyEnvVarDependencies,
-  migrateConfig,
-  migrateDependencies,
-  migrateGlobal,
-  migratePipeline,
-  transformer
-});
+"use strict";var N=Object.create;var p=Object.defineProperty;var C=Object.getOwnPropertyDescriptor;var I=Object.getOwnPropertyNames;var J=Object.getPrototypeOf,M=Object.prototype.hasOwnProperty;var L=(r,e)=>{for(var t in e)p(r,t,{get:e[t],enumerable:!0})},A=(r,e,t,o)=>{if(e&&typeof e=="object"||typeof e=="function")for(let n of I(e))!M.call(r,n)&&n!==t&&p(r,n,{get:()=>e[n],enumerable:!(o=C(e,n))||o.enumerable});return r};var f=(r,e,t)=>(t=r!=null?N(J(r)):{},A(e||!r||!r.__esModule?p(t,"default",{value:r,enumerable:!0}):t,r)),U=r=>A(p({},"__esModule",{value:!0}),r);var V={};L(V,{default:()=>G,hasLegacyEnvVarDependencies:()=>S,migrateConfig:()=>k,migrateDependencies:()=>F,migrateGlobal:()=>w,migratePipeline:()=>D,transformer:()=>x});module.exports=U(V);var b=f(require("fs-extra")),E=f(require("path"));var g=f(require("chalk"));var u=f(require("chalk")),y=require("diff"),c=f(require("fs-extra")),j=f(require("os")),v=f(require("path")),h=class{constructor(e){this.changes=[];if(this.filePath=e.filePath,this.rootPath=e.rootPath,this.after=e.after,this.error=e.error,e.before===void 0)try{v.default.extname(e.filePath)===".json"?this.before=c.default.readJsonSync(e.filePath):this.before=c.default.readFileSync(e.filePath)}catch{this.before=""}else e.before===null?this.before="":this.before=e.before;e.after?typeof this.before=="object"||typeof e.after=="object"?this.changes=(0,y.diffJson)(this.before,e.after):this.changes=(0,y.diffLines)(this.before,e.after):this.changes=[]}fileName(){return v.default.relative(this.rootPath,this.filePath)}write(){this.after&&(typeof this.after=="object"?c.default.writeJsonSync(this.filePath,this.after,{spaces:2}):c.default.writeFileSync(this.filePath,this.after))}additions(){return this.changes.filter(e=>e.added).length}deletions(){return this.changes.filter(e=>e.removed).length}hasChanges(){return this.additions()>0||this.deletions()>0}log(e){e.diff?(this.changes.forEach(t=>{t.added?process.stdout.write(u.default.green(t.value)):t.removed?process.stdout.write(u.default.red(t.value)):process.stdout.write(u.default.dim(t.value))}),console.log(j.default.EOL)):console.log(this.after)}};var i=f(require("chalk")),d=class{constructor(e){this.transform=e.transformer,this.dry=e.dry}modified(...e){console.log(i.default.green(" MODIFIED "),...e,this.dry?i.default.dim("(dry run)"):"")}unchanged(...e){console.log(i.default.gray(" UNCHANGED "),...e,this.dry?i.default.dim("(dry run)"):"")}skipped(...e){console.log(i.default.yellow(" SKIPPED "),...e,this.dry?i.default.dim("(dry run)"):"")}error(...e){console.log(i.default.red(" ERROR "),...e,this.dry?i.default.dim("(dry run)"):"")}info(...e){console.log(i.default.bold(" INFO "),...e,this.dry?i.default.dim("(dry run)"):"")}};var P=class{constructor(e){this.modifications={};this.transform=e.transformer,this.rootPath=e.rootPath,this.dry=e.dry,this.print=e.print,this.logger=new d(e)}abortTransform(e){return this.logger.error(e.reason),{fatalError:new Error(e.reason),changes:e.changes||{}}}modifyFile(e){this.modifications[e.filePath]=new h({rootPath:this.rootPath,...e})}finish(){let e={changes:{}};return Object.keys(this.modifications).forEach(o=>{let n=this.modifications[o],s={action:"unchanged",additions:n.additions(),deletions:n.deletions()};if(n.hasChanges()){if(this.dry)s.action="skipped",this.logger.skipped(g.default.dim(n.fileName()));else try{n.write(),s.action="modified",this.logger.modified(g.default.bold(n.fileName()))}catch(a){let l="Unknown error";a instanceof Error&&(l=a.message),s.error=new Error(l),s.action="error",this.logger.error(n.fileName(),l)}this.print&&n.log({diff:!0})}else this.logger.unchanged(g.default.dim(n.fileName()));e.changes[n.fileName()]=s}),Object.keys(e.changes).some(o=>e.changes[o].action==="error")?this.abortTransform({reason:"Encountered an error while transforming files",changes:e.changes}):e}static logResults(e){let t=Object.keys(e.changes);if(console.log(),t.length>0){console.log(g.default.bold("Results:"));let o={};t.forEach(n=>{var a;let s=e.changes[n];o[n]={action:s.action,additions:s.additions,deletions:s.deletions,error:((a=s.error)==null?void 0:a.message)||"None"}}),console.table(o),console.log()}}},R=P;function T({transformer:r,rootPath:e,options:t}){let o={transformer:r,rootPath:e,...t},n=new d(o),s=new R(o);return{log:n,runner:s}}var O="migrate-env-var-dependencies",$='Migrate environment variable dependencies from "dependsOn" to "env" in `turbo.json`',H="1.5.0";function S(r){let t=[r.globalDependencies,Object.values(r.pipeline).flatMap(o=>{var n;return(n=o.dependsOn)!=null?n:[]})].flat().filter(o=>o==null?void 0:o.startsWith("$"));return{hasKeys:!!t.length,envVars:t}}function F({env:r,deps:e}){let t=new Set(r),o=[];return e==null||e.forEach(n=>{n.startsWith("$")?t.add(n.slice(1)):o.push(n)}),t.size?{deps:o,env:Array.from(t)}:{env:r,deps:e}}function D(r){let{deps:e,env:t}=F({env:r.env,deps:r.dependsOn}),o={...r};return e?o.dependsOn=e:delete o.dependsOn,t&&t.length?o.env=t:delete o.env,o}function w(r){let{deps:e,env:t}=F({env:r.globalEnv,deps:r.globalDependencies}),o={...r};return e&&e.length?o.globalDependencies=e:delete o.globalDependencies,t&&t.length?o.globalEnv=t:delete o.globalEnv,o}function k(r){let e=w(r);return Object.keys(r.pipeline).forEach(t=>{if(r.pipeline,e.pipeline&&r.pipeline[t]){let o=e.pipeline[t];e.pipeline[t]={...o,...D(o)}}}),e}function x({root:r,options:e}){let{log:t,runner:o}=T({transformer:O,rootPath:r,options:e});t.info('Migrating environment variable dependencies from "globalDependencies" and "dependsOn" to "env" in "turbo.json"...');let n=E.default.join(r,"turbo.json"),s=E.default.join(r,"package.json");if(!b.default.existsSync(n))return o.abortTransform({reason:`No turbo.json found at ${r}. Is the path correct?`});let a={};try{a=b.default.readJSONSync(s)}catch{}if("turbo"in a)return o.abortTransform({reason:'"turbo" key detected in package.json. Run `npx @turbo/codemod transform create-turbo-config` first'});let l=b.default.readJsonSync(n);return S(l).hasKeys&&(l=k(l)),o.modifyFile({filePath:n,after:l}),o.finish()}var W={name:`${O}: ${$}`,value:O,introducedIn:H,transformer:x},G=W;0&&(module.exports={hasLegacyEnvVarDependencies,migrateConfig,migrateDependencies,migrateGlobal,migratePipeline,transformer});