@tscircuit/cli 0.0.394 → 0.1.2

package/.github/workflows/bun-formatcheck.yml

@@ -0,0 +1,26 @@
+# Created using @tscircuit/plop (npm install -g @tscircuit/plop)
+name: Format Check
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  format-check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Run format check
+        run: bun run format:check

package/.github/workflows/bun-pver-release.yml

@@ -0,0 +1,25 @@
+# Created using @tscircuit/plop (npm install -g @tscircuit/plop)
+name: Publish to npm
+on:
+  push:
+    branches:
+      - main
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm install -g pver
+      - run: bun install --frozen-lockfile
+      - run: bun run build
+      - run: pver release
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/{typecheck.yml → bun-typecheck.yml}

@@ -22,8 +22,5 @@ jobs:
       - name: Install dependencies
         run: bun i
 
-      - name: Build (required for dist imports)
-        run: bun run build
-
       - name: Run type check
         run: bunx tsc --noEmit

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 tscircuit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,57 +1,54 @@
-# `tsci` - The TSCircuit Command Line & Development Tools
+# tscircuit command line interface (CLI)
 
-Command line tool for developing tscircuit projects and interacting with the
-tscircuit registry.
+A CLI for developing, managing and publishing tscircuit code (the "npm for tscircuit")
 
-## Installation
+## Usage
 
 ```bash
-npm install -g @tscircuit/cli
+# Start a local server that watches for changes in
+# this file or it's dependencies and updates the
+# browser preview
+tsci dev ./path/to/file.tsx
+
+# Clone a snippet from the registry
+tsci clone author/snippetName
 ```
 
