@tscircuit/cli 0.0.394 → 0.1.2

package/cli/lib/cmd-fns/export-pnp-csv.ts

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

package/cli/lib/cmd-fns/gen-jlcpcb-component.ts

@@ -1,64 +0,0 @@
-import path from "path"
-import fs from "fs/promises"
-import { AppContext } from "../util/app-context"
-import { convertEasyEdaJsonToVariousFormats } from "easyeda"
-
-export const genJlcpcbComponent = async (
-  ctx: AppContext,
-  { partNumberOrUrl }: { partNumberOrUrl: string },
-): Promise<void> => {
-  try {
-    const resolvedPartNumber = resolvePartNumber(partNumberOrUrl)
-    const outputDir = path.resolve(ctx.cwd, "gen")
-    const outputFile = path.join(outputDir, `${resolvedPartNumber}.tsx`)
-
-    await fs.mkdir(outputDir, { recursive: true })
-
-    await convertEasyEdaJsonToVariousFormats({
-      jlcpcbPartNumberOrFilepath: resolvedPartNumber,
-      outputFilename: outputFile,
-      formatType: "tsx",
-    })
-  } catch (error) {
-    console.error(
-      `Error generating JLCPCB component:`,
-      (error as Error).message,
-    )
-    throw error
-  }
-}
-
-const PART_NUMBER_PREFIX = "C"
-
-const resolvePartNumber = (partNumberOrUrl: string): string => {
-  if (
-    partNumberOrUrl.startsWith("http://") ||
-    partNumberOrUrl.startsWith("https://")
-  ) {
-    const partNumber = extractPartNumberFromUrl(partNumberOrUrl)
-
-    if (!partNumber) {
-      throw new Error("Could not extract a valid part number from URL")
-    }
-
-    return partNumber
-  }
-
-  if (!isValidPartNumber(partNumberOrUrl)) {
-    throw new Error(
-      `Invalid part number: Must start with '${PART_NUMBER_PREFIX}'`,
-    )
-  }
-
-  return partNumberOrUrl.toUpperCase()
-}
-
-const extractPartNumberFromUrl = (url: string): string | null => {
-  const partNumber = url.split("/").at(-1)
-  return partNumber && isValidPartNumber(partNumber)
-    ? partNumber.toUpperCase()
-    : null
-}
-
-const isValidPartNumber = (partNumber: string): boolean =>
-  partNumber.toUpperCase().startsWith(PART_NUMBER_PREFIX)

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

@@ -1,14 +0,0 @@
-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/cli/lib/cmd-fns/index.ts

@@ -1,46 +0,0 @@
-export { configRevealLocation } from "./config-reveal-location"
-export { configSetRegistry } from "./config-set-registry"
-export { configSetSession } from "./config-set-session"
-export { configSetRuntime } from "./config-set-runtime"
-export { configSetLogRequests } from "./config-set-log-requests"
-export { configPrintConfig } from "./config-print-config"
-export { authLogin } from "./auth-login"
-export { authLogout } from "./auth-logout"
-export { authSessionsCreate } from "./auth-sessions-create"
-export { authSessionsList } from "./auth-sessions-list"
-export { authSessionsGet } from "./auth-sessions-get"
-export { packagesList } from "./packages-list"
-export { packagesGet } from "./packages-get"
-export { packagesCreate } from "./packages-create"
-export { packageFilesUploadDirectory } from "./package-files-upload-directory"
-export { packageReleasesList } from "./package-releases-list"
-export { packageReleasesGet } from "./package-releases-get"
-export { packageReleasesCreate } from "./package-releases-create"
-export { packageReleasesUpdate } from "./package-releases-update"
-export { packageFilesList } from "./package-files-list"
-export { packageFilesGet } from "./package-files-get"
-export { packageFilesDownload } from "./package-files-download"
-export { packageFilesCreate } from "./package-files-create"
-export { packageExamplesList } from "./package-examples-list"
-export { packageExamplesGet } from "./package-examples-get"
-export { packageExamplesCreate } from "./package-examples-create"
-export { publish } from "./publish"
-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"
-export { devServerUpload } from "./dev-server-upload"
-export { configClear } from "./config-clear"
-export { openCmd as open } from "./open"
-export { versionCmd as version } from "./version"
-export { exportGerbersCmd as exportGerbers } from "./export-gerbers"
-export { exportPnpCsv } from "./export-pnp-csv"
-export { exportKicadPcb } from "./export-kicad-pcb"
-export { devServerFulfillExportRequests } from "./dev-server-fulfill-export-requests"
-export { lintCmd as lint } from "./lint"
-export { renderCmd as render } from "./render"
-export { genJlcpcbComponent } from "./gen-jlcpcb-component"

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

