@tscircuit/cli 0.0.144 → 0.0.161

package/{lib → cli/lib}/cmd-fns/dev/start-edit-event-watcher.ts

@@ -1,7 +1,7 @@
-import { DevPackageExample } from "@server/db/get-db"
-import { AxiosInstance } from "axios"
+import type { DevPackageExample } from "api/db/schema"
+import type { AxiosInstance } from "axios"
 import kleur from "kleur"
-import { AppContext } from "lib/util/app-context"
+import { AppContext } from "cli/lib/util/app-context"
 import fg from "fast-glob"
 import fs from "fs"
 import { Project, ts } from "ts-morph"
@@ -18,10 +18,9 @@ export const startEditEventWatcher = async (
   }: {
     devServerAxios: AxiosInstance
   },
-  ctx: AppContext
+  ctx: AppContext,
 ) => {
   let running = true
-
   ;(async () => {
     let last_edit_event_update_time: Record<string, string> = {}
 
@@ -44,15 +43,15 @@ export const startEditEventWatcher = async (
           ) {
             console.log(
               kleur.gray(
-                `Edit event detected for dev_package_example ${dev_package_example.dev_package_example_id}`
-              )
+                `Edit event detected for dev_package_example ${dev_package_example.dev_package_example_id}`,
+              ),
             )
             console.log(
-              kleur.gray(`  file_path: ${dev_package_example.file_path}`)
+              kleur.gray(`  file_path: ${dev_package_example.file_path}`),
             )
 
             last_edit_event_update_time[dev_package_example_id] =
-              dev_package_example.edit_events_last_updated_at // TODO last_edit_event_updated_at
+              dev_package_example.edit_events_last_updated_at! // TODO last_edit_event_updated_at
 
             console.log(kleur.gray(`  getting new edit events...`))
 
@@ -68,14 +67,14 @@ export const startEditEventWatcher = async (
               {
                 cwd: ctx.cwd,
                 ignore: ["node_modules"],
-              }
+              },
             )
 
             if (manual_edit_files.length === 0) {
               console.log(
                 kleur.red(
-                  `No manual edit files found in "${ctx.cwd}", please create a file "manual-edits.ts" or "*.manual-edits.ts" to persist manual edits`
-                )
+                  `No manual edit files found in "${ctx.cwd}", please create a file "manual-edits.ts" or "*.manual-edits.ts" to persist manual edits`,
+                ),
               )
               continue
             }
@@ -83,12 +82,12 @@ export const startEditEventWatcher = async (
             if (manual_edit_files.length > 1) {
               console.log(
                 kleur.red(
-                  `Multiple manual edit files found, tsci currently doesn't know how to handle this, you should go upvote an issue`
-                )
+                  `Multiple manual edit files found, tsci currently doesn't know how to handle this, you should go upvote an issue`,
+                ),
               )
               for (let i = 0; i < manual_edit_files.length; i++) {
                 console.log(
-                  kleur.gray(`  file ${i + 1}: ${manual_edit_files[i]}`)
+                  kleur.gray(`  file ${i + 1}: ${manual_edit_files[i]}`),
                 )
               }
               continue
@@ -97,11 +96,11 @@ export const startEditEventWatcher = async (
             const manual_edit_file = manual_edit_files[0]
             const manual_edit_file_content = fs.readFileSync(
               Path.join(ctx.cwd, manual_edit_file),
-              "utf-8"
+              "utf-8",
             )
 
             console.log(
-              kleur.gray(`  found manual edit file: ${manual_edit_file}`)
+              kleur.gray(`  found manual edit file: ${manual_edit_file}`),
             )
 
             // 2. Convert the edit events into ManualPcbPosition[] and append,
@@ -118,7 +117,7 @@ export const startEditEventWatcher = async (
 
             const ts_manual_edits_file = project.createSourceFile(
               "manual-edits.ts",
-              manual_edit_file_content
+              manual_edit_file_content,
             )
 
             // Access the default export declaration
@@ -129,7 +128,7 @@ export const startEditEventWatcher = async (
             // Get the object literal expression from the export default statement
             const object_literal =
               default_export_dec.getFirstChildByKindOrThrow(
-                ts.SyntaxKind.ObjectLiteralExpression
+                ts.SyntaxKind.ObjectLiteralExpression,
               )
 
             // Get the `pcb_placements` property
@@ -164,25 +163,25 @@ export const startEditEventWatcher = async (
             let manual_trace_hints: ManualTraceHint[]
             try {
               pcb_placements = JSON5.parse(
-                pcb_placements_ts.getText().replace(/pcb_placements:\s/, "")
+                pcb_placements_ts.getText().replace(/pcb_placements:\s/, ""),
               )
             } catch (e: any) {
               console.log(
                 kleur.red(
-                  `Error parsing pcb_placements from manual edits file: ${pcb_placements_ts.getText()} ${e.toString()}`
-                )
+                  `Error parsing pcb_placements from manual edits file: ${pcb_placements_ts.getText()} ${e.toString()}`,
+                ),
               )
               continue
             }
             try {
               in_file_edit_events = JSON5.parse(
-                edit_events_ts.getText().replace(/edit_events:\s/, "")
+                edit_events_ts.getText().replace(/edit_events:\s/, ""),
               )
             } catch (e: any) {
               console.log(
                 kleur.red(
-                  `Error parsing edit_events from manual edits file: ${edit_events_ts.getText()} ${e.toString()}`
-                )
+                  `Error parsing edit_events from manual edits file: ${edit_events_ts.getText()} ${e.toString()}`,
+                ),
               )
               continue
             }
@@ -190,13 +189,13 @@ export const startEditEventWatcher = async (
               manual_trace_hints = JSON5.parse(
                 manual_trace_hints_ts
                   .getText()
-                  .replace(/manual_trace_hints:\s/, "")
+                  .replace(/manual_trace_hints:\s/, ""),
               )
             } catch (e: any) {
               console.log(
                 kleur.red(
-                  `Error parsing manual_trace_hints from manual edits file: ${pcb_placements_ts.getText()} ${e.toString()}`
-                )
+                  `Error parsing manual_trace_hints from manual edits file: ${pcb_placements_ts.getText()} ${e.toString()}`,
+                ),
               )
               continue
             }
@@ -204,7 +203,7 @@ export const startEditEventWatcher = async (
             const handled_edit_events = new Set<string>(
               pcb_placements
                 .map((p) => (p as any)._edit_event_id)
-                .concat(in_file_edit_events.map((a) => a.edit_event_id))
+                .concat(in_file_edit_events.map((a) => a.edit_event_id)),
             )
 
             // Add PCB placements from edit events
@@ -229,14 +228,14 @@ export const startEditEventWatcher = async (
                 if (!pcb_component_selector) continue
 
                 const existing_placement_for_selector = pcb_placements.find(
-                  (pp) => pp.selector === pcb_component_selector
+                  (pp) => pp.selector === pcb_component_selector,
                 )
 
                 if (!existing_placement_for_selector) {
                   console.log(
                     kleur.gray(
-                      `  adding PCB placement from edit event for "${pcb_component_selector}"`
-                    )
+                      `  adding PCB placement from edit event for "${pcb_component_selector}"`,
+                    ),
                   )
 
                   pcb_placements.push({
@@ -255,14 +254,14 @@ export const startEditEventWatcher = async (
                   `pcb_placements: ${JSON.stringify(
                     pcb_placements,
                     null,
-                    "  "
-                  )}`
+                    "  ",
+                  )}`,
                 )
 
                 // Save the file
                 fs.writeFileSync(
                   Path.join(ctx.cwd, manual_edit_file),
-                  ts_manual_edits_file.getFullText()
+                  ts_manual_edits_file.getFullText(),
                 )
                 await devServerAxios.post("/api/dev_package_examples/update", {
                   dev_package_example_id,
@@ -274,7 +273,7 @@ export const startEditEventWatcher = async (
               ) {
                 const new_trace_hint = getManualTraceHintFromEvent(
                   dev_package_example_full.tscircuit_soup,
-                  incoming_edit_event
+                  incoming_edit_event,
                 )
 
                 manual_trace_hints_ts.replaceWithText(
@@ -283,17 +282,17 @@ export const startEditEventWatcher = async (
                       .filter(
                         (th) =>
                           th.pcb_port_selector !==
-                          new_trace_hint.pcb_port_selector
+                          new_trace_hint.pcb_port_selector,
                       )
                       .concat([new_trace_hint]),
                     null,
-                    "  "
-                  )}`
+                    "  ",
+                  )}`,
                 )
 
                 fs.writeFileSync(
                   Path.join(ctx.cwd, manual_edit_file),
-                  ts_manual_edits_file.getFullText()
+                  ts_manual_edits_file.getFullText(),
                 )
                 await devServerAxios.post("/api/dev_package_examples/update", {
                   dev_package_example_id,
@@ -304,12 +303,12 @@ export const startEditEventWatcher = async (
                 // All other events just go to the manual-edits.ts file with
                 // in the "edit_events" property
                 edit_events_ts.replaceWithText(
-                  `edit_events: ${JSON.stringify(edit_events, null, "  ")}`
+                  `edit_events: ${JSON.stringify(edit_events, null, "  ")}`,
                 )
                 console.log(edit_events_ts.getFullText())
                 fs.writeFileSync(
                   Path.join(ctx.cwd, manual_edit_file),
-                  ts_manual_edits_file.getFullText()
+                  ts_manual_edits_file.getFullText(),
                 )
                 await devServerAxios.post("/api/dev_package_examples/update", {
                   dev_package_example_id,

package/{lib → cli/lib}/cmd-fns/dev/start-export-request-watcher.ts

@@ -1,7 +1,7 @@
 import { AxiosInstance } from "axios"
 import kleur from "kleur"
 import { fulfillExportRequests } from "./fulfill-export-requests"
-import { AppContext } from "lib/util/app-context"
+import { AppContext } from "cli/lib/util/app-context"
 
 export const startExportRequestWatcher = async (
   {
@@ -9,17 +9,16 @@ export const startExportRequestWatcher = async (
   }: {
     devServerAxios: AxiosInstance
   },
-  ctx: AppContext
+  ctx: AppContext,
 ) => {
   let running = true
-
   ;(async () => {
     while (running) {
       try {
         await fulfillExportRequests({ dev_server_axios: devServerAxios }, ctx)
       } catch (err: any) {
         console.log(
-          kleur.red(`Error in export request watcher: ${err.toString()}`)
+          kleur.red(`Error in export request watcher: ${err.toString()}`),
         )
       }
       await new Promise((resolve) => setTimeout(resolve, 1000))

package/{lib → cli/lib}/cmd-fns/dev/start-fs-watcher.ts

@@ -2,6 +2,7 @@ import { AxiosInstance } from "axios"
 import chokidar from "chokidar"
 import { uploadExamplesFromDirectory } from "./upload-examples-from-directory"
 import kleur from "kleur"
+import { AppContext } from "cli/lib/util/app-context"
 
 export const startFsWatcher = async (
   {
@@ -11,7 +12,7 @@ export const startFsWatcher = async (
     cwd: string
     devServerAxios: AxiosInstance
   },
-  ctx: { runtime: "node" | "bun" }
+  ctx: Pick<AppContext, "runtime" | "params">,
 ) => {
   const watcher = chokidar.watch([`${cwd}/**/*.tsx`, `${cwd}/**/*.ts`], {
     ignored: /node_modules/,

package/{lib → cli/lib}/cmd-fns/dev/upload-examples-from-directory.ts

@@ -2,10 +2,11 @@ import kleur from "kleur"
 import { join as joinPath } from "path"
 import { AxiosInstance } from "axios"
 import { readdirSync, readFileSync } from "fs"
-import { soupify } from "lib/soupify"
+import { soupify } from "cli/lib/soupify"
 import { soupifyAndUploadExampleFile } from "./soupify-and-upload-example-file"
 import { markAllExamplesLoading } from "./mark-all-examples-loading"
 import { readdir } from "fs/promises"
+import { AppContext } from "cli/lib/util/app-context"
 
 export const uploadExamplesFromDirectory = async (
   {
@@ -15,7 +16,7 @@ export const uploadExamplesFromDirectory = async (
     cwd: string
     devServerAxios: AxiosInstance
   },
-  ctx: { runtime: "node" | "bun" }
+  ctx: Pick<AppContext, "runtime" | "params">,
 ) => {
   const examplesDir = joinPath(cwd, "examples")
   const exampleFileNames = await readdir(examplesDir).catch((e) => {
@@ -35,7 +36,7 @@ export const uploadExamplesFromDirectory = async (
         examplesDir,
         exampleFileName,
       },
-      ctx
+      ctx,
     )
   }
 }

package/{lib → cli/lib}/cmd-fns/dev-server-fulfill-export-requests.ts

@@ -6,7 +6,7 @@ import { getDevServerAxios } from "./dev/get-dev-server-axios"
 
 export const devServerFulfillExportRequests = async (
   ctx: AppContext,
-  args: any
+  args: any,
 ) => {
   const params = z.object({}).parse(args)
 
@@ -33,8 +33,8 @@ export const devServerFulfillExportRequests = async (
   if (!is_dev_server_healthy) {
     console.log(
       kleur.red(
-        `Dev server doesn't seem to be running at ${server_url}. (Could not ping health)`
-      )
+        `Dev server doesn't seem to be running at ${server_url}. (Could not ping health)`,
+      ),
     )
     process.exit(1)
   }

