@canonical/summon 0.1.0 → 0.12.0

package/LICENSE

@@ -0,0 +1,166 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
+

package/README.md

@@ -47,11 +47,18 @@ Every prompt becomes a CLI flag. Boolean prompts with `default: true` use the `-
 | Flag | Description |
 |------|-------------|
 | `-d, --dry-run` | Preview without writing files |
-| `-y, --yes` | Skip confirmation prompts |
+| `-y, --yes` | Skip confirmation prompts and preview |
 | `-v, --verbose` | Show debug output |
+| `--show-contents` | Show file contents in dry-run (useful for LLMs) |
 | `--no-preview` | Skip the file preview |
 | `--no-generated-stamp` | Disable generated file stamp comments |
 
+**LLM Usage:** The `--show-contents` flag is particularly useful for AI assistants and LLM agents. When combined with `--dry-run`, it outputs the complete generated file contents, allowing the LLM to review, analyze, or use the generated code without writing to disk:
+
+```bash
+summon component react src/components/Button --dry-run --show-contents -y
+```
+
 ### Shell Autocompletion
 
 Summon supports TAB completion for Bash, Zsh, and Fish shells. Completions are **dynamic** - they automatically detect newly installed generator packages without needing to re-run setup.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@canonical/summon",
   "description": "A monadic task-centric code generator framework with React Ink CLI.",
-  "version": "0.1.0",
+  "version": "0.12.0",
   "type": "module",
   "module": "src/index.ts",
   "types": "src/index.ts",
@@ -40,8 +40,8 @@
   },
   "devDependencies": {
     "@biomejs/biome": "2.3.11",
-    "@canonical/biome-config": "^0.11.0",
-    "@canonical/typescript-config-base": "^0.11.0",
+    "@canonical/biome-config": "^0.12.0",
+    "@canonical/typescript-config-base": "^0.12.0",
     "@types/ejs": "^3.1.5",
     "@types/omelette": "^0.4.5",
     "@types/react": "^19.0.0",
@@ -60,5 +60,6 @@
     "ink-text-input": "^6.0.0",
     "omelette": "^0.4.17",
     "react": "^19.0.0"
-  }
+  },
+  "gitHead": "0b491caff8f797fef4ba4b7f5514a7c5b915a481"
 }

package/src/cli-format.ts

@@ -163,3 +163,74 @@ export const formatEffectLine = (effect: Effect, isLast: boolean): string => {
 
   return `${chalk.dim(connector)} ${colorFn(paddedLabel)}${payload}`;
 };
+
+/**
+ * Maximum number of lines to show in content preview.
+ */
+const MAX_PREVIEW_LINES = 50;
+
+/**
+ * Maximum width for content lines (will truncate).
+ */
+const MAX_LINE_WIDTH = 120;
+
+/**
+ * Format file content for preview display.
+ * Shows line numbers and truncates long content.
+ *
+ * @param content - The file content to format
+ * @param maxLines - Maximum number of lines to show (default: MAX_PREVIEW_LINES)
+ */
+export const formatContentPreview = (
+  content: string,
+  maxLines: number = MAX_PREVIEW_LINES,
+): string => {
+  const lines = content.split("\n");
+  const totalLines = lines.length;
+  const showLines = lines.slice(0, maxLines);
+  const lineNumWidth = String(Math.min(totalLines, maxLines)).length;
+
+  const formatted = showLines.map((line, i) => {
+    const lineNum = String(i + 1).padStart(lineNumWidth, " ");
+    const truncatedLine =
+      line.length > MAX_LINE_WIDTH
+        ? `${line.slice(0, MAX_LINE_WIDTH - 3)}...`
+        : line;
+    return `${chalk.dim(`${lineNum} │`)} ${truncatedLine}`;
+  });
+
+  if (totalLines > maxLines) {
+    formatted.push(
+      chalk.dim(`   ... (${totalLines - maxLines} more lines omitted)`),
+    );
+  }
+
+  return formatted.join("\n");
+};
+
+/**
+ * Format an effect with its content (for verbose dry-run mode).
+ * This is useful for LLM agents that need to see generated file contents.
+ *
+ * @param effect - The effect to format
+ * @param isLast - Whether this is the last effect in the list
+ */
+export const formatEffectWithContent = (
+  effect: Effect,
+  isLast: boolean,
+): string => {
+  const baseLine = formatEffectLine(effect, isLast);
+
+  // Only show content for WriteFile and AppendFile effects
+  if (effect._tag === "WriteFile" || effect._tag === "AppendFile") {
+    const indent = isLast ? "   " : "│  ";
+    const contentPreview = formatContentPreview(effect.content);
+    const indentedContent = contentPreview
+      .split("\n")
+      .map((line) => `${chalk.dim(indent)}${line}`)
+      .join("\n");
+    return `${baseLine}\n${indentedContent}`;
+  }
+
+  return baseLine;
+};

package/src/cli.tsx

@@ -888,10 +888,18 @@ const configureGroupedHelp = (
       output += "\nGlobal Options:\n";
       output += formatItem("-d, --dry-run", "Preview without writing files");
       output += "\n";
-      output += formatItem("-y, --yes", "Skip confirmation prompts");
+      output += formatItem(
+        "-y, --yes",
+        "Skip confirmation prompts and preview",
+      );
       output += "\n";
       output += formatItem("-v, --verbose", "Show debug output");
       output += "\n";
+      output += formatItem(
+        "--show-contents",
+        "Show file contents in dry-run (useful for LLMs)",
+      );
+      output += "\n";
       output += formatItem("--no-preview", "Skip the file preview");
       output += "\n";
       output += formatItem(
@@ -899,6 +907,11 @@ const configureGroupedHelp = (
         "Disable generated file stamp comments",
       );
       output += "\n";
+      output += formatItem(
+        "-l, --llm",
+        "LLM mode: combines --dry-run --show-contents --yes",
+      );
+      output += "\n";
       output += formatItem("-h, --help", "display help for command");
       output += "\n";
 
@@ -1066,12 +1079,17 @@ const registerFromBarrel = (rootCmd: Command, barrel: CommandEntry[]): void => {
         .command(commandSpec)
         .description(entry.generator.meta.description)
         .option("-d, --dry-run", "Preview without writing files")
-        .option("-y, --yes", "Skip confirmation prompts")
+        .option("-y, --yes", "Skip confirmation prompts and preview")
         .option("-v, --verbose", "Show debug output")
+        .option(
+          "--show-contents",
+          "Show file contents in dry-run (useful for LLMs)",
+        )
         .option("--no-preview", "Skip the file preview")
+        .option("--no-generated-stamp", "Disable generated file stamp comments")
         .option(
-          "--no-generated-stamp",
-          "Disable generated file stamp comments",
+          "-l, --llm",
+          "LLM mode: combines --dry-run --show-contents --yes",
         );
 
       // Set custom usage to show positional arg before [options]
@@ -1128,6 +1146,13 @@ const configureGeneratorCommand = (
         actualOptions = (positionalArg as Record<string, unknown>) ?? {};
       }
 
+      // Expand --llm flag into its component flags
+      if (actualOptions.llm === true) {
+        actualOptions.dryRun = true;
+        actualOptions.showContents = true;
+        actualOptions.yes = true;
+      }
+
       // Extract only explicitly provided CLI answers (not defaults)
       const cliAnswers = extractAnswers(actualOptions, generator.prompts);
 
@@ -1164,11 +1189,11 @@ const configureGeneratorCommand = (
       if (hasAllAnswers && actualOptions.dryRun && !isTTY) {
         // Batch dry-run mode (non-interactive)
         const { dryRun } = await import("./dry-run.js");
-        const { isVisibleEffect, formatEffectLine } = await import(
-          "./cli-format.js"
-        );
+        const { isVisibleEffect, formatEffectLine, formatEffectWithContent } =
+          await import("./cli-format.js");
 
         const verbose = actualOptions.verbose === true;
+        const showContents = actualOptions.showContents === true;
 
         console.log();
         console.log(chalk.bold.magenta(generator.meta.name));
@@ -1192,11 +1217,25 @@ const configureGeneratorCommand = (
         console.log(chalk.dim.bold("Plan:"));
         visibleEffects.forEach((effect, index) => {
           const isLast = index === visibleEffects.length - 1;
-          console.log(formatEffectLine(effect, isLast));
+          // Use content preview when --show-contents is enabled
+          if (showContents) {
+            console.log(formatEffectWithContent(effect, isLast));
+          } else {
+            console.log(formatEffectLine(effect, isLast));
+          }
         });
 
         console.log();
         console.log(chalk.dim("Dry-run complete. No files were modified."));
+
+        // Note about --show-contents if not already using it
+        if (!showContents) {
+          console.log(
+            chalk.dim(
+              "Tip: Use --show-contents to see generated file contents",
+            ),
+          );
+        }
       } else {
         // Interactive mode
         // Only pass answers if:
@@ -1208,10 +1247,15 @@ const configureGeneratorCommand = (
           ? answersWithDefaults
           : undefined;
 
+        // When --yes is used, automatically skip preview (implies --no-preview)
+        const shouldShowPreview = skipPrompts
+          ? false
+          : (actualOptions.preview as boolean);
+
         const { waitUntilExit } = render(
           <App
             generator={generator}
-            preview={actualOptions.preview as boolean}
+            preview={shouldShowPreview}
             dryRunOnly={actualOptions.dryRun as boolean}
             verbose={actualOptions.verbose as boolean}
             answers={passedAnswers}

package/src/completion.ts

@@ -200,6 +200,7 @@ export const getArgumentCompletions = (
       "--verbose",
       "--no-preview",
       "--no-generated-stamp",
+      "--llm",
       "--help",
     ];
     for (const flag of builtinFlags) {