blue-archive-2094

lib/prompt-templates/create-local-circuit-prompt.ts

@@ -37,18 +37,29 @@ export const createLocalCircuitPrompt = async () => {
     (await fetchFileContent(
       "https://raw.githubusercontent.com/tscircuit/props/main/generated/COMPONENT_TYPES.md",
     )) || ""
+  const generatedDocs =
+    (await fetchFileContent("https://docs.tscircuit.com/ai.txt")) || ""
 
   const cleanedPropsDoc = propsDoc
     .split("\n")
     .filter((line) => !line.startsWith("#"))
     .join("\n")
     .replace(/\n\n+/g, "\n\n")
+  const cleanedGeneratedDocs = generatedDocs.trim()
 
   return `
 You are an expert in electronic circuit design and tscircuit, and your job is to create a circuit board in tscircuit with the user-provided description.
 
 YOU MUST ABIDE BY THE RULES IN THE RULES SECTION
 
+## Auto-generated tscircuit docs
+
+The following docs are generated from the current tscircuit documentation and
+should be treated as the most up-to-date reference for APIs, imports, and usage
+patterns:
+
+${cleanedGeneratedDocs}
+
 ## tscircuit API overview
 
 Here's an overview of the tscircuit API:

tests/prompt-templates/create-local-circuit-prompt.test.ts

@@ -0,0 +1,41 @@
+import { afterEach, expect, test } from "bun:test"
+import { createLocalCircuitPrompt } from "../../lib/prompt-templates/create-local-circuit-prompt"
+
+const originalFetch = globalThis.fetch
+
+afterEach(() => {
+  globalThis.fetch = originalFetch
+})
+
+test("createLocalCircuitPrompt includes generated ai.txt docs", async () => {
+  const requestedUrls: string[] = []
+
+  globalThis.fetch = (async (input) => {
+    const url = input instanceof Request ? input.url : String(input)
+    requestedUrls.push(url)
+
+    if (url === "https://docs.tscircuit.com/ai.txt") {
+      return new Response(
+        "# Generated Docs\nUse generated docs when selecting tscircuit APIs.\n",
+      )
+    }
+
+    if (
+      url ===
+      "https://raw.githubusercontent.com/tscircuit/props/main/generated/COMPONENT_TYPES.md"
+    ) {
+      return new Response(
+        '# Component Types\n<resistor name="R1" resistance="1k" />\n',
+      )
+    }
+
+    throw new Error(`Unexpected fetch URL: ${url}`)
+  }) as typeof fetch
+
+  const prompt = await createLocalCircuitPrompt()
+
+  expect(requestedUrls).toContain("https://docs.tscircuit.com/ai.txt")
+  expect(prompt).toContain("## Auto-generated tscircuit docs")
+  expect(prompt).toContain("Use generated docs when selecting tscircuit APIs.")
+  expect(prompt).toContain('<resistor name="R1" resistance="1k" />')
+})

tests/tscircuitCoder.test.ts

@@ -2,38 +2,43 @@ import { createTscircuitCoder } from "lib/tscircuit-coder/tscircuitCoder"
 import { expect, test } from "bun:test"
 import { getPrimarySourceCodeFromVfs } from "lib/utils/get-primary-source-code-from-vfs"
 
-test("TscircuitCoder submitPrompt streams and updates vfs", async () => {
-  const streamedChunks: string[] = []
-  let vfsUpdated = false
-  const tscircuitCoder = createTscircuitCoder()
-  tscircuitCoder.on("streamedChunk", (chunk: string) => {
-    streamedChunks.push(chunk)
-  })
-  tscircuitCoder.on("vfsChanged", () => {
-    vfsUpdated = true
-  })
-
-  await tscircuitCoder.submitPrompt({
-    prompt: "create bridge rectifier circuit",
-  })
-
-  await tscircuitCoder.submitPrompt({
-    prompt: "add a transistor component",
-  })
-
-  let codeWithTransistor = getPrimarySourceCodeFromVfs(tscircuitCoder.vfs)
-  expect(codeWithTransistor).toInclude("transistor")
-
-  await tscircuitCoder.submitPrompt({
-    prompt: "add a tssop20 chip",
-  })
-
-  let codeWithChip = getPrimarySourceCodeFromVfs(tscircuitCoder.vfs)
-  expect(codeWithChip).toInclude("tssop20")
-  expect(codeWithChip).toInclude("transistor")
-
-  expect(streamedChunks.length).toBeGreaterThan(0)
-  const vfsKeys = Object.keys(tscircuitCoder.vfs)
-  expect(vfsKeys.length).toBeGreaterThan(0)
-  expect(vfsUpdated).toBe(true)
-})
+const testWithOpenAi = process.env.OPENAI_API_KEY ? test : test.skip
+
+testWithOpenAi(
+  "TscircuitCoder submitPrompt streams and updates vfs",
+  async () => {
+    const streamedChunks: string[] = []
+    let vfsUpdated = false
+    const tscircuitCoder = createTscircuitCoder()
+    tscircuitCoder.on("streamedChunk", (chunk: string) => {
+      streamedChunks.push(chunk)
+    })
+    tscircuitCoder.on("vfsChanged", () => {
+      vfsUpdated = true
+    })
+
+    await tscircuitCoder.submitPrompt({
+      prompt: "create bridge rectifier circuit",
+    })
+
+    await tscircuitCoder.submitPrompt({
+      prompt: "add a transistor component",
+    })
+
+    let codeWithTransistor = getPrimarySourceCodeFromVfs(tscircuitCoder.vfs)
+    expect(codeWithTransistor).toInclude("transistor")
+
+    await tscircuitCoder.submitPrompt({
+      prompt: "add a tssop20 chip",
+    })
+
+    let codeWithChip = getPrimarySourceCodeFromVfs(tscircuitCoder.vfs)
+    expect(codeWithChip).toInclude("tssop20")
+    expect(codeWithChip).toInclude("transistor")
+
+    expect(streamedChunks.length).toBeGreaterThan(0)
+    const vfsKeys = Object.keys(tscircuitCoder.vfs)
+    expect(vfsKeys.length).toBeGreaterThan(0)
+    expect(vfsUpdated).toBe(true)
+  },
+)

tests/utils/generate-random-prompts.test.ts

@@ -1,8 +1,10 @@
 import { describe, it, expect } from "bun:test"
 import { generateRandomPrompts } from "../../lib/utils/generate-random-prompts"
 
+const itWithOpenAi = process.env.OPENAI_API_KEY ? it : it.skip
+
 describe("generateRandomPrompts", () => {
-  it("should return an array of prompts", async () => {
+  itWithOpenAi("should return an array of prompts", async () => {
     const prompts = await generateRandomPrompts(3)
 
     expect(Array.isArray(prompts)).toBe(true)