package/{lib → cli/lib}/cmd-fns/dev-server-upload.ts

@@ -37,8 +37,8 @@ export const devServerUpload = async (ctx: AppContext, args: any) => {
   if (!is_dev_server_healthy) {
     console.log(
       kleur.red(
-        `Dev server doesn't seem to be running at ${serverUrl}. (Could not ping health)`
-      )
+        `Dev server doesn't seem to be running at ${serverUrl}. (Could not ping health)`,
+      ),
     )
     process.exit(1)
   }
@@ -50,7 +50,7 @@ export const devServerUpload = async (ctx: AppContext, args: any) => {
     // Start watcher
     const watcher = await startFsWatcher(
       { cwd: params.dir, devServerAxios },
-      ctx
+      ctx,
     )
   }
 }

package/{lib → cli/lib}/cmd-fns/export-gerbers.ts

@@ -1,6 +1,6 @@
 import { AppContext } from "../util/app-context"
 import { z } from "zod"
-import { exportGerbersToFile } from "lib/export-fns/export-gerbers"
+import { exportGerbersToFile } from "cli/lib/export-fns/export-gerbers"
 
 export const exportGerbersCmd = async (ctx: AppContext, args: any) => {
   const params = z
@@ -17,6 +17,6 @@ export const exportGerbersCmd = async (ctx: AppContext, args: any) => {
       export_name: params.export,
       output_zip_path: params.outputfile,
     },
-    ctx
+    ctx,
   )
 }

