fix: graceful issue handling

Author: pi0

src/cli.ts

@@ -5,7 +5,7 @@ import { defineCommand, runMain } from "citty";
 import consola from "consola";
 import { getColor } from "consola/utils";
 import { name, description, version } from "../package.json";
-import { automd } from "./automd";
+import { AutomdResult, automd } from "./automd";
 
 const main = defineCommand({
   meta: {
@@ -48,20 +48,41 @@ const main = defineCommand({
       updated: { label: "updated", color: getColor("blue") },
       noChanges: { label: "no changes", color: getColor("green") },
       alreadyUpdate: { label: "already up-to-date", color: getColor("gray") },
+      issues: { label: "with issues", color: getColor("yellow") },
+    };
+    const getChangeType = (res: AutomdResult) => {
+      if (res.updates.length === 0) {
+        return changeTypes.alreadyUpdate;
+      }
+      if (res.hasIssues) {
+        return changeTypes.issues;
+      }
+      return res.hasChanged ? changeTypes.updated : changeTypes.noChanges;
     };
 
-    for (const f of fileUpdates) {
-      const [input, output] = [f.input, f.output].map((i) =>
-        relative(f._config.dir, i),
+    for (const res of fileUpdates) {
+      const [input, output] = [res.input, res.output].map((i) =>
+        relative(res._config.dir, i),
       );
-      const fileStr =
-        input === output ? `  ${input}` : `  ${input} ~> ${output}`;
+      const t = getChangeType(res);
+
+      const f = `${input === output ? `  ${input}` : `  ${input} ~> ${output}`}`;
 
-      const t =
-        // prettier-ignore
-        f.updates.length === 0 ? changeTypes.alreadyUpdate : (f.hasChanged ? changeTypes.updated : changeTypes.noChanges);
+      consola.log(t.color(`  ─  ${f} ${t.label}`));
+    }
+
+    const issues = fileUpdates
+      .filter((f) => f.hasIssues)
+      .map(
+        (f) =>
+          `${changeTypes.issues.color(relative(f._config.dir, f.input))} \n\n ${f.updates.flatMap((u) => u.result.issues).join("\n")}`,
+      );
 
-      consola.log(t.color(`  ─ ${fileStr} ${t.label}`));
+    if (issues.length > 0) {
+      consola.warn(`Some issues happened during update!`);
+      for (const issue of issues) {
+        consola.error(issue);
+      }
     }
   },
 });

src/generator.ts

@@ -9,7 +9,7 @@ export interface GenerateContext {
 
 export interface GenerateResult {
   contents: string;
-  warnings?: string[];
+  issues?: string[];
 }
 
 export interface Generator {

src/transform.ts

@@ -6,6 +6,7 @@ import { Config, ResolvedConfig, resolveConfig } from "./config";
 
 export interface TransformResult {
   hasChanged: boolean;
+  hasIssues: boolean;
   contents: string;
   updates: { block: Block; result: GenerateResult }[];
 }
@@ -39,6 +40,7 @@ export async function transform(
 
   return {
     hasChanged: editor.hasChanged(),
+    hasIssues: updates.some((u) => u.result.issues?.length),
     contents: editor.toString(),
     updates,
   };
@@ -55,10 +57,10 @@ async function _transformBlock(
   if (!generator) {
     const didYouMean = await import("didyoumean2").then((r) => r.default || r);
     const suggestions = didYouMean(block.generator, Object.keys(generators));
-    const warn = `[automd] Unknown generator:\`${block.generator}\`.${suggestions ? ` Did you mean "generator:\`${suggestions}\`"?` : ""}`;
+    const error = `Unknown generator:\`${block.generator}\`.${suggestions ? ` Did you mean "generator:\`${suggestions}\`"?` : ""}`;
     return {
-      contents: `/* ${warn} */`,
-      warnings: [warn],
+      contents: `<!-- ⚠️  ${error} -->`,
+      issues: [error],
     };
   }
 
@@ -68,7 +70,14 @@ async function _transformBlock(
     block,
   };
 
-  const result = (await generator.generate(context)) as GenerateResult;
-
-  return result;
+  try {
+    const result = (await generator.generate(context)) as GenerateResult;
+    return result;
+  } catch (_error: any) {
+    const error = `(${block.generator}) ${_error.message || _error}`;
+    return {
+      contents: `<!-- ⚠️  ${error} -->`,
+      issues: [error],
+    };
+  }
 }