Add bom_csv in command line as per #183

cli/lib/cmd-fns/export-bom-csv.ts

@@ -0,0 +1,32 @@
+import fs from "fs/promises"
+import kleur from "kleur"
+import { z } from "zod"
+import { exportBomCsvToBuffer } from "../export-fns/export-bom-csv"
+import { AppContext } from "../util/app-context"
+
+export const exportBomCsv = async (ctx: AppContext, args: any) => {
+  const params = z
+    .object({
+      input: z.string(),
+      export: z.string().optional(),
+      outputfile: z.string().default("bom.csv"),
+    })
+    .refine((data) => data.input, {
+      message: "'input' must be provided",
+    })
+    .parse(args)
+
+  const bomCsvBuffer = await exportBomCsvToBuffer(
+    {
+      example_file_path: params.input!,
+      export_name: params.export,
+    },
+    ctx,
+  )
+
+  console.log(kleur.gray(`[writing to ${params.outputfile}]...`))
+  await fs.writeFile(params.outputfile, bomCsvBuffer)
+  console.log(
+    kleur.green(`Bill of Material CSV file exported to ${params.outputfile}`),
+  )
+}

cli/lib/cmd-fns/index.ts

@@ -44,3 +44,4 @@ export { devServerFulfillExportRequests } from "./dev-server-fulfill-export-requ
 export { lintCmd as lint } from "./lint"
 export { renderCmd as render } from "./render"
 export { genJlcpcbComponent } from "./gen-jlcpcb-component"
+export { exportBomCsv } from "./export-bom-csv"

cli/lib/get-program.ts

@@ -1,5 +1,5 @@
-import { Command } from "commander"
 import * as CMDFN from "cli/lib/cmd-fns"
+import { Command } from "commander"
 import type { AppContext } from "./util/app-context"
 
 export const getProgram = (ctx: AppContext) => {
@@ -323,6 +323,17 @@ export const getProgram = (ctx: AppContext) => {
     .option("--outputfile <outputfile>", "Output file name", "pnp.csv")
     .action((args) => CMDFN.exportPnpCsv(ctx, args))
 
+  exportCmd
+    .command("bom_csv")
+    .description("Export BOM CSV file from an example file")
+    .option("--input <input>", "Input example file")
+    .option(
+      "--export <export_name>",
+      "Name of export to soupify, if not specified, soupify the default/only export",
+    )
+    .option("--outputfile <outputfile>", "Output file name", "bom.csv")
+    .action((args) => CMDFN.exportBomCsv(ctx, args))
+
   cmd
     .command("soupify")
     .description("Convert an example file to tscircuit soup")

cli/tests/export-bom-csv.test.ts

@@ -0,0 +1,24 @@
+import { expect, test } from "bun:test"
+import { existsSync, readFileSync } from "fs"
+import { $ } from "bun"
+import { join } from "path/posix"
+import { temporaryDirectory } from "tempy"
+
+test("tsci export bom_csv --input example-project/examples/macrokeypad.tsx", async () => {
+  const tempDir = temporaryDirectory()
+  const bomCsvPath = join(tempDir, "bom.csv")
+  const { stdout, stderr } =
+    await $`bun cli/cli.ts export bom_csv --input example-project/examples/macrokeypad.tsx --outputfile ${bomCsvPath} --no-color`
+
+  expect(stderr.toString()).toBe("")
+  expect(stdout.toString()).toContain("bom.csv")
+
+  expect(existsSync(bomCsvPath)).toBe(true)
+
+  const bomCsvContent = readFileSync(bomCsvPath, "utf-8")
+  expect(bomCsvContent).toContain("Designator")
+  expect(bomCsvContent).toContain("Comment")
+  expect(bomCsvContent).toContain("Value")
+  expect(bomCsvContent).toContain("Footprint")
+  expect(bomCsvContent).toContain("JLCPCB Part#")
+})