@@ -1,21 +0,0 @@
-import { existsSync, writeFileSync } from "fs"
-import kleur from "kleur"
-import * as Path from "path/posix"
-import { getGeneratedNpmrc } from "./get-generated-npmrc"
-import { AppContext } from "cli/lib/util/app-context"
-
-export const createOrModifyNpmrc = async (
-  { quiet = true }: { quiet?: boolean },
-  ctx: AppContext,
-) => {
-  const npmrcPath = Path.join(ctx.cwd, ".npmrc")
-
-  if (existsSync(npmrcPath)) {
-    // TODO check that @tsci registry is correctly set
-    if (!quiet) {
-      console.log(kleur.yellow("npmrc already exists, not doing anything"))
-    }
-  } else {
-    writeFileSync(npmrcPath, getGeneratedNpmrc(ctx))
-  }
-}

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

@@ -1,8 +0,0 @@
-import { AppContext } from "cli/lib/util/app-context"
-
-export const getGeneratedNpmrc = (ctx: AppContext) =>
-  `
-
-@tsci:registry=${ctx.registry_url}/npm
-
-`.trim()

package/cli/lib/cmd-fns/init/get-generated-readme.ts

@@ -1,41 +0,0 @@
-export const getGeneratedReadme = ({
-  name,
-  shouldHaveProjectGeneratedNotice = false,
-}: {
-  name: string
-  shouldHaveProjectGeneratedNotice?: boolean
-}) => {
-  return `
-# ${name.split("/").pop()?.split(".").pop()}
-
-[![tscircuit version badge](https://registry-api.tscircuit.com/badges/view?package_name=${name
-    .replace("@tsci/", "")
-    .replace("/", ".")})](https://registry.tscircuit.com/${name
-    .replace("@tsci/", "")
-    .replace(".", "/")})
-
-${
-  shouldHaveProjectGeneratedNotice
-    ? `\n\n> This project was generated using [tsci](https://github.com/tscircuit/tscircuit)\n`
-    : ""
-}
-To develop and view the examples, run \`tsci dev\` and open [http://127.0.0.1:3020](http://127.0.0.1:3020) in your browser.
-
-## Developing
-
-You should install an editor like [VS Code](https://code.visualstudio.com/) with a typescript extension. Many web developers already have this.
-
-Usually, you'll want to develop some named circuits inside of the \`lib\` directory,
-export them in the \`index.ts\` file, then show how to use them in the \`examples\` directory.
-
-Any file in \`examples\` will be automatically loaded and appear in the browser preview when you run \`tsci dev\`. It auto-reloads when you make changes, no need to reload the page or re-run the command.
-
-> [!TIP] Make sure to replace this README with some details about your project and how to use it.
-
-## Publishing
-
-After you're satisfied with your project, publish it on the [tscircuit registry](https://registry.tscircuit.com) with \`tsci publish\`
-  
-  
-`.trim()
-}

package/cli/lib/cmd-fns/init/get-generated-tsconfig.ts

@@ -1,34 +0,0 @@
-export const getGeneratedTsconfig = () =>
-  `
-
-{
-  "compilerOptions": {
-    // Enable latest features
-    "lib": ["ESNext"],
-    "target": "ESNext",
-    "module": "ESNext",
-    "moduleDetection": "force",
-    "jsx": "react-jsx",
-    "allowJs": true,
-    "types": ["@tscircuit/react-fiber"],
-    "baseUrl": ".",
-
-    // Bundler mode
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "noEmit": true,
-
-    // Best practices
-    "strict": true,
-    "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
-
-    // Some stricter flags (disabled by default)
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false
-  }
-}
-
-`.trim()