package/cli/lib/cmd-fns/go.ts

@@ -0,0 +1,14 @@
+import kleur from "kleur"
+import type { AppContext } from "cli/lib/util/app-context"
+import open from "open"
+
+export const goCmd = async (ctx: AppContext, args: any) => {
+  const tutorialUrl = "https://docs.tscircuit.com/quickstart"
+
+  console.log(
+    kleur.cyan(
+      "Opening the TSCircuit Getting Started tutorial in your browser...",
+    ),
+  )
+  await open(tutorialUrl)
+}

package/{lib → cli/lib}/cmd-fns/index.ts

@@ -29,6 +29,7 @@ export { soupifyCmd as soupify } from "./soupify"
 export { devCmd as dev } from "./dev"
 export { initCmd as init } from "./init"
 export { addCmd as add } from "./add"
+export { goCmd as go } from "./go"
 export { removeCmd as remove } from "./remove"
 export { installCmd as install } from "./install"
 export { uninstallCmd as uninstall } from "./uninstall"
@@ -39,3 +40,4 @@ export { versionCmd as version } from "./version"
 export { exportGerbersCmd as exportGerbers } from "./export-gerbers"
 export { devServerFulfillExportRequests } from "./dev-server-fulfill-export-requests"
 export { lintCmd as lint } from "./lint"
