fix(cli): init command target and installation progress (codemod-com#…

…1151)
NimishaDey · Jul 25, 2024 · 0d9d834 · 0d9d834
1 parent 042437a
commit 0d9d834
Show file tree

Hide file tree

Showing 6 changed files with 100 additions and 95 deletions.
diff --git a/apps/cli/src/commands/init.ts b/apps/cli/src/commands/init.ts
@@ -1,6 +1,12 @@
 import { randomBytes } from "node:crypto";
-import fs from "node:fs";
-import { mkdir, readFile, unlink, writeFile } from "node:fs/promises";
+import {
+  constants,
+  access,
+  mkdir,
+  readFile,
+  unlink,
+  writeFile,
+} from "node:fs/promises";
 import { basename, dirname, join } from "node:path";
 import inquirer from "inquirer";
 import terminalLink from "terminal-link";
@@ -17,6 +23,7 @@ import {
   parseCodemodConfig,
 } from "@codemod-com/utilities";
 import { getCurrentUserData } from "#auth-utils.js";
+import { isFile, oraCheckmark } from "#utils.js";
 
 const CODEMOD_ENGINE_CHOICES: (KnownEngines | "recipe")[] = [
   "jscodeshift",
@@ -30,27 +37,24 @@ const CODEMOD_ENGINE_CHOICES: (KnownEngines | "recipe")[] = [
 export const handleInitCliCommand = async (options: {
   printer: Printer;
   target: string;
-  noPrompt?: boolean;
+  source?: string;
   noLogs?: boolean;
-  writeDirectory?: string | null;
   useDefaultName?: boolean;
 }) => {
   const {
     printer,
+    target,
+    source,
     useDefaultName = false,
-    writeDirectory = null,
     noLogs = false,
-    target,
   } = options;
 
-  if (!fs.existsSync(target)) {
-    throw new Error(`Target path ${target} does not exist.`);
+  if (source) {
+    await access(source).catch(() => {
+      throw new Error(`Source path ${source} does not exist.`);
+    });
   }
 
-  const isTargetAFile = await fs.promises
-    .lstat(target)
-    .then((pathStat) => pathStat.isFile());
-
   const userData = await getCurrentUserData();
 
   const defaultInput = {
@@ -61,19 +65,23 @@ export const handleInitCliCommand = async (options: {
   } as const;
 
   let engineChoices: string[];
-  if (isJavaScriptName(basename(target))) {
+  if (!source) {
+    engineChoices = CODEMOD_ENGINE_CHOICES;
+  } else if (isJavaScriptName(basename(source))) {
     engineChoices = ["jscodeshift", "ts-morph", "filemod", "workflow"];
-  } else if (basename(target) === ".codemodrc.json") {
+  } else if (basename(source) === ".codemodrc.json") {
     engineChoices = ["recipe"];
   } else if (
-    basename(target).endsWith(".yaml") ||
-    basename(target).endsWith(".yml")
+    basename(source).endsWith(".yaml") ||
+    basename(source).endsWith(".yml")
   ) {
     engineChoices = ["ast-grep"];
   } else {
     engineChoices = CODEMOD_ENGINE_CHOICES;
   }
 
+  const isSourceAFile = source ? await isFile(source) : false;
+
   const userAnswers = await inquirer.prompt<{
     name: string;
     engine: KnownEngines;
@@ -88,7 +96,7 @@ export const handleInitCliCommand = async (options: {
     {
       type: "list",
       name: "engine",
-      message: `Select a codemod engine ${isTargetAFile ? "your codemod is built with" : "you want to build your codemod with"}:`,
+      message: `Select a codemod engine ${isSourceAFile ? "your codemod is built with" : "you want to build your codemod with"}:`,
       pageSize: engineChoices.length,
       choices: engineChoices,
     },
@@ -99,11 +107,11 @@ export const handleInitCliCommand = async (options: {
     ...userAnswers,
   };
 
-  if (isTargetAFile) {
+  if (source && isSourceAFile) {
     if (downloadInput.engine === "recipe") {
       try {
         downloadInput.codemodRcBody = parseCodemodConfig(
-          await readFile(target, "utf-8"),
+          await readFile(source, "utf-8"),
         );
       } catch (err) {
         throw new Error(
@@ -117,14 +125,14 @@ export const handleInitCliCommand = async (options: {
       }
     }
     // Can be read because we handle this error at the start
-    downloadInput.codemodBody = await readFile(target, "utf-8");
+    downloadInput.codemodBody = await readFile(source, "utf-8");
   }
 
   const files = getCodemodProjectFiles(downloadInput);
 
-  const codemodBaseDir = join(
-    writeDirectory ?? process.cwd(),
-    downloadInput.name,
+  const codemodBaseDir = join(target ?? process.cwd(), downloadInput.name);
+  await access(codemodBaseDir, constants.F_OK).catch(() =>
+    mkdir(codemodBaseDir, { recursive: true }),
   );
 
   const created: string[] = [];
@@ -133,10 +141,10 @@ export const handleInitCliCommand = async (options: {
 
     try {
       await mkdir(dirname(filePath), { recursive: true });
-      if (!fs.existsSync(filePath)) {
+      await access(filePath, constants.F_OK).catch(async () => {
         await writeFile(filePath, content);
         created.push(path);
-      }
+      });
     } catch (err) {
       for (const createdPath of created) {
         try {
@@ -166,20 +174,32 @@ export const handleInitCliCommand = async (options: {
     chalk.cyan("Codemod package created at", `${chalk.bold(codemodBaseDir)}.`),
   );
 
+  const installSpinner = printer.withLoaderMessage(
+    chalk.cyan("Installing npm dependencies..."),
+  );
+
   // Install packages
   try {
     await execPromise("pnpm i", { cwd: codemodBaseDir });
   } catch (err) {
     try {
       await execPromise("npm i", { cwd: codemodBaseDir });
     } catch (err) {
+      installSpinner.fail();
       printer.printConsoleMessage(
         "error",
         `Failed to install npm dependencies:\n${(err as Error).message}.`,
       );
     }
   }
 
+  if (installSpinner.isSpinning) {
+    installSpinner.stopAndPersist({
+      symbol: oraCheckmark,
+      text: chalk.green("Dependencies installed."),
+    });
+  }
+
   const howToRunText = chalk(
     `Run ${chalk.bold(doubleQuotify(`codemod --source ${codemodBaseDir}`))}`,
     "to run the codemod on current working directory",

diff --git a/apps/cli/src/commands/publish.ts b/apps/cli/src/commands/publish.ts
@@ -23,7 +23,7 @@ import { extractPrintableApiError, getCodemod, publish } from "#api.js";
 import { getCurrentUserOrLogin } from "#auth-utils.js";
 import { handleInitCliCommand } from "#commands/init.js";
 import type { TelemetryEvent } from "#telemetry.js";
-import { codemodDirectoryPath } from "#utils.js";
+import { codemodDirectoryPath, isFile } from "#utils.js";
 
 export const handlePublishCliCommand = async (options: {
   printer: Printer;
@@ -48,15 +48,11 @@ export const handlePublishCliCommand = async (options: {
     "**/.gitignore",
   ];
 
-  const isSourceAFile = await fs.promises
-    .lstat(source)
-    .then((pathStat) => pathStat.isFile());
-
-  if (isSourceAFile) {
+  if (await isFile(source)) {
     source = await handleInitCliCommand({
       printer,
-      target: source,
-      writeDirectory: join(codemodDirectoryPath, "temp"),
+      source,
+      target: join(codemodDirectoryPath, "temp"),
       noLogs: true,
     });
 

diff --git a/apps/cli/src/fetch-codemod.ts b/apps/cli/src/fetch-codemod.ts
@@ -142,8 +142,8 @@ export const fetchCodemod = async (options: {
       // Standalone codemod
       const codemodPackagePath = await handleInitCliCommand({
         printer,
-        target: nameOrPath,
-        writeDirectory: join(codemodDirectoryPath, "temp"),
+        source: nameOrPath,
+        target: join(codemodDirectoryPath, "temp"),
         useDefaultName: true,
         noLogs: true,
       });

diff --git a/apps/cli/src/main.ts b/apps/cli/src/main.ts
@@ -310,27 +310,20 @@ export const main = async () => {
       "init",
       "initialize a codemod package",
       (y) =>
-        y
-          .option("target", {
-            alias: "t",
-            type: "string",
-            description: "Path to init codemod in",
-            default: process.cwd(),
-          })
-          .option("no-prompt", {
-            alias: "y",
-            type: "boolean",
-            description: "skip all prompts and use default values",
-          }),
+        y.option("target", {
+          alias: "t",
+          type: "string",
+          description: "Path to init codemod in",
+          default: process.cwd(),
+        }),
       async (args) => {
         const { executeCliCommand, printer } =
           await initializeDependencies(args);
 
         return executeCliCommand(() =>
           handleInitCliCommand({
             printer,
-            noPrompt: args.noPrompt,
-            target: args.target,
+            target: args.target ?? process.cwd(),
           }),
         );
       },

diff --git a/apps/cli/src/utils.ts b/apps/cli/src/utils.ts
@@ -10,6 +10,12 @@ import { version } from "#/../package.json";
 
 export const codemodDirectoryPath = join(os.homedir(), ".codemod");
 
+export const isFile = async (path: string) =>
+  fs.promises
+    .lstat(path)
+    .then((pathStat) => pathStat.isFile())
+    .catch(() => false);
+
 export const unpackZipCodemod = async (options: {
   source: string;
   target: string;