package/cli/lib/cmd-fns/init/index.ts

@@ -1,193 +0,0 @@
-import { AppContext } from "../../util/app-context"
-import { z } from "zod"
-import {
-  readFileSync,
-  writeFileSync,
-  existsSync,
-  mkdirSync,
-  writeFile,
-  appendFileSync,
-} from "fs"
-import * as Path from "node:path/posix"
-import $ from "dax-sh"
-import { getGeneratedReadme } from "./get-generated-readme"
-import { getGeneratedTsconfig } from "./get-generated-tsconfig"
-import { getGeneratedNpmrc } from "./get-generated-npmrc"
-import { createOrModifyNpmrc } from "./create-or-modify-npmrc"
-import prompts from "prompts"
-
-export const initCmd = async (ctx: AppContext, args: any) => {
-  const params = z
-    .object({
-      name: z.string().optional(),
-      dir: z.string().optional(),
-      runtime: z.enum(["bun", "node"]).optional(),
-    })
-    .parse(args)
-
-  if (params.name && !params.dir) {
-    params.dir = `./${params.name.split("/").pop()}`
-  } else if (!params.dir) {
-    params.dir = `.`
-  }
-
-  if (!params.name) {
-    try {
-      const myAccount = await ctx.axios
-        .get("/accounts/get")
-        .then((r) => r.data.account)
-      let subName = Path.basename(params.dir)
-      if (subName === ".") {
-        subName = Path.basename(Path.resolve(params.dir))
-      }
-      params.name = `@tsci/${myAccount.github_username}.${subName}`
-    } catch (e: any) {
-      const { github_username, package_name } = await prompts([
-        { type: "text", name: "github_username", message: "GitHub username" },
-        { type: "text", name: "package_name", message: "Package name" },
-      ])
-      params.name = `@tsci/${github_username}.${package_name}`
-    }
-  }
-
-  let runtime = params.runtime ?? ctx.runtime
-  if (!runtime) {
-    const bunExists = $.commandExistsSync("bun")
-
-    if (bunExists) {
-      runtime = "bun"
-    } else {
-      runtime = "node"
-    }
-  }
-
-  const pkm = runtime === "bun" ? "bun" : "npm"
-  const runner = runtime === "bun" ? "bun" : "tsx"
-
-  const packageJsonExists = existsSync(Path.join(params.dir, "package.json"))
-  const dirExists = existsSync(params.dir)
-
-  if (!dirExists) {
-    console.log(`Creating directory ${params.dir}`)
-    mkdirSync(params.dir, { recursive: true })
-  }
-
-  process.chdir(params.dir)
-  if (!packageJsonExists) {
-    console.log(`Initializing ${pkm} project...`)
-    await $`${pkm} init -y`
-  }
-
-  if (runtime !== "bun") {
-    console.log(`Setting up project for typescript...`)
-    await $`${pkm} add -D typescript tsx`
-  }
-
-  // TODO just allow adding "tscircuit" in the future
-  await $`${pkm} add -D tscircuit`
-
-  console.log("Changing package name...")
-  // Change package.json "name" to params.name
-  const packageJson = JSON.parse(readFileSync("package.json", "utf-8"))
-  packageJson.name = params.name
-  writeFileSync("package.json", JSON.stringify(packageJson, null, 2))
-
-  console.log('Changing adding "start" and "dev" scripts...')
-  packageJson.scripts ??= {}
-  packageJson.scripts.start = "npm run dev"
-  packageJson.scripts.dev = "tsci dev"
-  packageJson.scripts.build = "tsup ./index.ts --sourcemap --dts"
-  writeFileSync("package.json", JSON.stringify(packageJson, null, 2))
-
-  console.log('Making package type: "module"...')
-  packageJson.type = "module"
-  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+",
-    },
-  )
-
-  console.log("Add .npmrc with tscircuit registry...")
-  await createOrModifyNpmrc({ quiet: false }, ctx)
-
-  console.log("Creating lib and examples directories...")
-  mkdirSync("examples", { recursive: true })
-  mkdirSync("lib", { recursive: true })
-
-  writeFileSync(
-    Path.join("lib", "MyCircuit.manual-edits.ts"),
-    `
-/**
- * DO NOT EDIT THIS FILE DIRECTLY!
- *
- * This file is automatically edited when running \`tsci dev\` and dragging things
- * around. \`tsci dev\` searches for a file named "*.manual-edits.ts" and edits
- * it when you e.g. move a footprint. If there are multiple files, it'll try
- * to pick one based on context or ask.
- *
- * If you're not running \`tsci dev\`, you can safely edit this file.
- */
-export default {
-  // Generated when this file is created, this unique identifier is used to help
-  // determine which file to edit when there are many *.manual-edits.ts files
-  manual_edit_id: "abcdef",
-
-  // Manual pcb placements, added when you drag a footprint
-  pcb_placements: [],
-}
-`.trim(),
-  )
-
-  writeFileSync(
-    Path.join("lib", "MyCircuit.tsx"),
-    `
-  import { layout } from "tscircuit"
-  import manual_edits from "./MyCircuit.manual-edits"
-
-  export const MyCircuit = () => (
-    <group layout={layout().manualEdits(manual_edits)}>
-      <resistor
-        resistance="10kohm"
-        name="R1"
-        footprint="0805"
-      />
-    </group>
-  )
-  `.trim(),
-  )
-
-  writeFileSync("index.ts", `export * from "./lib/MyCircuit"`)
-
-  writeFileSync(
-    Path.join("examples", "MyExample.tsx"),
-    `
-import { MyCircuit } from "lib/MyCircuit"
-
-export const MyExample = () => (
-  <board width="40mm" height="40mm" pcbCenterX={0} pcbCenterY={0}>
-    <MyCircuit />
-  </board>
-)
-      `.trim(),
-  )
-
-  // Override the README file
-  writeFileSync(
-    "README.md",
-    getGeneratedReadme({
-      name: params.name!,
-      shouldHaveProjectGeneratedNotice: true,
-    }),
-  )
-
-  // Open tsconfig.json and modify it to import the tscircuit types
-  writeFileSync("tsconfig.json", getGeneratedTsconfig())
-
-  console.log("Done! Run `tsci dev` to start developing!")
-}

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

