@tscircuit/cli 0.0.2 → 0.0.4

package/README.md

@@ -1,6 +1,6 @@
-# `tsci` (@tscircuit/cli)
+# `tsck` - The TSCircuit Command Line Tool
 
-Command line tool for creating tscircuit projects and interacting with the
+Command line tool for developing tscircuit projects and interacting with the
 tscircuit registry.
 
 ## Installation
@@ -11,40 +11,39 @@ npm install -g @tscircuit/cli
 
 ## Usage
 
-The `tsci` CLI is interactive by default. You can specify the `-y` or any fully-
+The `tsck` CLI is interactive by default. You can specify the `-y` or any fully-
 qualified with all required arguments to skip the interactive mode.
 
 ```bash
 # Interactively choose a command and options:
-tsci
+tsck
 
 # Login
-tsci login
+tsck login
 
 # Create a Project
-tsci init
+tsck init
 
 # Develop a Project
-tsci preview              # build and view circuit files in browser
-tsci dev                  # build, view and edit circuit files in browser
+tsck dev                  # build, view and edit circuit files in browser
 
 # Manage Dependencies
-tsci install
-tsci add some-package
-tsci remove some-package
+tsck install
+tsck add some-package
+tsck remove some-package
 
 # Lint a Project
-tsci lint
-tsci lint 2024            # use 2024 tscircuit recommendations
+tsck lint
+tsck lint 2024            # use 2024 tscircuit recommendations
 
 # Format a Project
-tsci format
-tsci format 2024
+tsck format
+tsck format 2024
 
 # Publish a Project
-tsci publish
+tsck publish
 
 # View Your Project on Registry
-tsci open
-tsci view
+tsck open
+tsck view
 ```

package/dist/cli.js

@@ -210,7 +210,7 @@ import {Command} from "commander";
 // package.json
 var package_default = {
   name: "@tscircuit/cli",
-  version: "0.0.2",
+  version: "0.0.4",
   private: false,
   type: "module",
   description: "Command line tool for developing, publishing and installing tscircuit circuits",
@@ -225,7 +225,8 @@ var package_default = {
   },
   bin: {
     tscircuit: "./dist/cli.js",
-    tsci: "./dist/cli.js"
+    tsci: "./dist/cli.js",
+    tsck: "./dist/cli.js"
   },
   keywords: [],
   author: "",
@@ -250,7 +251,7 @@ var package_default = {
     minimist: "^1.2.8",
     "node-persist": "^4.0.1",
     open: "^10.1.0",
-    "perfect-cli": "1.0.12",
+    "perfect-cli": "1.0.13",
     prompts: "^2.4.2",
     react: "^18.2.0",
     zod: "latest"
@@ -273,7 +274,7 @@ var package_default = {
 
 // lib/cmd-fns/config-reveal-location.ts
 var configRevealLocation = async (ctx, args) => {
-  console.log(`tsci config path: ${ctx.global_config.path}`);
+  console.log(`tsck config path: ${ctx.global_config.path}`);
 };
 // lib/cmd-fns/config-set-registry.ts
 import {z} from "zod";
@@ -619,7 +620,7 @@ var soupifyCmd = async (ctx, args) => {
     console.log(JSON.stringify(soup, null, 2));
   }
 };
-// lib/cmd-fns/dev.ts
+// lib/cmd-fns/dev/index.ts
 import {z as z16} from "zod";
 import kleur4 from "kleur";
 import {join as joinPath} from "path";
@@ -844,7 +845,7 @@ var bundle_default = {
   "index.html": Buffer.from("PCFkb2N0eXBlIGh0bWw+CjxodG1sIGxhbmc9ImVuIj4KICA8aGVhZD4KICAgIDxtZXRhIGNoYXJzZXQ9IlVURi04IiAvPgogICAgPCEtLSA8bGluayByZWw9Imljb24iIHR5cGU9ImltYWdlL3N2Zyt4bWwiIGhyZWY9Ii92aXRlLnN2ZyIgLz4gLS0+CiAgICA8bWV0YSBuYW1lPSJ2aWV3cG9ydCIgY29udGVudD0id2lkdGg9ZGV2aWNlLXdpZHRoLCBpbml0aWFsLXNjYWxlPTEuMCIgLz4KICAgIDx0aXRsZT5bZGV2XSB0c2NpcmN1aXQ8L3RpdGxlPgogICAgPHNjcmlwdCB0eXBlPSJtb2R1bGUiIGNyb3Nzb3JpZ2luIHNyYz0iL3ByZXZpZXcvYXNzZXRzL2luZGV4LUNpRUdEejdkLmpzIj48L3NjcmlwdD4KICAgIDxsaW5rIHJlbD0ic3R5bGVzaGVldCIgY3Jvc3NvcmlnaW4gaHJlZj0iL3ByZXZpZXcvYXNzZXRzL2luZGV4LUNNNkk3TGhOLmNzcyI+CiAgPC9oZWFkPgogIDxib2R5PgogICAgPGRpdiBpZD0icm9vdCI+PC9kaXY+CiAgPC9ib2R5Pgo8L2h0bWw+Cg==", "base64")
 };
 
-// lib/cmd-fns/dev.ts
+// lib/cmd-fns/dev/index.ts
 import defaultAxios from "axios";
 import {readdirSync, readFileSync} from "fs";
 import EdgeRuntimePrimitives from "@edge-runtime/primitives";
@@ -981,9 +982,145 @@ var devCmd = async (ctx, args) => {
     }
   }
 };