+export { renderCmd as render } from "./render"

package/{lib → cli/lib}/cmd-fns/init/create-or-modify-npmrc.ts

@@ -2,11 +2,11 @@ import { existsSync, writeFileSync } from "fs"
 import kleur from "kleur"
 import * as Path from "path"
 import { getGeneratedNpmrc } from "./get-generated-npmrc"
-import { AppContext } from "lib/util/app-context"
+import { AppContext } from "cli/lib/util/app-context"
 
 export const createOrModifyNpmrc = async (
   { quiet = true }: { quiet?: boolean },
-  ctx: AppContext
+  ctx: AppContext,
 ) => {
   const npmrcPath = Path.join(ctx.cwd, ".npmrc")
 

package/{lib → cli/lib}/cmd-fns/init/get-generated-npmrc.ts

@@ -1,4 +1,4 @@
-import { AppContext } from "lib/util/app-context"
+import { AppContext } from "cli/lib/util/app-context"
 
 export const getGeneratedNpmrc = (ctx: AppContext) =>
   `

package/{lib → cli/lib}/cmd-fns/init/index.ts

@@ -104,10 +104,14 @@ export const initCmd = async (ctx: AppContext, args: any) => {
   writeFileSync("package.json", JSON.stringify(packageJson, null, 2))
 
   console.log(`Adding ".tscircuit" to .gitignore`)
-  appendFileSync(".gitignore", "\n.tscircuit\n*.__tmp_entrypoint.tsx\ndist\nnode_modules\n", {
-    encoding: "utf-8",
-    flag: "a+",
-  })
+  appendFileSync(
+    ".gitignore",
+    "\n.tscircuit\n*.__tmp_entrypoint.tsx\ndist\nnode_modules\n",
+    {
+      encoding: "utf-8",
+      flag: "a+",
+    },
+  )
 
   console.log("Add .npmrc with tscircuit registry...")
   await createOrModifyNpmrc({ quiet: false }, ctx)
@@ -137,7 +141,7 @@ export default {
   // Manual pcb placements, added when you drag a footprint
   pcb_placements: [],
 }
-`.trim()
+`.trim(),
   )
 
   writeFileSync(
@@ -155,7 +159,7 @@ export default {
       />
     </group>
   )
-  `.trim()
+  `.trim(),
   )
 
   writeFileSync("index.ts", `export * from "./lib/MyCircuit"`)
@@ -163,14 +167,14 @@ export default {
   writeFileSync(
     Path.join("examples", "MyExample.tsx"),
     `
-import { MyCircuit } from "lib/MyCircuit"
+import { MyCircuit } from "cli/lib/MyCircuit"
 
 export const MyExample = () => (
   <board width="40mm" height="40mm" pcbCenterX={0} pcbCenterY={0}>
     <MyCircuit />
   </board>
 )
-      `.trim()
+      `.trim(),
   )
 
   // Override the README file