@@ -1,34 +0,0 @@
-import kleur from "kleur"
-import { AppContext } from "cli/lib/util/app-context"
-import { z } from "zod"
-import { createOrModifyNpmrc } from "./init/create-or-modify-npmrc"
-import $ from "dax-sh"
-
-export const installCmd = async (ctx: AppContext, args: any) => {
-  const params = z
-    .object({
-      packages: z.array(z.string()),
-      flags: z
-        .object({ dev: z.boolean().optional().default(false) })
-        .optional()
-        .default({}),
-    })
-    .parse(args)
-
-  params.packages = params.packages.map((p) => p.replace(/^@/, ""))
-
-  await createOrModifyNpmrc({ quiet: true }, ctx)
-
-  $.cd(ctx.cwd)
-
-  const flagsString = params.flags.dev ? "--dev" : ""
-
-  const cmd = `npm install ${flagsString} ${params.packages
-    .map((p) => `@tsci/${p.replace(/\//, ".")}`)
-    .join(" ")}`
-  console.log(kleur.gray(`> ${cmd}`))
-
-  await $`npm install ${flagsString} ${params.packages
-    .map((p) => `@tsci/${p.replace(/\//, ".")}`)
-    .join(" ")}`
-}

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

@@ -1,43 +0,0 @@
-import { AppContext } from "cli/lib/util/app-context"
-import { z } from "zod"
-import kleur from "kleur"
-import { lintProject } from "../util/lint-project"
-
-export const lintCmd = async (ctx: AppContext, args: any) => {
-  const params = z
-    .object({
-      fix: z.boolean().optional().default(false),
-    })
-    .parse(args)
-
-  const { cwd } = ctx
-  const { fix } = params
-
-  console.log(kleur.blue("Running tscircuit linter..."))
-
-  const results = lintProject(cwd, fix)
-
-  let errorCount = 0
-  for (const result of results) {
-    if (result.messages.length > 0) {
-      console.log(kleur.yellow(`\nFile: ${result.filePath}`))
-      for (const message of result.messages) {
-        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)
-  } else {
-    console.log(kleur.green("\nNo tscircuit-specific issues found!"))
-  }
-}

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

@@ -1,19 +0,0 @@
-import { existsSync, readFileSync } from "fs"
-import kleur from "kleur"
-import { AppContext } from "cli/lib/util/app-context"
-import * as Path from "path/posix"
-import open from "open"
-
-export const openCmd = async (ctx: AppContext, args: any) => {
-  const packageJsonPath = Path.join(ctx.cwd, "package.json")
-  if (!existsSync(packageJsonPath)) {
-    console.log(kleur.red("No package.json found in current directory"))
-    process.exit(1)
-  }
-  const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf-8"))
-
-  const registryUrl = `${ctx.registry_url}/${packageJson.name.replace("@", "")}`
-
-  console.log(`Opening ${registryUrl} in your browser...`)
-  await open(registryUrl)
-}

package/cli/lib/cmd-fns/package-examples-create.ts

@@ -1,36 +0,0 @@
-import { soupify } from "cli/lib/soupify"
-import { AppContext } from "../util/app-context"
-import { z } from "zod"
-import fs from "fs"
-
-export const packageExamplesCreate = async (ctx: AppContext, args: any) => {
-  const params = z
-    .object({
-      packageNameWithVersion: z.string(),
-      file: z.string(),
-      export: z.string().optional().default("default"),
-    })
-    .parse(args)
-
-  const tscircuit_soup = await soupify(
-    {
-      filePath: params.file,
-      exportName: params.export,
-    },
-    ctx,
-  )
-
-  const fileContent = await fs.promises.readFile(params.file, "utf8")
-
-  const package_example = await ctx.axios
-    .post("/package_examples/create", {
-      package_name_with_version: params.packageNameWithVersion,
-      file_path: params.file,
-      export_name: params.export,
-      source_content: fileContent,
-      tscircuit_soup,
-    })
-    .then((r) => r.data.package_example)
-
-  console.log(package_example)
-}

package/cli/lib/cmd-fns/package-examples-get.ts

@@ -1,20 +0,0 @@
-import { AppContext } from "../util/app-context"
-import { z } from "zod"
-
-export const packageExamplesGet = async (ctx: AppContext, args: any) => {
-  const params = z
-    .object({
-      packageExampleId: z.string().uuid(),
-    })
-    .parse(args)
-
-  const { packageExampleId: package_example_id } = params
-
-  const package_example = await ctx.axios
-    .post("/package_examples/get", {
-      package_example_id,
-    })
-    .then((r) => r.data.package_example)
-
-  console.log(package_example)
-}

package/cli/lib/cmd-fns/package-examples-list.ts

@@ -1,18 +0,0 @@
-import { AppContext } from "../util/app-context"
-import { z } from "zod"
-
-export const packageExamplesList = async (ctx: AppContext, args: any) => {
-  const params = z
-    .object({
-      packageNameWithVersion: z.string(),
-    })
-    .parse(args)
-
-  const package_examples = await ctx.axios
-    .post("/package_examples/list", {
-      package_name_with_version: params.packageNameWithVersion,
-    })
-    .then((r) => r.data.package_examples)
-
-  console.log(package_examples)
-}

package/cli/lib/cmd-fns/package-files-create.ts

@@ -1,31 +0,0 @@
-import { AppContext } from "../util/app-context"
-import { z } from "zod"
-import * as fs from "fs/promises"
-import kleur from "kleur"
-
-export const packageFilesCreate = async (ctx: AppContext, args: any) => {
-  const params = z
-    .object({
-      file: z.string(),
-      packageReleaseId: z.string().optional(),
-      packageNameWithVersion: z.string().optional(),
-    })
-    .parse(args)
-
-  const { file, packageNameWithVersion, packageReleaseId } = params
-
-  const fileContent = await fs.readFile(file)
-
-  const package_file = await ctx.axios
-    .post("/package_files/create", {
-      file_path: file,
-      content_text: fileContent.toString(),
-      package_name_with_version: packageNameWithVersion,
-      package_release_id: packageReleaseId,
-    })
-    .then((r) => r.data.package_file)
-
-  console.log(
-    `Package file created ${kleur.gray(package_file.package_file_id)}`,
-  )
-}