+// lib/cmd-fns/init.ts
+import {z as z17} from "zod";
+import {
+readFileSync as readFileSync2,
+writeFileSync as writeFileSync3,
+existsSync,
+mkdirSync as mkdirSync2,
+appendFileSync
+} from "fs";
+import * as Path3 from "node:path";
+import $2 from "dax-sh";
+var initCmd = async (ctx, args) => {
+  const params = z17.object({
+    name: z17.string().optional(),
+    dir: z17.string().optional(),
+    runtime: z17.enum(["bun", "node"]).optional()
+  }).parse(args);
+  if (params.name && !params.dir) {
+    params.dir = `./${params.name.split("/").pop()}`;
+  } else if (!params.dir) {
+    params.dir = `.`;
+  }
+  let runtime = params.runtime;
+  if (!runtime) {
+    const bunExists = $2.commandExistsSync("bun");
+    if (bunExists) {
+      runtime = "bun";
+    } else {
+      runtime = "node";
+    }
+  }
+  const pkm = runtime === "bun" ? "bun" : "npm";
+  const runner = runtime === "bun" ? "bun" : "tsx";
+  const packageJsonExists = existsSync(Path3.join(params.dir, "package.json"));
+  const dirExists = existsSync(params.dir);
+  if (!dirExists) {
+    console.log(`Creating directory ${params.dir}`);
+    mkdirSync2(params.dir, { recursive: true });
+  }
+  process.chdir(params.dir);
+  if (!packageJsonExists) {
+    console.log(`Initializing ${pkm} project...`);
+    await $2`${pkm} init -y`;
+  }
+  if (runtime !== "bun") {
+    console.log(`Setting up project for typescript...`);
+    await $2`${pkm} add -D typescript tsx`;
+  }
+  console.log("Changing package name...");
+  const packageJson = JSON.parse(readFileSync2("package.json", "utf-8"));
+  packageJson.name = params.name;
+  writeFileSync3("package.json", JSON.stringify(packageJson, null, 2));
+  console.log(`Adding ".tscircuit" to .gitignore`);
+  appendFileSync(".gitignore", "\n.tscircuit", {
+    encoding: "utf-8",
+    flag: "w+"
+  });
+  console.log("Creating lib and examples directories...");
+  mkdirSync2("examples", { recursive: true });
+  mkdirSync2("lib", { recursive: true });
+  writeFileSync3(Path3.join("lib", "MyCircuit.tsx"), `
+  export const MyCircuit = () => (
+    <resistor
+      resistance="10kohm"
+      name="R1"
+      footprint="0805"
+    />
+  )
+  `.trim());
+  writeFileSync3("index.ts", `export * from "./lib/MyCircuit"`);
+  writeFileSync3(Path3.join("examples", "MyExample.tsx"), `
+import { MyCircuit } from "lib/MyCircuit"
+
+export const MyExample = () => (
+  <MyCircuit />
+)
+      `.trim());
+  writeFileSync3("README.md", `
+# ${params.name}
+
+> This project was generated using [tsck](https://github.com/tscircuit/tscircuit)
+
+To develop and view the examples, run \`tsck dev\` and open [http://localhost:3020](http://localhost: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 \`tsck 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 \`tsck publish\`
+
+
+
+`.trim());
+  writeFileSync3("tsconfig.json", `
+{
+  "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());
+  console.log("Done! Run `tsck dev` to start developing!");
+};
 // lib/get-program.ts
 var getProgram = (ctx) => {
-  const cmd = new Command("tsci");
+  const cmd = new Command("tsck");
   cmd.version(package_default.version);
   const authCmd = cmd.command("auth");
   authCmd.command("login").action((args) => authLogin(ctx, args));
@@ -1017,11 +1154,12 @@ var getProgram = (ctx) => {
   packageExamples.command("get").requiredOption("--package-example-id <package_example_id>").action((args) => packageExamplesGet(ctx, args));
   packageExamples.command("create").requiredOption("--package-name-with-version <package_name_with_version>").requiredOption("--file <file>").option("--export <export>", "Name of export to soupify").action((args) => packageExamplesCreate(ctx, args));
   cmd.command("publish").action((args) => publish(ctx, args));
-  cmd.command("version").action(() => console.log(`tsci v${package_default.version}`));
+  cmd.command("version").action(() => console.log(`tsck v${package_default.version}`));
   cmd.command("login").action((args) => authLogin(ctx, args));
   cmd.command("logout").action((args) => authLogout(ctx, args));
   cmd.command("soupify").requiredOption("--file <file>", "Input example files").option("--export <export_name>", "Name of export to soupify, if not specified, soupify the default/only export").action((args) => soupifyCmd(ctx, args));
   cmd.command("dev").option("--cwd <cwd>", "Current working directory").option("--port <port>", "Port to run dev server on").action((args) => devCmd(ctx, args));
+  cmd.command("init").option("--name <name>", "Name of the project").option("--runtime <runtime>", "Runtime to use (attempts to bun, otherwise node/tsx)").option("--dir <dir>", "Directory to initialize (defaults to ./<name> or . if name not provided)").action((args) => initCmd(ctx, args));
   cmd.command("add").action((args) => {
   });
   cmd.command("remove").action((args) => {
@@ -1246,6 +1384,7 @@ var interactForPackageName = async ({
 var PARAM_HANDLERS_BY_PARAM_NAME = {
   file: interactForLocalFile,
   cwd: interactForLocalDirectory,
+  dir: interactForLocalDirectory,
   package_release_id: interactForPackageReleaseId,
   package_name: interactForPackageName,
   package_name_with_version: interactForPackageNameWithVersion,
@@ -1255,7 +1394,7 @@ var PARAM_HANDLERS_BY_PARAM_NAME = {
 // lib/util/create-context-and-run-program.ts
 var createContextAndRunProgram = async (process_args) => {
   const args = minimist(process_args);
-  const global_config = new Configstore("tsci");
+  const global_config = new Configstore("tsck");
   const current_profile = args.profile ?? global_config.get("current_profile") ?? "default";
   const profile_config = {
     get: (key) => global_config.get(`profiles.${current_profile}.${key}`),

package/lib/cmd-fns/config-reveal-location.ts

@@ -1,5 +1,5 @@
 import { AppContext } from "../util/app-context"
 
 export const configRevealLocation = async (ctx: AppContext, args: any) => {
-  console.log(`tsci config path: ${ctx.global_config.path}`)
+  console.log(`tsck config path: ${ctx.global_config.path}`)
 }

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

@@ -1,11 +1,11 @@
-import { AppContext } from "../util/app-context"
+import { AppContext } from "../../util/app-context"
 import { z } from "zod"
 import kleur from "kleur"
 import { join as joinPath } from "path"
 import prompts from "prompts"
 import open from "open"
-import apiServer from "../../dev-server-api/dist/bundle"
-import frontendVfs from "../../dev-server-frontend/dist/bundle"
+import apiServer from "../../../dev-server-api/dist/bundle"
+import frontendVfs from "../../../dev-server-frontend/dist/bundle"
 import defaultAxios from "axios"
 import { readdirSync, readFileSync } from "fs"
 import { soupify } from "lib/soupify"

package/lib/cmd-fns/index.ts

@@ -25,3 +25,4 @@ 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"

package/lib/cmd-fns/init.ts

@@ -0,0 +1,172 @@
+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"
+import $ from "dax-sh"
+
+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 = `.`
+  }
+
+  let runtime = params.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`
+  }
+
+  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(`Adding ".tscircuit" to .gitignore`)
+  appendFileSync(".gitignore", "\n.tscircuit", {
+    encoding: "utf-8",
+    flag: "w+",
+  })
+
+  console.log("Creating lib and examples directories...")
+  mkdirSync("examples", { recursive: true })
+  mkdirSync("lib", { recursive: true })
+
+  writeFileSync(
+    Path.join("lib", "MyCircuit.tsx"),
+    `
+  export const MyCircuit = () => (
+    <resistor
+      resistance="10kohm"
+      name="R1"
+      footprint="0805"
+    />
+  )
+  `.trim()
+  )
+
+  writeFileSync("index.ts", `export * from "./lib/MyCircuit"`)
+
+  writeFileSync(
+    Path.join("examples", "MyExample.tsx"),
+    `
+import { MyCircuit } from "lib/MyCircuit"
+
+export const MyExample = () => (
+  <MyCircuit />
+)
+      `.trim()
+  )
+
+  // Override the README file
+  writeFileSync(
+    "README.md",
+    `
+# ${params.name}
+
+> This project was generated using [tsck](https://github.com/tscircuit/tscircuit)
+
+To develop and view the examples, run \`tsck dev\` and open [http://localhost:3020](http://localhost: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 \`tsck 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 \`tsck publish\`
+
+
+
+`.trim()
+  )
+
+  // Open tsconfig.json and modify it to import the tscircuit types
+  writeFileSync(
+    "tsconfig.json",
+    `
+{
+  "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()
+  )
+
+  console.log("Done! Run `tsck dev` to start developing!")
+}

package/lib/get-program.ts

@@ -21,7 +21,7 @@ import * as CMDFN from "lib/cmd-fns"
 // | /package_examples/create | Create a new package example |
 
 export const getProgram = (ctx: AppContext) => {
-  const cmd = new Command("tsci")
+  const cmd = new Command("tsck")
 
   cmd.version(packageJson.version)
 
@@ -163,7 +163,7 @@ export const getProgram = (ctx: AppContext) => {
 
   cmd
     .command("version")
-    .action(() => console.log(`tsci v${packageJson.version}`))
+    .action(() => console.log(`tsck v${packageJson.version}`))
 
   cmd.command("login").action((args) => CMDFN.authLogin(ctx, args))
   cmd.command("logout").action((args) => CMDFN.authLogout(ctx, args))
@@ -183,6 +183,19 @@ export const getProgram = (ctx: AppContext) => {
     .option("--port <port>", "Port to run dev server on")
     .action((args) => CMDFN.dev(ctx, args))
 
+  cmd
+    .command("init")
+    .option("--name <name>", "Name of the project")
+    .option(
+      "--runtime <runtime>",
+      "Runtime to use (attempts to bun, otherwise node/tsx)"
+    )
+    .option(
+      "--dir <dir>",
+      "Directory to initialize (defaults to ./<name> or . if name not provided)"
+    )
+    .action((args) => CMDFN.init(ctx, args))
+
   cmd.command("add").action((args) => {})
   cmd.command("remove").action((args) => {})
   cmd.command("install").action((args) => {})

package/lib/param-handlers/index.ts

@@ -9,6 +9,7 @@ import { ParamHandler } from "./param-handler-type"
 export const PARAM_HANDLERS_BY_PARAM_NAME: Record<string, ParamHandler> = {
   file: interactForLocalFile,
   cwd: interactForLocalDirectory,
+  dir: interactForLocalDirectory,
   package_release_id: interactForPackageReleaseId,
   package_name: interactForPackageName,
   package_name_with_version: interactForPackageNameWithVersion,

package/lib/util/create-context-and-run-program.ts

@@ -18,7 +18,7 @@ export type CliArgs = {
 export const createContextAndRunProgram = async (process_args: any) => {
   const args = minimist(process_args)
 
-  const global_config = new Configstore("tsci")
+  const global_config = new Configstore("tsck")
   const current_profile =
     args.profile ?? global_config.get("current_profile") ?? "default"
   const profile_config: typeof global_config = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tscircuit/cli",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "private": false,
   "type": "module",
   "description": "Command line tool for developing, publishing and installing tscircuit circuits",
@@ -15,7 +15,8 @@
   },
   "bin": {
     "tscircuit": "./dist/cli.js",
-    "tsci": "./dist/cli.js"
+    "tsci": "./dist/cli.js",
+    "tsck": "./dist/cli.js"
   },
   "keywords": [],
   "author": "",
@@ -40,7 +41,7 @@
     "minimist": "^1.2.8",
     "node-persist": "^4.0.1",
     "open": "^10.1.0",
-    "perfect-cli": "1.0.12",
+    "perfect-cli": "1.0.13",
     "prompts": "^2.4.2",
     "react": "^18.2.0",
     "zod": "latest"
@@ -59,4 +60,4 @@
     "tsx": "^4.7.1",
     "typescript": "^5.3.3"
   }
-}
+}

package/tests/assets/example-project/examples/basic-capacitor.tsx

@@ -1 +1,3 @@
-export const CapacitorExample = () => <capacitor capacitance="10uF" name="C1" />
+export const CapacitorExample = () => (
+  <capacitor capacitance="10uF" name="C1" footprint="0805" />
+)

package/tests/assets/example-project/src/MyCircuit.tsx

@@ -1,3 +1,5 @@
 import "@tscircuit/react-fiber"
 
-export const MyCircuit = () => <resistor name="R1" resistance="10kohm" />
+export const MyCircuit = () => (
+  <resistor name="R1" resistance="10kohm" footprint="0805" />
+)

package/tests/init.test.ts

@@ -0,0 +1,9 @@
+import { test, expect, describe } from "bun:test"
+import { $ } from "bun"
+
+test.skip("tsck init", async () => {
+  await $`rm -rf ./tests/example-init`
+  console.log(
+    await $`bun cli.ts init --name init-test --dir ./tests/example-init`.text()
+  )
+})