@tscircuit/cli 0.0.2 → 0.0.3

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/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

@@ -24,4 +24,4 @@ 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 { devCmd as dev } from "./dev/dev"

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

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.3",
   "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": "",

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" />
+)