clanka 0.2.10 → 0.2.12

package/src/OutputFormatter.ts

@@ -11,6 +11,7 @@ import type { AgentFinished, Output } from "./Agent.ts"
 import chalk from "chalk"
 import type * as Prompt from "effect/unstable/ai/Prompt"
 import * as Cause from "effect/Cause"
+import { identity } from "effect/Function"
 
 /**
  * @since 1.0.0
@@ -24,70 +25,87 @@ export type OutputFormatter = <E, R>(
  * @since 1.0.0
  * @category Pretty
  */
-export const pretty: OutputFormatter = (stream) =>
-  stream.pipe(
-    Stream.map((output) => {
-      let prefix = ""
-      if (output._tag === "SubagentPart") {
-        prefix = chalk.magenta(`Subagent #${output.id}:`) + " "
-        output = output.part
-      }
-      switch (output._tag) {
-        case "AgentStart": {
-          return `${chalkAgentHeading(`${subagentIcon} Agent #${output.id} starting (${output.modelAndProvider})`)}\n\n${promptToString(output.prompt)}\n\n`
+export const pretty = (options?: {
+  readonly outputTruncation?: number | boolean | undefined
+}): OutputFormatter => {
+  const maxLines =
+    typeof options?.outputTruncation === "number"
+      ? options.outputTruncation
+      : 20
+  const truncate =
+    options?.outputTruncation === true ||
+    typeof options?.outputTruncation === "number"
+      ? (text: string): string => {
+          const lines = text.split("\n")
+          if (lines.length > maxLines) {
+            return (
+              lines.slice(0, maxLines).join("\n") +
+              `\n... (truncated, total ${lines.length} lines)`
+            )
+          }
+          return text
         }
-        case "SubagentStart": {
-          return `${chalkSubagentHeading(`${subagentIcon} Subagent #${output.id} starting (${output.modelAndProvider})`)}
+      : identity
+  return (stream) =>
+    stream.pipe(
+      Stream.map((output) => {
+        let prefix = ""
+        if (output._tag === "SubagentPart") {
+          prefix = chalk.magenta(`Subagent #${output.id}:`) + " "
+          output = output.part
+        }
+        switch (output._tag) {
+          case "AgentStart": {
+            return `${chalkAgentHeading(`${subagentIcon} Agent #${output.id} starting (${output.modelAndProvider})`)}\n\n${promptToString(output.prompt)}\n\n`
+          }
+          case "SubagentStart": {
+            return `${chalkSubagentHeading(`${subagentIcon} Subagent #${output.id} starting (${output.modelAndProvider})`)}
 
 ${chalk.dim(output.prompt)}\n\n`
-        }
-        case "SubagentComplete": {
-          return `${chalkSubagentHeading(`${subagentIcon} Subagent #${output.id} complete`)}
+          }
+          case "SubagentComplete": {
+            return `${chalkSubagentHeading(`${subagentIcon} Subagent #${output.id} complete`)}
 
 ${output.summary}\n\n`
+          }
+          case "ReasoningStart": {
+            return (
+              prefix + chalkReasoningHeading(`${thinkingIcon} Thinking:`) + " "
+            )
+          }
+          case "ReasoningDelta": {
+            return output.delta
+          }
+          case "ReasoningEnd": {
+            return "\n\n"
+          }
+          case "ScriptStart": {
+            return `${prefix}${chalkScriptHeading(`${scriptIcon} Executing script`)}\n\n`
+          }
+          case "ScriptDelta": {
+            return chalk.dim(output.delta)
+          }
+          case "ScriptEnd": {
+            return "\n\n"
+          }
+          case "ScriptOutput": {
+            return `${prefix}${chalkScriptHeading(`${scriptIcon} Script output`)}\n\n${chalk.dim(truncate(output.output))}\n\n`
+          }
+          case "ErrorRetry": {
+            return `${prefix}${chalk.red(`Error: ${output.error.reason._tag}. Retrying...`)}\n\n${chalk.dim(Cause.pretty(Cause.fail(output.error)))}\n\n`
+          }
+          case "Usage": {
+            return `${prefix}${chalkInfoHeading(`${infoIcon} Usage:`)} ${numberFormat.format(output.contextTokens)} context / ${numberFormat.format(output.inputTokens)} input / ${numberFormat.format(output.outputTokens)} output\n\n`
+          }
         }
-        case "ReasoningStart": {
-          return (
-            prefix + chalkReasoningHeading(`${thinkingIcon} Thinking:`) + " "
-          )
-        }
-        case "ReasoningDelta": {
-          return output.delta
-        }
-        case "ReasoningEnd": {
-          return "\n\n"
-        }
-        case "ScriptStart": {
-          return `${prefix}${chalkScriptHeading(`${scriptIcon} Executing script`)}\n\n`
-        }
-        case "ScriptDelta": {
-          return chalk.dim(output.delta)
-        }
-        case "ScriptEnd": {
-          return "\n\n"
-        }
-        case "ScriptOutput": {
-          const lines = output.output.split("\n")
-          const truncated =
-            lines.length > 20
-              ? lines.slice(0, 20).join("\n") + "\n... (truncated)"
-              : output.output
-          return `${prefix}${chalkScriptHeading(`${scriptIcon} Script output`)}\n\n${chalk.dim(truncated)}\n\n`
-        }
-        case "ErrorRetry": {
-          return `${prefix}${chalk.red(`Error: ${output.error.reason._tag}. Retrying...`)}\n\n${chalk.dim(Cause.pretty(Cause.fail(output.error)))}\n\n`
-        }
-        case "Usage": {
-          return `${prefix}${chalkInfoHeading(`${infoIcon} Usage:`)} ${numberFormat.format(output.contextTokens)} context / ${numberFormat.format(output.inputTokens)} input / ${numberFormat.format(output.outputTokens)} output\n\n`
-        }
-      }
-    }),
-    Stream.catchTag("AgentFinished", (finished) =>
-      Stream.succeed(
-        `\n${chalk.bold.green(`${doneIcon} Task complete:`)}\n\n${(finished as AgentFinished).summary}`,
+      }),
+      Stream.catchTag("AgentFinished", (finished) =>
+        Stream.succeed(
+          `\n${chalk.bold.green(`${doneIcon} Task complete:`)}\n\n${(finished as AgentFinished).summary}`,
+        ),
       ),
-    ),
-  )
+    )
+}
 
 const promptToString = (prompt: Prompt.Prompt): string => {
   let textParts: Array<string> = []

package/src/ScriptPreprocessing.test.ts

@@ -0,0 +1,171 @@
+import { assert, describe, it } from "@effect/vitest"
+import { preprocessScript } from "./ScriptPreprocessing.ts"
+import { readFileSync } from "node:fs"
+import { join } from "node:path"
+
+const tick = "`"
+const escaped = "\\`"
+const escapedInterpolation = "\\${"
+const wrapTemplate = (value: string): string => `${tick}${value}${tick}`
+
+describe("preprocessScript", () => {
+  it("escapes internal backticks in applyPatch templates", () => {
+    const input = [
+      "await applyPatch(`",
+      "*** Begin Patch",
+      "*** Update File: src/example.ts",
+      "@@",
+      "-const oldValue = `old`",
+      "+const newValue = `new`",
+      "*** End Patch",
+      "`)",
+    ].join("\n")
+
+    const output = preprocessScript(input)
+
+    assert.strictEqual(
+      output.includes(`-const oldValue = ${escaped}old${escaped}`),
+      true,
+    )
+    assert.strictEqual(
+      output.includes(`+const newValue = ${escaped}new${escaped}`),
+      true,
+    )
+  })
+
+  it("escapes internal interpolations in applyPatch templates", () => {
+    const input = [
+      "await applyPatch(`",
+      "*** Begin Patch",
+      "*** Update File: src/example.ts",
+      "@@",
+      "+const value = ${nextValue}",
+      "*** End Patch",
+      "`)",
+    ].join("\n")
+
+    const output = preprocessScript(input)
+
+    assert.strictEqual(
+      output.includes(`+const value = ${escapedInterpolation}nextValue}`),
+      true,
+    )
+  })
+
+  it("escapes internal backticks in writeFile content templates", () => {
+    const input = [
+      "await writeFile({",
+      '  path: "src/example.ts",',
+      "  content: `const value = `next``,",
+      "})",
+    ].join("\n")
+
+    const output = preprocessScript(input)
+
+    assert.strictEqual(
+      output.includes(
+        `content: ${wrapTemplate(`const value = ${escaped}next${escaped}`)},`,
+      ),
+      true,
+    )
+  })
+
+  it("escapes internal backticks in taskComplete templates", () => {
+    const input = "await taskComplete(`Implemented `TypeBuilder` updates.`)"
+
+    const output = preprocessScript(input)
+
+    assert.strictEqual(
+      output,
+      `await taskComplete(${wrapTemplate(`Implemented ${escaped}TypeBuilder${escaped} updates.`)})`,
+    )
+  })
+
+  it("does not change scripts when target templates are already escaped", () => {
+    const input = [
+      `await applyPatch(${wrapTemplate(`const value = ${escaped}safe${escaped}`)})`,
+      `await applyPatch(${wrapTemplate(`const value = ${escapedInterpolation}safe}`)})`,
+      `await writeFile({ path: "src/example.ts", content: ${wrapTemplate(`already ${escaped}safe${escaped}`)} })`,
+      `await taskComplete(${wrapTemplate(`All done with ${escaped}safe${escaped} backticks.`)})`,
+    ].join("\n")
+
+    assert.strictEqual(preprocessScript(input), input)
+  })
+
+  it("does not modify non-target function calls", () => {
+    const input = "await otherTool(`Keep `this` untouched.`)"
+
+    assert.strictEqual(preprocessScript(input), input)
+  })
+
+  it("escapes internal backticks in applyPatch templates assigned to variables", () => {
+    const input = [
+      "const patch = `*** Begin Patch",
+      "*** Update File: src/example.ts",
+      "@@",
+      "-const oldValue = `old`",
+      "+const newValue = `new`",
+      "*** End Patch`;",
+      "await applyPatch(patch)",
+    ].join("\n")
+
+    const output = preprocessScript(input)
+
+    assert.strictEqual(
+      output.includes(`-const oldValue = ${escaped}old${escaped}`),
+      true,
+    )
+    assert.strictEqual(
+      output.includes(`+const newValue = ${escaped}new${escaped}`),
+      true,
+    )
+  })
+
+  it("escapes internal backticks in taskComplete templates assigned to variables", () => {
+    const input = [
+      "const summary = `Implemented `TypeBuilder` updates.`;",
+      "await taskComplete(summary)",
+    ].join("\n")
+
+    const output = preprocessScript(input)
+
+    assert.strictEqual(
+      output,
+      [
+        `const summary = ${wrapTemplate(`Implemented ${escaped}TypeBuilder${escaped} updates.`)};`,
+        "await taskComplete(summary)",
+      ].join("\n"),
+    )
+  })
+
+  it("escapes internal backticks in writeFile content assigned to variables", () => {
+    const input = [
+      "const body = `const value = `next``;",
+      "await writeFile({",
+      '  path: "src/example.ts",',
+      "  content: body,",
+      "})",
+    ].join("\n")
+
+    const output = preprocessScript(input)
+
+    assert.strictEqual(
+      output.includes(
+        `const body = ${wrapTemplate(`const value = ${escaped}next${escaped}`)};`,
+      ),
+      true,
+    )
+  })
+
+  it.each(["patch", "patch2"])("fixes broken %s", (fixture) => {
+    const content = readFileSync(
+      join(__dirname, "fixtures", `${fixture}-broken.txt`),
+      "utf-8",
+    )
+    const fixed = readFileSync(
+      join(__dirname, "fixtures", `${fixture}-fixed.txt`),
+      "utf-8",
+    )
+    assert.equal(preprocessScript(content), fixed)
+  })
+})