Improve --prompt clipboard output for agent fixes (#2)

* feat: copy verbose diagnostics output to clipboard prompt

* refactor: rename prompt copy helpers and update prompt docs

* feat: copy verbose diagnostics output to clipboard prompt

* refactor: rename prompt copy helpers and update prompt docs

Author: ben-million

README.md

@@ -46,6 +46,8 @@ Options:
   --score           output only the score
   -y, --yes         skip prompts, scan all workspace projects
   --project <name>  select workspace project (comma-separated for multiple)
+  --fix             open Ami to auto-fix all issues
+  --prompt          copy latest scan output to clipboard
   -h, --help        display help for command
 ```
 

packages/react-doctor/src/cli.ts

@@ -1,15 +1,17 @@
 import { execSync } from "node:child_process";
 import path from "node:path";
 import { Command } from "commander";
+import { SEPARATOR_LENGTH_CHARS } from "./constants.js";
 import type { ScanOptions } from "./types.js";
 import { handleError } from "./utils/handle-error.js";
 import { highlighter } from "./utils/highlighter.js";
-import { logger } from "./utils/logger.js";
+import { logger, startLoggerCapture, stopLoggerCapture } from "./utils/logger.js";
 import { scan } from "./scan.js";
 import { selectProjects } from "./utils/select-projects.js";
 import { prompts } from "./utils/prompts.js";
 import { maybePromptSkillInstall } from "./utils/skill-prompt.js";
 import { maybeInstallGlobally } from "./utils/global-install.js";
+import { copyToClipboard } from "./utils/copy-to-clipboard.js";
 
 const VERSION = process.env.VERSION ?? "0.0.0";
 
@@ -19,6 +21,7 @@ interface CliFlags {
   verbose: boolean;
   score: boolean;
   fix: boolean;
+  prompt: boolean;
   yes: boolean;
   project?: string;
 }
@@ -38,10 +41,17 @@ const program = new Command()
   .option("-y, --yes", "skip prompts, scan all workspace projects")
   .option("--project <name>", "select workspace project (comma-separated for multiple)")
   .option("--fix", "open Ami to auto-fix all issues")
+  .option("--prompt", "copy latest scan output to clipboard")
   .action(async (directory: string, flags: CliFlags) => {
+    const isScoreOnly = flags.score && !flags.prompt;
+    const shouldCopyPromptOutput = flags.prompt;
+
+    if (shouldCopyPromptOutput) {
+      startLoggerCapture();
+    }
+
     try {
       const resolvedDirectory = path.resolve(directory);
-      const isScoreOnly = flags.score;
 
       if (!isScoreOnly) {
         logger.log(`react-doctor v${VERSION}`);
@@ -51,7 +61,7 @@ const program = new Command()
       const scanOptions: ScanOptions = {
         lint: flags.lint,
         deadCode: flags.deadCode,
-        verbose: Boolean(flags.verbose),
+        verbose: flags.prompt || Boolean(flags.verbose),
         scoreOnly: isScoreOnly,
       };
 
@@ -87,14 +97,19 @@ const program = new Command()
         openAmiToFix(resolvedDirectory);
       }
 
-      if (!isScoreOnly) {
+      if (!isScoreOnly && !flags.prompt) {
         await maybePromptSkillInstall(shouldSkipPrompts);
         if (!shouldSkipPrompts && !flags.fix) {
           await maybePromptAmiFix(resolvedDirectory);
         }
       }
     } catch (error) {
-      handleError(error);
+      handleError(error, { shouldExit: !shouldCopyPromptOutput });
+    } finally {
+      if (shouldCopyPromptOutput) {
+        const capturedOutput = stopLoggerCapture();
+        copyPromptToClipboard(capturedOutput, !isScoreOnly);
+      }
     }
   })
   .addHelpText(
@@ -106,8 +121,10 @@ ${highlighter.dim("Learn more:")}
   );
 
 const AMI_INSTALL_URL = "https://ami.dev/install.sh";
-const AMI_FIX_PROMPT =
-  "Run npx -y react-doctor@latest . --verbose, read every diagnostic, then fix all issues one by one. After fixing, re-run react-doctor to verify the score improved.";
+const FIX_PROMPT =
+  "Fix all issues reported in the react-doctor diagnostics below, one by one. After applying fixes, run `react-dcotor` again to verify the results improved.";
+const REACT_DOCTOR_OUTPUT_LABEL = "react-doctor output";
+const SCAN_SUMMARY_SEPARATOR = "─".repeat(SEPARATOR_LENGTH_CHARS);
 
 const isAmiInstalled = (): boolean => {
   try {
@@ -140,7 +157,7 @@ const openAmiToFix = (directory: string): void => {
   logger.log("Opening Ami to fix react-doctor issues...");
 
   const encodedDirectory = encodeURIComponent(resolvedDirectory);
-  const encodedPrompt = encodeURIComponent(AMI_FIX_PROMPT);
+  const encodedPrompt = encodeURIComponent(FIX_PROMPT);
   const deeplink = `ami://open-project?cwd=${encodedDirectory}&prompt=${encodedPrompt}&mode=agent`;
 
   try {
@@ -153,6 +170,35 @@ const openAmiToFix = (directory: string): void => {
   }
 };
 
+const buildPromptWithOutput = (reactDoctorOutput: string): string => {
+  const summaryStartIndex = reactDoctorOutput.indexOf(SCAN_SUMMARY_SEPARATOR);
+  const diagnosticsOutput =
+    summaryStartIndex === -1
+      ? reactDoctorOutput
+      : reactDoctorOutput.slice(0, summaryStartIndex).trimEnd();
+  const normalizedReactDoctorOutput = diagnosticsOutput.trim();
+  const outputContent =
+    normalizedReactDoctorOutput.length > 0 ? normalizedReactDoctorOutput : "No output captured.";
+  return `${FIX_PROMPT}\n\n${REACT_DOCTOR_OUTPUT_LABEL}:\n\`\`\`\n${outputContent}\n\`\`\``;
+};
+
+const copyPromptToClipboard = (reactDoctorOutput: string, shouldLogResult: boolean): void => {
+  const promptWithOutput = buildPromptWithOutput(reactDoctorOutput);
+  const didCopyPromptToClipboard = copyToClipboard(promptWithOutput);
+
+  if (!shouldLogResult) {
+    return;
+  }
+
+  if (didCopyPromptToClipboard) {
+    logger.success("Copied latest scan output to clipboard");
+    return;
+  }
+
+  logger.warn("Could not copy prompt to clipboard automatically. Use this prompt:");
+  logger.info(promptWithOutput);
+};
+
 const maybePromptAmiFix = async (directory: string): Promise<void> => {
   logger.break();
   logger.log(`Fix these issues with ${highlighter.info("Ami")}?`);

packages/react-doctor/src/types.ts

@@ -88,6 +88,20 @@ export interface ScanOptions {
   scoreOnly: boolean;
 }
 
+export interface ClipboardCommand {
+  command: string;
+  args: string[];
+}
+
+export interface LoggerCaptureState {
+  isEnabled: boolean;
+  lines: string[];
+}
+
+export interface HandleErrorOptions {
+  shouldExit: boolean;
+}
+
 export interface WorkspacePackage {
   name: string;
   directory: string;

packages/react-doctor/src/utils/copy-to-clipboard.ts

@@ -0,0 +1,36 @@
+import { spawnSync } from "node:child_process";
+import type { ClipboardCommand } from "../types.js";
+
+const getClipboardCommands = (): ClipboardCommand[] => {
+  if (process.platform === "darwin") {
+    return [{ command: "pbcopy", args: [] }];
+  }
+
+  if (process.platform === "win32") {
+    return [{ command: "clip", args: [] }];
+  }
+
+  return [
+    { command: "wl-copy", args: [] },
+    { command: "xclip", args: ["-selection", "clipboard"] },
+    { command: "xsel", args: ["--clipboard", "--input"] },
+  ];
+};
+
+export const copyToClipboard = (text: string): boolean => {
+  const clipboardCommands = getClipboardCommands();
+
+  for (const clipboardCommand of clipboardCommands) {
+    const clipboardProcess = spawnSync(clipboardCommand.command, clipboardCommand.args, {
+      input: text,
+      stdio: ["pipe", "ignore", "ignore"],
+      encoding: "utf8",
+    });
+
+    if (clipboardProcess.status === 0) {
+      return true;
+    }
+  }
+
+  return false;
+};

packages/react-doctor/src/utils/handle-error.ts

@@ -1,6 +1,14 @@
 import { logger } from "./logger.js";
+import type { HandleErrorOptions } from "../types.js";
 
-export const handleError = (error: unknown): void => {
+const DEFAULT_HANDLE_ERROR_OPTIONS: HandleErrorOptions = {
+  shouldExit: true,
+};
+
+export const handleError = (
+  error: unknown,
+  options: HandleErrorOptions = DEFAULT_HANDLE_ERROR_OPTIONS,
+): void => {
   logger.break();
   logger.error("Something went wrong. Please check the error below for more details.");
   logger.error("If the problem persists, please open an issue on GitHub.");
@@ -9,5 +17,8 @@ export const handleError = (error: unknown): void => {
     logger.error(error.message);
   }
   logger.break();
-  process.exit(1);
+  if (options.shouldExit) {
+    process.exit(1);
+  }
+  process.exitCode = 1;
 };

packages/react-doctor/src/utils/logger.ts

@@ -1,25 +1,57 @@
 import { highlighter } from "./highlighter.js";
+import { stripAnsi } from "./strip-ansi.js";
+import type { LoggerCaptureState } from "../types.js";
+
+const loggerCaptureState: LoggerCaptureState = {
+  isEnabled: false,
+  lines: [],
+};
+
+const captureLogLine = (text: string): void => {
+  if (!loggerCaptureState.isEnabled) {
+    return;
+  }
+
+  loggerCaptureState.lines.push(stripAnsi(text));
+};
+
+const writeLogLine = (text: string): void => {
+  console.log(text);
+  captureLogLine(text);
+};
+
+export const startLoggerCapture = (): void => {
+  loggerCaptureState.isEnabled = true;
+  loggerCaptureState.lines = [];
+};
+
+export const stopLoggerCapture = (): string => {
+  const capturedOutput = loggerCaptureState.lines.join("\n");
+  loggerCaptureState.isEnabled = false;
+  loggerCaptureState.lines = [];
+  return capturedOutput;
+};
 
 export const logger = {
   error(...args: unknown[]) {
-    console.log(highlighter.error(args.join(" ")));
+    writeLogLine(highlighter.error(args.join(" ")));
   },
   warn(...args: unknown[]) {
-    console.log(highlighter.warn(args.join(" ")));
+    writeLogLine(highlighter.warn(args.join(" ")));
   },
   info(...args: unknown[]) {
-    console.log(highlighter.info(args.join(" ")));
+    writeLogLine(highlighter.info(args.join(" ")));
   },
   success(...args: unknown[]) {
-    console.log(highlighter.success(args.join(" ")));
+    writeLogLine(highlighter.success(args.join(" ")));
   },
   dim(...args: unknown[]) {
-    console.log(highlighter.dim(args.join(" ")));
+    writeLogLine(highlighter.dim(args.join(" ")));
   },
   log(...args: unknown[]) {
-    console.log(args.join(" "));
+    writeLogLine(args.join(" "));
   },
   break() {
-    console.log("");
+    writeLogLine("");
   },
 };

packages/react-doctor/src/utils/strip-ansi.ts

@@ -0,0 +1,4 @@
+const ANSI_ESCAPE_SEQUENCE = String.raw`\u001B\[[0-9;]*m`;
+const ANSI_ESCAPE_PATTERN = new RegExp(ANSI_ESCAPE_SEQUENCE, "g");
+
+export const stripAnsi = (text: string): string => text.replace(ANSI_ESCAPE_PATTERN, "");