@tscircuit/cli 0.0.145 → 0.0.162

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"
@@ -51,7 +51,7 @@ export const startEditEventWatcher = async (
             )
 
             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...`))
 

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 (
   {

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) => {

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

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,7 +2,7 @@ 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 },

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

@@ -167,7 +167,7 @@ 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}>

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"

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"

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

@@ -4,7 +4,7 @@ import { AppContext } from "../../util/app-context"
 import * as Path from "path"
 import * as fs from "fs/promises"
 import { existsSync, readFileSync } from "fs"
-import { getAllPackageFiles } from "lib/util/get-all-package-files"
+import { getAllPackageFiles } from "cli/lib/util/get-all-package-files"
 import prompts from "prompts"
 import { getGeneratedReadme } from "../init/get-generated-readme"
 import { soupify } from "../../soupify"

package/{lib → cli/lib}/cmd-fns/remove.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/cli/lib/cmd-fns/render.ts

@@ -0,0 +1,45 @@
+import { circuitToPng } from "circuit-to-png"
+import fs from "fs"
+import { soupify } from "cli/lib/soupify"
+import type { AppContext } from "cli/lib/util/app-context"
+import path from "path"
+
+export const renderCmd = async (
+  ctx: AppContext,
+  args: {
+    input: string
+    pcb?: boolean
+    schematic?: boolean
+    output?: string
+    type?: string
+  },
+) => {
+  const inputFile = path.resolve(args.input)
+  let outputFile = args.output
+  const outputType =
+    args.type || path.extname(args.output || "").slice(1) || "png"
+
+  if (!outputFile) {
+    const inputBase = path.basename(inputFile, path.extname(inputFile))
+    outputFile = `${inputBase}.${outputType}`
+  }
+
+  if (!args.pcb && !args.schematic) {
+    console.error("Error: You must specify either --pcb or --schematic")
+    process.exit(1)
+  }
+
+  const viewType = args.pcb ? "pcb" : "schematic"
+
+  console.log(`Rendering ${viewType} view of ${inputFile} to ${outputFile}`)
+  const soup = await soupify(
+    {
+      filePath: inputFile,
+    },
+    ctx,
+  )
+
+  const soupBuffer = circuitToPng(soup, viewType)
+
+  fs.writeFileSync(outputFile, soupBuffer)
+}

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

@@ -2,7 +2,7 @@ import { AppContext } from "../util/app-context"
 import { z } from "zod"
 import * as Path from "path"
 import { unlink } from "node:fs/promises"
-import { soupify } from "lib/soupify"
+import { soupify } from "cli/lib/soupify"
 import { writeFileSync } from "fs"
 
 export const soupifyCmd = async (ctx: AppContext, args: any) => {

package/{lib → cli/lib}/cmd-fns/uninstall.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/version.ts

@@ -1,6 +1,5 @@
-import { AppContext } from "lib/util/app-context"
-import cliPackageJson from "./../../package.json"
-import frontendPackageJson from "dev-server-frontend/package.json"
+import type { AppContext } from "cli/lib/util/app-context"
+import cliPackageJson from "package.json"
 
 export const versionCmd = async (ctx: AppContext, args: any) => {
   if (typeof global !== "undefined" && (global as any).TSCIRCUIT_VERSION) {
@@ -13,19 +12,19 @@ export const versionCmd = async (ctx: AppContext, args: any) => {
   table.push({ name: "@tscircuit/cli", current: cliPackageJson.version })
   table.push({
     name: "@tscircuit/react-fiber",
-    current: cliPackageJson.dependencies["@tscircuit/react-fiber"],
+    current: cliPackageJson.devDependencies["@tscircuit/react-fiber"],
   })
   table.push({
     name: "@tscircuit/schematic-viewer",
-    current: frontendPackageJson.dependencies["@tscircuit/schematic-viewer"],
+    current: cliPackageJson.devDependencies["@tscircuit/schematic-viewer"],
   })
   table.push({
     name: "@tscircuit/pcb-viewer",
-    current: frontendPackageJson.dependencies["@tscircuit/pcb-viewer"],
+    current: cliPackageJson.devDependencies["@tscircuit/pcb-viewer"],
   })
   table.push({
     name: "@tscircuit/builder",
-    current: cliPackageJson.dependencies["@tscircuit/builder"],
+    current: cliPackageJson.devDependencies["@tscircuit/builder"],
   })
 
   if (args.showLatest) {

package/{lib → cli/lib}/export-fns/export-bom-csv.ts

@@ -1,5 +1,5 @@
 import { AppContext } from "../util/app-context"
-import { soupify } from "lib/soupify"
+import { soupify } from "cli/lib/soupify"
 import { convertSoupToBomRows, convertBomRowsToCsv } from "@tscircuit/builder"
 import kleur from "kleur"
 

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

@@ -2,7 +2,7 @@ import { AppContext } from "../util/app-context"
 import { z } from "zod"
 import * as Path from "path"
 import { unlink } from "node:fs/promises"
-import { soupify } from "lib/soupify"
+import { soupify } from "cli/lib/soupify"
 import * as fs from "fs"
 import {
   stringifyGerberCommandLayers,

package/{lib → cli/lib}/export-fns/export-pnp-csv.ts

@@ -2,7 +2,7 @@ import { AppContext } from "../util/app-context"
 import { z } from "zod"
 import * as Path from "path"
 import { unlink } from "node:fs/promises"
-import { soupify } from "lib/soupify"
+import { soupify } from "cli/lib/soupify"
 import * as fs from "fs"
 import {
   stringifyGerberCommandLayers,

package/{lib → cli/lib}/get-program.ts

@@ -1,7 +1,6 @@
 import { Command } from "commander"
-import packageJson from "../package.json"
-import { AppContext } from "./util/app-context"
-import * as CMDFN from "lib/cmd-fns"
+import * as CMDFN from "cli/lib/cmd-fns"
+import type { AppContext } from "./util/app-context"
 
 export const getProgram = (ctx: AppContext) => {
   const cmd = new Command("tsci").description(
@@ -52,6 +51,21 @@ export const getProgram = (ctx: AppContext) => {
     .option("--fix", "Automatically fix problems")
     .action((args) => CMDFN.lint(ctx, args))
 
+  cmd
+    .command("go")
+    .description("Open browser to the TSCircuit Get Started tutorial")
+    .action((args) => CMDFN.go(ctx, args))
+
+  cmd
+    .command("render")
+    .description("Render circuit as image")
+    .requiredOption("--input <input>", "Input TypeScript file path")
+    .option("--pcb", "Render PCB view")
+    .option("--schematic", "Render schematic view")
+    .option("--output <output>", "Output file path")
+    .option("-t, --type <type>", "Output file type (png or svg)")
+    .action((args) => CMDFN.render(ctx, args))
+
   const authCmd = cmd.command("auth").description("Login/logout")
   authCmd
     .command("login")
@@ -327,7 +341,9 @@ export const getProgram = (ctx: AppContext) => {
 
   function recursiveUnhelp(cmd: Command) {
     cmd.helpCommand(false)
-    cmd.commands.forEach((c) => recursiveUnhelp(c))
+    for (const c of cmd.commands) {
+      recursiveUnhelp(c)
+    }
   }
   recursiveUnhelp(cmd)
 

package/{lib → cli/lib}/param-handlers/param-handler-type.ts

@@ -1,4 +1,4 @@
-import { AppContext } from "lib/util/app-context"
+import { AppContext } from "cli/lib/util/app-context"
 import prompts from "prompts"
 
 export type ParamHandler = (params: {

package/{lib → cli/lib}/util/app-context.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from "axios"
 import Configstore from "configstore"
-import { ContextConfigProps } from "lib/create-config-manager"
+import { ContextConfigProps } from "cli/lib/create-config-manager"
 
 export type AppContext = {
   args: any

package/{lib → cli/lib}/util/create-context-and-run-program.ts

@@ -1,5 +1,5 @@
 import Configstore from "configstore"
-import { AppContext } from "./app-context"
+import type { AppContext } from "./app-context"
 import minimist from "minimist"
 import _ from "lodash"
 import prompts from "prompts"
@@ -7,10 +7,10 @@ import { perfectCli } from "perfect-cli"
 import { getProgram } from "../get-program"
 import defaultAxios from "axios"
 import kleur from "kleur"
-import { PARAM_HANDLERS_BY_PARAM_NAME } from "lib/param-handlers"
-import { createConfigHandler } from "lib/create-config-manager"
+import { PARAM_HANDLERS_BY_PARAM_NAME } from "cli/lib/param-handlers"
+import { createConfigHandler } from "cli/lib/create-config-manager"
 import dargs from "dargs"
-import { versionCmd } from "lib/cmd-fns/version"
+import { versionCmd } from "cli/lib/cmd-fns/version"
 
 export type CliArgs = {
   cmd: string[]

package/{lib → cli/lib}/util/get-all-package-files.ts

@@ -56,7 +56,7 @@ const ensureNodeModulesIgnored = async () => {
     if (!gitignore.includes("node_modules/")) {
       await fs.appendFile(gitignorePath, "\nnode_modules/\n")
     }
-  } catch (err) {
+  } catch (err: any) {
     if (err.code === "ENOENT") {
       await fs.writeFile(gitignorePath, "node_modules/\n")
     } else {

package/{tests → cli/tests}/open.test.ts

@@ -1,7 +1,8 @@
 import { test, expect } from "bun:test"
 import { $ } from "bun"
 
-test("tsci open", async () => {
+// This test annoyingly opens a browser window, unskip if you're testing it
+test.skip("tsci open", async () => {
   const result = await $`bun cli.ts open -y --cwd ./example-project`.text()
   expect(result).toContain("http")
   expect(result).toContain("example-project")

package/{tests → cli/tests}/soupify.test.ts

@@ -3,7 +3,7 @@ import { $ } from "bun"
 
 test("soupify", async () => {
   const result =
-    await $`bun cli.ts soupify -y --file ./example-project/examples/basic-bug.tsx`.text()
+    await $`bun cli/cli.ts soupify -y --file ./example-project/examples/basic-chip.tsx`.text()
 
   expect(result).toContain("10kohm")
 })