-## Usage
+> Note: The snippets CLI uses the same configuration files as the [@tscircuit/cli](https://github.com/tscircuit/cli), so you may need to also install `npm install -g @tscircuit/cli` and run `tsci login` to authenticate!
 
-The `tsci` CLI is interactive by default. You can specify the `-y` or any fully-
-qualified with all required arguments to skip the interactive mode.
+## Installation
 
 ```bash
-# Interactively choose a command and options:
-tsci
-
-# Login
-tsci login
-
-# Create a Project
-tsci init
+npm install -g @tscircuit/cli
+```
 
-# Develop a Project (preview, export, and edit circuit files in browser)
-tsci dev
+## Development
 
-# Manage Dependencies
-tsci install
-tsci add some-package
-tsci remove some-package
+This command will open the `snippets.tsx` file for editing.
 
-# Publish a Project
-tsci publish
+```bash
+bun run dev
 ```
 
-## Developing
+## How it Works
 
-This project is developed with [bun](https://bun.sh/), make sure you have
-that installed.
+When you run `snippets dev`, we start a local
+server that uses the [@tscircuit/file-server](https://github.com/tscircuit/file-server) and [@tscircuit/runframe](https://github.com/tscircuit/runframe) (on the browser)
 
-Run `bun install` to install dependencies and `bun cli/cli.ts` to run test the cli in development, or `bun run dev` to run the dev server.
+We use commanderjs to define the CLI commands inside
+of `cli/main.ts`
 
-To run tests, run `bun test`
+Utility functions are defined in `lib/*`
 
-If you want to test developing, run `bun dev` and visit http://127.0.0.1:5173. The project being
-loaded is inside `example-project`
+## Development
 
-![image](https://github.com/tscircuit/cli/assets/1910070/d6facd4d-0887-4871-8aa1-e525c519c50d)
+### Dynamically Loading Runframe
 
-## Features Coming Soon
+Use the `RUNFRAME_STANDALONE_FILE_PATH` environment variable to point to the runframe standalone file. You will still need to run `bun run build` inside
+runframe each time you'd like to load a new version of runframe.
 
-- [`tsci format`](https://github.com/tscircuit/cli/issues/1)
-- [`tsci lint`](https://github.com/tscircuit/cli/issues/2)
-- [`tsci open`](https://github.com/tscircuit/cli/issues/4)
+```bash
+export RUNFRAME_STANDALONE_FILE_PATH=../runframe/dist/standalone.min.js
+cd ../runframe && bun run build
+cd ../cli && bun run dev
+```

package/biome.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://biomejs.dev/schemas/1.7.3/schema.json",
+  "$schema": "https://biomejs.dev/schemas/1.9.3/schema.json",
   "organizeImports": {
     "enabled": true
   },
@@ -8,13 +8,7 @@
     "indentStyle": "space"
   },
   "files": {
-    "ignore": [
-      "cosmos-export",
-      "dist",
-      "package.json",
-      "tsconfig.json",
-      "static-routes.ts"
-    ]
+    "ignore": ["cosmos-export", "dist", "package.json", "tsconfig.json"]
   },
   "javascript": {
     "formatter": {
@@ -28,13 +22,19 @@
     }
   },
   "linter": {
-    "enabled": false,
+    "enabled": true,
     "rules": {
+      "recommended": true,
       "suspicious": {
         "noExplicitAny": "off"
       },
+      "complexity": {
+        "noForEach": "off"
+      },
       "style": {
+        "noUselessElse": "off",
         "noNonNullAssertion": "off",
+        "useNumberNamespace": "off",
         "useFilenamingConvention": {
           "level": "error",
           "options": {

package/cli/CliContext.ts

@@ -0,0 +1,8 @@
+import type { CliConfig } from "lib/cli-config"
+
+/**
+ * The CLI context contains information that is commonly passed to all functions
+ */
+export interface CliContext {
+  cliConfig: CliConfig
+}

package/cli/auth/login/register.ts

@@ -0,0 +1,73 @@
+import type { Command } from "commander"
+import { cliConfig } from "lib/cli-config"
+import delay from "delay"
+import { getKy } from "lib/registry-api/get-ky"
+import type { EndpointResponse } from "lib/registry-api/endpoint-types"
+
+export const registerAuthLogin = (program: Command) => {
+  program.commands
+    .find((c) => c.name() === "auth")!
+    .command("login")
+    .description("Authenticate CLI, login to registry")
+    .action(async (args) => {
+      const ky = getKy()
+
+      const { login_page } = await ky
+        .post<EndpointResponse["sessions/login_page/create"]>(
+          "sessions/login_page/create",
+          {
+            json: {},
+          },
+        )
+        .json()
+
+      console.log("Please visit the following URL to log in:")
+      console.log(login_page.url)
+
+      // Wait until we receive confirmation
+      while (true) {
+        const { login_page: new_login_page } = await ky
+          .post<EndpointResponse["sessions/login_page/get"]>(
+            "sessions/login_page/get",
+            {
+              json: {
+                login_page_id: login_page.login_page_id,
+              },
+              headers: {
+                Authorization: `Bearer ${login_page.login_page_auth_token}`,
+              },
+            },
+          )
+          .json()
+
+        if (new_login_page.was_login_successful) {
+          console.log("Logged in! Generating token...")
+          break
+        }
+
+        if (new_login_page.is_expired) {
+          throw new Error("Login page expired")
+        }
+
+        await delay(1000)
+      }
+
+      const { session } = await ky
+        .post<EndpointResponse["sessions/login_page/exchange_for_cli_session"]>(
+          "sessions/login_page/exchange_for_cli_session",
+          {
+            json: {
+              login_page_id: login_page.login_page_id,
+            },
+            headers: {
+              Authorization: `Bearer ${login_page.login_page_auth_token}`,
+            },
+          },
+        )
+        .json()
+
+      cliConfig.set("sessionToken", session.token)
+
+      console.log("Ready to use!")
+    })
+}

package/cli/auth/logout/register.ts

@@ -0,0 +1,11 @@
+import type { Command } from "commander"
+
+export const registerAuthLogout = (program: Command) => {
+  program.commands
+    .find((c) => c.name() === "auth")!
+    .command("logout")
+    .description("Logout from registry")
+    .action((args) => {
+      console.log("logout")
+    })
+}

package/cli/auth/register.ts

@@ -0,0 +1,5 @@
+import type { Command } from "commander"
+
+export const registerAuth = (program: Command) => {
+  program.command("auth").description("Login/logout")
+}

package/cli/clone/register.ts

@@ -0,0 +1,99 @@
+import type { Command } from "commander"
+import { getKy } from "lib/registry-api/get-ky"
+import * as fs from "node:fs"
+import * as path from "node:path"
+
+export const registerClone = (program: Command) => {
+  program
+    .command("clone")
+    .description("Clone a snippet from the registry")
+    .argument("<snippet>", "Snippet to clone (e.g. author/snippetName)")
+    .action(async (snippetPath: string) => {
+      let author: string
+      let snippetName: string
+      if (!snippetPath.startsWith("@tsci/") && snippetPath.includes("/")) {
+        ;[author, snippetName] = snippetPath.split("/")
+      } else {
+        const trimmedPath = snippetPath.replace("@tsci/", "")
+        const firstDotIndex = trimmedPath.indexOf(".")
+        author = trimmedPath.slice(0, firstDotIndex)
+        snippetName = trimmedPath.slice(firstDotIndex + 1)
+      }
+
+      if (!author || !snippetName) {
+        console.error(
+          "Invalid snippet path. Use format: author/snippetName, author.snippetName or @tsci/author.snippetName",
+        )
+        process.exit(1)
+      }
+
+      const ky = getKy()
+
+      try {
+        console.log(`Cloning ${author}/${snippetName}...`)
+
+        const packageFileList = await ky
+          .post<{
+            package_files: Array<{
+              package_file_id: string
+              package_release_id: string
+              file_path: string
+              created_at: string
+            }>
+          }>("package_files/list", {
+            json: {
+              package_name: `${author}/${snippetName}`,
+              use_latest_version: true,
+            },
+          })
+          .json()
+
+        // Create directory if it doesn't exist
+        const dirPath = `./${author}.${snippetName}`
+        if (!fs.existsSync(dirPath)) {
+          fs.mkdirSync(dirPath)
+        }
+
+        // Download each file that doesn't start with dist/
+        for (const fileInfo of packageFileList.package_files) {
+          const filePath = fileInfo.file_path.startsWith("/")
+            ? fileInfo.file_path.slice(1)
+            : fileInfo.file_path
+
+          if (filePath.startsWith("dist/")) continue
+
+          const fileContent = await ky
+            .post<{
+              package_file: {
+                content_text: string
+              }
+            }>("package_files/get", {
+              json: {
+                package_name: `${author}/${snippetName}`,
+                file_path: fileInfo.file_path,
+              },
+            })
+            .json()
+
+          const fullPath = path.join(dirPath, filePath)
+          const dirName = path.dirname(fullPath)
+
+          // Create nested directories if they don't exist
+          if (!fs.existsSync(dirName)) {
+            fs.mkdirSync(dirName, { recursive: true })
+          }
+
+          fs.writeFileSync(fullPath, fileContent.package_file.content_text)
+        }
+
+        console.log(`Successfully cloned to ./${author}.${snippetName}/`)
+      } catch (error) {
+        if (error instanceof Error) {
+          console.error("Failed to clone snippet:", error.message)
+        } else {
+          console.error("Failed to clone snippet:", error)
+        }
+        process.exit(1)
+      }
+    })
+}

package/cli/config/print/register.ts

@@ -0,0 +1,12 @@
+import type { Command } from "commander"
+import { cliConfig } from "lib/cli-config"
+
+export const registerConfigPrint = (program: Command) => {
+  program.commands
+    .find((c) => c.name() === "config")!
+    .command("print")
+    .description("Print the current config")
+    .action(() => {
+      console.log(JSON.stringify(cliConfig.all, null, 2))
+    })
+}

package/cli/config/register.ts

@@ -0,0 +1,5 @@
+import type { Command } from "commander"
+
+export const registerConfig = (program: Command) => {
+  program.command("config").description("Manage tscircuit CLI configuration")
+}

package/cli/dev/register.ts

@@ -0,0 +1,111 @@
+import type { Command } from "commander"
+import * as path from "node:path"
+import * as chokidar from "chokidar"
+import * as fs from "node:fs"
+import { createServer } from "lib/server/createServer"
+import { getLocalFileDependencies } from "lib/dependency-analysis/getLocalFileDependencies"
+import { installTypes } from "../../lib/dependency-analysis/installNodeModuleTypes"
+import { EventsWatcher } from "../../lib/server/EventsWatcher"
+
+export const registerDev = (program: Command) => {
+  program
+    .command("dev")
+    .description("Start development server for a snippet")
+    .argument("<file>", "Path to the snippet file")
+    .option("-p, --port <number>", "Port to run server on", "3000")
+    .action(async (file: string, options: { port: string }) => {
+      const absolutePath = path.resolve(file)
+      const fileDir = path.dirname(absolutePath)
+      const port = parseInt(options.port)
+
+      try {
+        console.log("Installing types for imported snippets...")
+        await installTypes(absolutePath)
+        console.log("Types installed successfully")
+      } catch (error) {
+        console.warn("Failed to install types:", error)
+      }
+
+      // Start the server
+      await createServer(port)
+
+      const eventsWatcher = new EventsWatcher(`http://localhost:${port}`)
+      eventsWatcher.start()
+
+      await fetch(`http://localhost:${port}/api/files/upsert`, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify({
+          file_path: "entrypoint.tsx",
+          text_content: `
+import MyCircuit from "./snippet.tsx"
+
+circuit.add(<MyCircuit />)
+`,
+        }),
+      })
+
+      // Function to update file content
+      const updateFile = async (filePath: string) => {
+        try {
+          const content = await fs.promises.readFile(filePath, "utf-8")
+          const response = await fetch(
+            `http://localhost:${port}/api/files/upsert`,
+            {
+              method: "POST",
+              headers: { "Content-Type": "application/json" },
+              body: JSON.stringify({
+                file_path: path.relative(fileDir, filePath),
+                text_content: content,
+              }),
+            },
+          )
+          if (!response.ok) {
+            console.error(`Failed to update ${filePath}`)
+          }
+        } catch (error) {
+          console.error(`Error updating ${filePath}:`, error)
+        }
+      }
+
+      // Get initial dependencies
+      const dependencies = new Set([absolutePath])
+      try {
+        const deps = getLocalFileDependencies(absolutePath)
+        deps.forEach((dep) => dependencies.add(dep))
+      } catch (error) {
+        console.warn("Failed to analyze dependencies:", error)
+      }
+
+      // Watch the main file and its dependencies
+      const filesystemWatcher = chokidar.watch(Array.from(dependencies), {
+        persistent: true,
+        ignoreInitial: false,
+      })
+
+      filesystemWatcher.on("change", async (filePath) => {
+        console.log(`File ${filePath} changed`)
+        await updateFile(filePath)
+      })
+
+      filesystemWatcher.on("add", async (filePath) => {
+        console.log(`File ${filePath} added`)
+        await updateFile(filePath)
+      })
+
+      eventsWatcher.on("FILE_UPDATED", async (ev) => {
+        if (ev.file_path === "manual-edits.json") {
+          console.log("Manual edits updated, updating on filesystem...")
+          const { file } = await fetch(
+            `http://localhost:${port}/api/files/get?file_path=manual-edits.json`,
+          ).then((r) => r.json())
+          fs.writeFileSync(
+            path.join(fileDir, "manual-edits.json"),
+            file.text_content,
+          )
+        }
+      })
+
+      console.log(`Watching ${file} and its dependencies...`)
+    })
+}

package/cli/main.ts

@@ -0,0 +1,33 @@
+#!/usr/bin/env node
+import { Command } from "commander"
+import { registerDev } from "./dev/register"
+import { registerAuthLogin } from "./auth/login/register"
+import { registerAuthLogout } from "./auth/logout/register"
+import { registerAuth } from "./auth/register"
+import { registerConfig } from "./config/register"
+import { registerConfigPrint } from "./config/print/register"
+import { registerClone } from "./clone/register"
+import { perfectCli } from "perfect-cli"
+
+const program = new Command()
+
+program
+  .name("tsci")
+  .description("CLI for developing tscircuit snippets")
+  .version("1.0.0")
+
+registerDev(program)
+registerClone(program)
+
+registerAuth(program)
+registerAuthLogin(program)
+registerAuthLogout(program)
+
+registerConfig(program)
+registerConfigPrint(program)
+
+if (process.argv.length === 2) {
+  perfectCli(program, process.argv)
+} else {
+  program.parse()
+}