diff --git a/lib/prompt-templates/create-local-circuit-prompt.ts b/lib/prompt-templates/create-local-circuit-prompt.ts index a93f11f..7d7e311 100644 --- a/lib/prompt-templates/create-local-circuit-prompt.ts +++ b/lib/prompt-templates/create-local-circuit-prompt.ts @@ -1,7 +1,7 @@ import { + fp, getFootprintNamesByType, getFootprintSizes, - fp, } from "@tscircuit/footprinter" async function fetchFileContent(url: string): Promise { @@ -19,6 +19,22 @@ async function fetchFileContent(url: string): Promise { } } +async function fetchOptionalFileContent(url: string): Promise { + try { + const response = await fetch(url) + if (!response.ok) { + console.warn( + `Skipping optional file: ${response.status} ${response.statusText}`, + ) + return "" + } + return await response.text() + } catch (error) { + console.warn("Skipping optional file:", error) + return "" + } +} + export const createLocalCircuitPrompt = async () => { const footprintNamesByType = getFootprintNamesByType() const footprintSizes = getFootprintSizes() @@ -44,11 +60,19 @@ export const createLocalCircuitPrompt = async () => { .join("\n") .replace(/\n\n+/g, "\n\n") + const generatedDocs = await fetchOptionalFileContent( + "https://docs.tscircuit.com/ai.txt", + ) + 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 +## Generated tscircuit documentation + +${generatedDocs} + ## tscircuit API overview Here's an overview of the tscircuit API: diff --git a/tests/prompt-templates/create-local-circuit-prompt.test.ts b/tests/prompt-templates/create-local-circuit-prompt.test.ts new file mode 100644 index 0000000..a34f034 --- /dev/null +++ b/tests/prompt-templates/create-local-circuit-prompt.test.ts @@ -0,0 +1,61 @@ +import { afterEach, describe, expect, it } from "bun:test" +import { createLocalCircuitPrompt } from "../../lib/prompt-templates/create-local-circuit-prompt" + +describe("createLocalCircuitPrompt", () => { + const originalFetch = globalThis.fetch + + afterEach(() => { + globalThis.fetch = originalFetch + }) + + it("includes generated tscircuit docs in the system prompt", async () => { + globalThis.fetch = (async (input: RequestInfo | URL) => { + const url = input.toString() + + if (url === "https://docs.tscircuit.com/ai.txt") { + return new Response("Generated docs marker", { status: 200 }) + } + + if ( + url === + "https://raw.githubusercontent.com/tscircuit/props/main/generated/COMPONENT_TYPES.md" + ) { + return new Response("# Components\n\n", { status: 200 }) + } + + throw new Error(`Unexpected URL: ${url}`) + }) as typeof fetch + + const prompt = await createLocalCircuitPrompt() + + expect(prompt).toContain("## Generated tscircuit documentation") + expect(prompt).toContain("Generated docs marker") + }) + + it("still creates a prompt when generated docs are unavailable", async () => { + globalThis.fetch = (async (input: RequestInfo | URL) => { + const url = input.toString() + + if (url === "https://docs.tscircuit.com/ai.txt") { + return new Response("Unavailable", { + status: 503, + statusText: "Service Unavailable", + }) + } + + if ( + url === + "https://raw.githubusercontent.com/tscircuit/props/main/generated/COMPONENT_TYPES.md" + ) { + return new Response("# Components\n\n", { status: 200 }) + } + + throw new Error(`Unexpected URL: ${url}`) + }) as typeof fetch + + const prompt = await createLocalCircuitPrompt() + + expect(prompt).toContain("## Generated tscircuit documentation") + expect(prompt).toContain("## tscircuit API overview") + }) +}) diff --git a/tests/tscircuitCoder.test.ts b/tests/tscircuitCoder.test.ts index d66c022..504cc78 100644 --- a/tests/tscircuitCoder.test.ts +++ b/tests/tscircuitCoder.test.ts @@ -1,8 +1,10 @@ -import { createTscircuitCoder } from "lib/tscircuit-coder/tscircuitCoder" import { expect, test } from "bun:test" +import { createTscircuitCoder } from "lib/tscircuit-coder/tscircuitCoder" import { getPrimarySourceCodeFromVfs } from "lib/utils/get-primary-source-code-from-vfs" -test("TscircuitCoder submitPrompt streams and updates vfs", async () => { +const openAiTest = process.env.OPENAI_API_KEY ? test : test.skip + +openAiTest("TscircuitCoder submitPrompt streams and updates vfs", async () => { const streamedChunks: string[] = [] let vfsUpdated = false const tscircuitCoder = createTscircuitCoder() @@ -21,14 +23,14 @@ test("TscircuitCoder submitPrompt streams and updates vfs", async () => { prompt: "add a transistor component", }) - let codeWithTransistor = getPrimarySourceCodeFromVfs(tscircuitCoder.vfs) + const codeWithTransistor = getPrimarySourceCodeFromVfs(tscircuitCoder.vfs) expect(codeWithTransistor).toInclude("transistor") await tscircuitCoder.submitPrompt({ prompt: "add a tssop20 chip", }) - let codeWithChip = getPrimarySourceCodeFromVfs(tscircuitCoder.vfs) + const codeWithChip = getPrimarySourceCodeFromVfs(tscircuitCoder.vfs) expect(codeWithChip).toInclude("tssop20") expect(codeWithChip).toInclude("transistor") diff --git a/tests/utils/generate-random-prompts.test.ts b/tests/utils/generate-random-prompts.test.ts index 41a061c..4b8b6e9 100644 --- a/tests/utils/generate-random-prompts.test.ts +++ b/tests/utils/generate-random-prompts.test.ts @@ -1,8 +1,10 @@ -import { describe, it, expect } from "bun:test" +import { describe, expect, it } from "bun:test" import { generateRandomPrompts } from "../../lib/utils/generate-random-prompts" describe("generateRandomPrompts", () => { - it("should return an array of prompts", async () => { + const openAiIt = process.env.OPENAI_API_KEY ? it : it.skip + + openAiIt("should return an array of prompts", async () => { const prompts = await generateRandomPrompts(3) expect(Array.isArray(prompts)).toBe(true)