Add CLI spinner

Author: lorisleiva

Diff for: index.ts

@@ -4,7 +4,13 @@ import * as fs from "node:fs";
 import * as path from "node:path";
 
 import { generateKeypair } from "./utils/generateKeypair";
-import { logBanner, logDone, logErrorAndExit, logStep } from "./utils/getLogs";
+import {
+  logBanner,
+  logDone,
+  logErrorAndExit,
+  logStep,
+  spinner,
+} from "./utils/getLogs";
 import { RenderContext, getRenderContext } from "./utils/getRenderContext";
 import { renderTemplate } from "./utils/renderTemplates";
 
@@ -17,18 +23,19 @@ import { renderTemplate } from "./utils/renderTemplates";
 
   // Generate a keypair if needed.
   if (!ctx.hasCustomProgramAddress) {
-    logStep(ctx.language.infos.generatingKeypair);
-    await generateKeypair(ctx);
+    await logStep(ctx.language.infos.generateKeypair, () =>
+      generateKeypair(ctx)
+    );
   }
 
   // Render the templates.
-  logStep(
-    ctx.language.infos.scaffolding.replace(
+  await logStep(
+    ctx.language.infos.scaffold.replace(
       "$targetDirectory",
       ctx.targetDirectoryName
-    )
+    ),
+    () => renderTemplates(ctx)
   );
-  renderTemplates(ctx);
 
   // Done.
   logDone(ctx);

Diff for: locales/en-US.json

@@ -60,8 +60,8 @@
     "multiselect": "[↑/↓]: Select / [space]: Toggle selection / [a]: Toggle all / [enter]: Submit answer"
   },
   "infos": {
-    "scaffolding": "Scaffolding project in $targetDirectory...",
-    "generatingKeypair": "Generating program keypair...",
+    "scaffold": "Scaffold project in $targetDirectory",
+    "generateKeypair": "Generate program keypair",
     "done": "Done. Now run:"
   }
 }

Diff for: locales/fr-FR.json

@@ -63,8 +63,8 @@
     "multiselect": "[↑/↓]: Sélectionner / [espace]: Basculer la sélection / [a]: Basculer tout / [entrée]: Valider"
   },
   "infos": {
-    "scaffolding": "Génération du projet dans $targetDirectory...",
-    "generatingKeypair": "Génération de la paire de clés du program...",
+    "scaffold": "Génére le projet dans $targetDirectory",
+    "generateKeypair": "Génére la paire de clés du program",
     "done": "Terminé. Exécutez maintenant\u00a0:"
   }
 }

Diff for: utils/generateKeypair.ts

@@ -1,4 +1,3 @@
-import { logErrorAndExit } from "./getLogs";
 import { RenderContext } from "./getRenderContext";
 import {
   spawnCommand,
@@ -10,7 +9,7 @@ import {
 export async function generateKeypair(ctx: RenderContext): Promise<string> {
   const hasSolanaKeygen = await hasCommand("solana-keygen");
   if (!hasSolanaKeygen) {
-    logErrorAndExit(ctx.language.errors.solanaKeygenNotFound);
+    throw new Error(ctx.language.errors.solanaKeygenNotFound);
   }
 
   // Run the solana-keygen command to generate a new keypair.

Diff for: utils/getLanguage.ts

@@ -42,8 +42,8 @@ export interface Language {
     multiselect: string;
   };
   infos: {
-    scaffolding: string;
-    generatingKeypair: string;
+    scaffold: string;
+    generateKeypair: string;
     done: string;
   };
 }

Diff for: utils/getLogs.ts

@@ -7,17 +7,29 @@ export function logBanner() {
   console.log(`\n${getBanner()}\n`);
 }
 
-export function logErrorAndExit(message: string) {
-  logError(message);
-  process.exit(1);
+export function logSuccess(message: string) {
+  console.log(chalk.green("✔︎") + ` ${message}`);
 }
 
 export function logError(message: string) {
   console.log(chalk.red("✖") + ` ${message}`);
 }
 
-export function logStep(message: string) {
-  console.log(chalk.blue("➤") + ` ${message}`);
+export function logErrorAndExit(message: string) {
+  logError(message);
+  process.exit(1);
+}
+
+export async function logStep<T>(title: string, callback: () => T): Promise<T> {
+  try {
+    const result = await spinner(`${title}...`, callback);
+    logSuccess(`${title}.`);
+    return result;
+  } catch (e) {
+    logError(`${title}.\n`);
+    console.log(e);
+    process.exit(1);
+  }
 }
 
 export function logDone(ctx: RenderContext) {
@@ -41,6 +53,30 @@ export function logDone(ctx: RenderContext) {
   console.log();
 }
 
+export async function spinner<T>(callback: () => T): Promise<T>;
+export async function spinner<T>(title: string, callback: () => T): Promise<T>;
+export async function spinner<T>(
+  title: string | (() => T),
+  callback?: () => T
+): Promise<T> {
+  if (typeof title == "function") {
+    callback = title;
+    title = "";
+  }
+  let i = 0;
+  const spin = () =>
+    process.stderr.write(`  ${"⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏"[i++ % 10]} ${title}\r`);
+  const id = setInterval(spin, 100);
+  let result: T;
+  try {
+    result = await callback!();
+  } finally {
+    clearInterval(id as NodeJS.Timeout);
+    process.stderr.write(" ".repeat(process.stdout.columns - 1) + "\r");
+  }
+  return result;
+}
+
 function getBanner() {
   const textBanner = "Create Solana Program";
   const gradientBanner = chalk.bold(