grimoire-wizard 0.5.0 → 0.5.2

package/dist/index.d.ts

@@ -58,6 +58,7 @@ interface SelectOption {
     label: string;
     hint?: string;
     disabled?: boolean | string;
+    checked?: boolean;
 }
 interface SeparatorOption {
     separator: string;
@@ -189,6 +190,7 @@ interface WizardConfig {
         version?: string;
         description?: string;
         review?: boolean;
+        icon?: string;
     };
     theme?: ThemeConfig;
     steps: StepConfig[];
@@ -440,6 +442,7 @@ interface RunWizardOptions {
     mru?: boolean;
     resume?: boolean;
     configFilePath?: string;
+    optionsProvider?: (stepId: string, answers: Record<string, unknown>) => Promise<SelectOption[] | undefined>;
 }
 declare function runPreFlightChecks(checks: PreFlightCheck[], theme: ResolvedTheme, renderer?: WizardRenderer): void;
 declare function runWizard(config: WizardConfig, options?: RunWizardOptions): Promise<Record<string, unknown>>;
@@ -482,6 +485,7 @@ declare function resolveTemplateStrict(template: string, answers: Record<string,
  */
 declare function renderBanner(name: string, theme: ResolvedTheme, options?: {
     plain?: boolean;
+    icon?: string;
 }): string;
 
 declare function slugify(name: string): string;

package/dist/index.js

@@ -242,7 +242,8 @@ var init_schema = __esm({
         name: z.string(),
         version: z.string().optional(),
         description: z.string().optional(),
-        review: z.boolean().optional()
+        review: z.boolean().optional(),
+        icon: z.string().optional()
       }),
       theme: themeConfigSchema.optional(),
       steps: z.array(stepConfigSchema).min(1),
@@ -1188,18 +1189,26 @@ import figlet from "figlet";
 import gradient from "gradient-string";
 var GRIMOIRE_GRADIENT = gradient(["#C084FC", "#5B9BD5", "#6BCB77"]);
 function renderBanner(name, theme, options) {
+  const icon = options?.icon;
+  const prefix = icon ? `${icon}  ` : "";
   if (options?.plain) {
-    return `  ${theme.bold(name)}`;
+    return `  ${prefix}${theme.bold(name)}`;
   }
   try {
     const art = figlet.textSync(name, {
       font: "Small",
       horizontalLayout: "default"
     });
-    const lines = art.split("\n").map((line) => `  ${line}`).join("\n");
+    const artLines = art.split("\n");
+    const lines = artLines.map((line, i) => {
+      if (icon && i === Math.floor(artLines.length / 2)) {
+        return `  ${icon}  ${line}`;
+      }
+      return icon ? `      ${line}` : `  ${line}`;
+    }).join("\n");
     return GRIMOIRE_GRADIENT(lines);
   } catch {
-    return `  ${theme.bold(name)}`;
+    return `  ${prefix}${theme.bold(name)}`;
   }
 }
 
@@ -1441,11 +1450,14 @@ function emitEvent(renderer, event, theme) {
 function runPreFlightChecks(checks, theme, renderer) {
   if (renderer) emitEvent(renderer, { type: "checks:start", checks }, theme);
   for (const check of checks) {
+    if (renderer) emitEvent(renderer, { type: "spinner:start", message: check.name }, theme);
     try {
       execSync(check.run, { stdio: "pipe" });
+      if (renderer) emitEvent(renderer, { type: "spinner:stop", message: `${check.name}` }, theme);
       console.log(`  ${theme.success("\u2713")} ${check.name}`);
       if (renderer) emitEvent(renderer, { type: "check:pass", name: check.name }, theme);
     } catch {
+      if (renderer) emitEvent(renderer, { type: "spinner:stop" }, theme);
       console.log(`  ${theme.error("\u2717")} ${check.name}: ${check.message}`);
       if (renderer) emitEvent(renderer, { type: "check:fail", name: check.name, message: check.message }, theme);
       throw new Error(`Pre-flight check failed: ${check.name} \u2014 ${check.message}`);
@@ -1565,8 +1577,17 @@ async function runWizard(config, options) {
         const withTemplate = options?.templateAnswers ? applyTemplateDefaults(resolvedStep, options.templateAnswers) : resolvedStep;
         const templatedStep = resolveStepTemplates(withTemplate, state.answers);
         const mruStep = mruEnabled ? applyMruOrdering(templatedStep, config.meta.name) : templatedStep;
+        let finalStep = mruStep;
+        if (!isMock && options?.optionsProvider && isSelectLikeStep(currentStep.type)) {
+          if (renderer) emitEvent(renderer, { type: "spinner:start", message: resolvedMessage }, theme);
+          const dynamicOptions = await options.optionsProvider(currentStep.id, state.answers);
+          if (renderer) emitEvent(renderer, { type: "spinner:stop", message: resolvedMessage }, theme);
+          if (dynamicOptions) {
+            finalStep = { ...mruStep, options: dynamicOptions };
+          }
+        }
         try {
-          const value = isMock ? getMockValue(mruStep, mockAnswers) : pluginStep ? await pluginStep.render(toStepRecord(mruStep), state, theme) : await renderStep(renderer, mruStep, state, theme);
+          const value = isMock ? getMockValue(finalStep, mockAnswers) : pluginStep ? await pluginStep.render(toStepRecord(finalStep), state, theme) : await renderStep(renderer, finalStep, state, theme);
           if (pluginStep?.validate) {
             const pluginError = pluginStep.validate(value, toStepRecord(templatedStep));
             if (pluginError) {
@@ -1905,6 +1926,7 @@ function resolveStepTemplates(step, answers) {
 }
 async function executeOnComplete(handlerPath, configFilePath, answers, config, theme, renderer) {
   if (renderer) emitEvent(renderer, { type: "oncomplete:start" }, theme);
+  if (renderer) emitEvent(renderer, { type: "spinner:start", message: `Running onComplete handler...` }, theme);
   const resolvedPath = configFilePath ? resolve2(dirname2(configFilePath), handlerPath) : resolve2(handlerPath);
   try {
     const mod = await import(pathToFileURL(resolvedPath).href);
@@ -1912,9 +1934,11 @@ async function executeOnComplete(handlerPath, configFilePath, answers, config, t
       throw new Error(`onComplete handler "${handlerPath}" must export a default function`);
     }
     await mod.default({ answers, config });
+    if (renderer) emitEvent(renderer, { type: "spinner:stop", message: "Handler complete" }, theme);
     if (renderer) emitEvent(renderer, { type: "oncomplete:pass" }, theme);
   } catch (error) {
     const message = error instanceof Error ? error.message : String(error);
+    if (renderer) emitEvent(renderer, { type: "spinner:stop" }, theme);
     if (renderer) emitEvent(renderer, { type: "oncomplete:fail", error: message }, theme);
     console.log(`
   ${theme.error("\u2717")} onComplete handler failed: ${message}
@@ -1934,11 +1958,14 @@ async function executeActions(actions, answers, theme, renderer) {
     const resolvedCommand = resolveTemplateStrict(action.run, answers);
     const resolvedName = action.name ? resolveTemplateStrict(action.name, answers) : void 0;
     const label = resolvedName ?? resolvedCommand;
+    if (renderer) emitEvent(renderer, { type: "spinner:start", message: label }, theme);
     try {
       execSync(resolvedCommand, { stdio: "pipe" });
+      if (renderer) emitEvent(renderer, { type: "spinner:stop", message: label }, theme);
       console.log(`  ${theme.success("\u2713")} ${label}`);
       if (renderer) emitEvent(renderer, { type: "action:pass", name: label }, theme);
     } catch {
+      if (renderer) emitEvent(renderer, { type: "spinner:stop" }, theme);
       console.log(`  ${theme.error("\u2717")} ${label}`);
       if (renderer) emitEvent(renderer, { type: "action:fail", name: label }, theme);
       throw new Error(`Action failed: ${label}`);
@@ -1948,7 +1975,7 @@ async function executeActions(actions, answers, theme, renderer) {
 }
 function printWizardHeader(config, theme, plain) {
   console.log();
-  console.log(renderBanner(config.meta.name, theme, { plain }));
+  console.log(renderBanner(config.meta.name, theme, { plain, icon: config.meta.icon }));
   if (config.meta.description) {
     console.log(`  ${theme.muted(config.meta.description)}`);
   }