@@ -179,7 +183,7 @@ export const MyExample = () => (
     getGeneratedReadme({
       name: params.name!,
       shouldHaveProjectGeneratedNotice: true,
-    })
+    }),
   )
 
   // Open tsconfig.json and modify it to import the tscircuit types

package/{lib → cli/lib}/cmd-fns/install.ts

@@ -1,5 +1,5 @@
 import kleur from "kleur"
-import { AppContext } from "lib/util/app-context"
+import { AppContext } from "cli/lib/util/app-context"
 import { z } from "zod"
 import { createOrModifyNpmrc } from "./init/create-or-modify-npmrc"
 import $ from "dax-sh"

package/{lib → cli/lib}/cmd-fns/lint.ts

@@ -1,4 +1,4 @@
-import { AppContext } from "lib/util/app-context"
+import { AppContext } from "cli/lib/util/app-context"
 import { z } from "zod"
 import kleur from "kleur"
 import { lintProject } from "../util/lint-project"
@@ -15,23 +15,29 @@ export const lintCmd = async (ctx: AppContext, args: any) => {
 
   console.log(kleur.blue("Running tscircuit linter..."))
 
-  const results = lintProject(cwd, fix);
+  const results = lintProject(cwd, fix)
 
-  let errorCount = 0;
+  let errorCount = 0
   for (const result of results) {
     if (result.messages.length > 0) {
-      console.log(kleur.yellow(`\nFile: ${result.filePath}`));
+      console.log(kleur.yellow(`\nFile: ${result.filePath}`))
       for (const message of result.messages) {
-        console.log(`  Line ${message.line}, Column ${message.column}: ${message.message}`);
-        errorCount++;
+        console.log(
+          `  Line ${message.line}, Column ${message.column}: ${message.message}`,
+        )
+        errorCount++
       }
     }
   }
 
   if (errorCount > 0) {
-    console.log(kleur.yellow(`\nFound ${errorCount} issue${errorCount === 1 ? '' : 's'} in your tscircuit code.`));
-    process.exit(1);
+    console.log(
+      kleur.yellow(
+        `\nFound ${errorCount} issue${errorCount === 1 ? "" : "s"} in your tscircuit code.`,
+      ),
+    )
+    process.exit(1)
   } else {
-    console.log(kleur.green("\nNo tscircuit-specific issues found!"));
+    console.log(kleur.green("\nNo tscircuit-specific issues found!"))
   }
-}
+}

package/{lib → cli/lib}/cmd-fns/open.ts

@@ -1,6 +1,6 @@
 import { existsSync, readFileSync } from "fs"
 import kleur from "kleur"
-import { AppContext } from "lib/util/app-context"
+import { AppContext } from "cli/lib/util/app-context"
 import * as Path from "path"
 import open from "open"
 

package/{lib → cli/lib}/cmd-fns/package-examples-create.ts

@@ -1,4 +1,4 @@
-import { soupify } from "lib/soupify"
+import { soupify } from "cli/lib/soupify"
 import { AppContext } from "../util/app-context"
 import { z } from "zod"
 import fs from "fs"
@@ -17,7 +17,7 @@ export const packageExamplesCreate = async (ctx: AppContext, args: any) => {
       filePath: params.file,
       exportName: params.export,
     },
-    ctx
+    ctx,
   )
 
   const fileContent = await fs.promises.readFile(params.file, "utf8")

package/{lib → cli/lib}/cmd-fns/package-files-create.ts

@@ -26,6 +26,6 @@ export const packageFilesCreate = async (ctx: AppContext, args: any) => {
     .then((r) => r.data.package_file)
 
   console.log(
-    `Package file created ${kleur.gray(package_file.package_file_id)}`
+    `Package file created ${kleur.gray(package_file.package_file_id)}`,
   )
 }

package/{lib → cli/lib}/cmd-fns/package-files-upload-directory.ts

@@ -2,5 +2,5 @@ import { AppContext } from "../util/app-context"
 
 export const packageFilesUploadDirectory = async (
   ctx: AppContext,
-  args: any
+  args: any,
 ) => {}

package/{lib → cli/lib}/cmd-fns/package-releases-create.ts

@@ -30,6 +30,6 @@ export const packageReleasesCreate = async (ctx: AppContext, args: any) => {
     .then((r) => r.data.package_release)
 
   console.log(
-    `Package release created! ${kleur.gray(package_release.package_release_id)}`
+    `Package release created! ${kleur.gray(package_release.package_release_id)}`,
   )
 }

package/{lib → cli/lib}/cmd-fns/package-releases-list.ts

@@ -26,7 +26,7 @@ export const packageReleasesList = async (ctx: AppContext, args: any) => {
     console.log(
       package_releases
         .map((f: any) => `${params.packageName}@${f.version}`)
-        .join("\n")
+        .join("\n"),
     )
   }
 }