@tscircuit/cli 0.1.26 → 0.1.28

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

@@ -0,0 +1,25 @@
+# Created using @tscircuit/plop (npm install -g @tscircuit/plop)
+name: Bun Test
+
+on:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Run tests
+        run: bun test

package/cli/clone/register.ts

@@ -2,53 +2,8 @@ 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"
-import { execSync } from "node:child_process"
-
-// Detect the package manager being used in the project
-const detectPackageManager = (): string => {
-  const userAgent = process.env.npm_config_user_agent || ""
-  if (userAgent.startsWith("yarn")) return "yarn"
-  if (userAgent.startsWith("pnpm")) return "pnpm"
-  if (userAgent.startsWith("bun")) return "bun"
-
-  if (fs.existsSync("yarn.lock")) return "yarn"
-  if (fs.existsSync("pnpm-lock.yaml")) return "pnpm"
-  if (fs.existsSync("bun.lockb")) return "bun"
-
-  return "npm" // Default to npm
-}
-
-// Generate a React-compatible tsconfig.json
-const generateTsConfig = (dir: string) => {
-  const tsconfigPath = path.join(dir, "tsconfig.json")
-  const tsconfigContent = JSON.stringify(
-    {
-      compilerOptions: {
-        target: "ES6",
-        module: "ESNext",
-        jsx: "react-jsx",
-        outDir: "dist",
-        strict: true,
-        esModuleInterop: true,
-        moduleResolution: "node",
-        skipLibCheck: true,
-        forceConsistentCasingInFileNames: true,
-        resolveJsonModule: true,
-        sourceMap: true,
-        allowSyntheticDefaultImports: true,
-        experimentalDecorators: true,
-      },
-    },
-    null,
-    2,
-  )
-  if (!fs.existsSync(tsconfigPath)) {
-    fs.writeFileSync(tsconfigPath, tsconfigContent.trimStart())
-    console.log(`Created: ${tsconfigPath}`)
-  } else {
-    console.log(`Skipped: ${tsconfigPath} already exists`)
-  }
-}
+import { setupTsciProject } from "lib/shared/setup-tsci-packages"
+import { generateTsConfig } from "lib/shared/generate-ts-config"
 
 export const registerClone = (program: Command) => {
   program
@@ -56,120 +11,92 @@ export const registerClone = (program: Command) => {
     .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) {
+      const match = snippetPath.match(/^(?:@tsci\/)?([^/.]+)[/.](.+)$/)
+      if (!match) {
         console.error(
-          "Invalid snippet path. Use format: author/snippetName, author.snippetName or @tsci/author.snippetName",
+          "Invalid snippet path. Use format: author/snippetName, author.snippetName, or @tsci/author.snippetName",
         )
         process.exit(1)
       }
 
-      const ky = getKy()
+      const [, author, snippetName] = match
+      console.log(`Cloning ${author}/${snippetName}...`)
 
+      const ky = getKy()
+      let packageFileList
       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,
+        packageFileList = await ky
+          .post<{ package_files: Array<{ file_path: string }> }>(
+            "package_files/list",
+            {
+              json: {
+                package_name: `${author}/${snippetName}`,
+                use_latest_version: true,
+              },
             },
-          })
+          )
           .json()
+      } catch (error) {
+        console.error(
+          "Failed to fetch package files:",
+          error instanceof Error ? error.message : error,
+        )
+        process.exit(1)
+      }
 
-        // Create directory if it doesn't exist
-        const dirPath = `./${author}.${snippetName}`
-        if (!fs.existsSync(dirPath)) {
-          fs.mkdirSync(dirPath)
-        }
+      const dirPath = path.resolve(`${author}.${snippetName}`)
+      fs.mkdirSync(dirPath, { recursive: true })
 
-        // 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
+      for (const fileInfo of packageFileList.package_files) {
+        const filePath = fileInfo.file_path.replace(/^\/|dist\//g, "")
+        if (!filePath) continue
 
-          if (filePath.startsWith("dist/")) continue
+        const fullPath = path.join(dirPath, filePath)
+        fs.mkdirSync(path.dirname(fullPath), { recursive: true })
 
+        try {
           const fileContent = await ky
-            .post<{
-              package_file: {
-                content_text: string
-              }
-            }>("package_files/get", {
-              json: {
-                package_name: `${author}/${snippetName}`,
-                file_path: fileInfo.file_path,
+            .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)
+          let fileText = fileContent.package_file.content_text
 
-          // Create nested directories if they don't exist
-          if (!fs.existsSync(dirName)) {
-            fs.mkdirSync(dirName, { recursive: true })
+          // Ensure all .tsx files contain "import '@tscircuit/core';"
+          if (
+            filePath.endsWith(".tsx") &&
+            !fileText.includes("@tscircuit/core")
+          ) {
+            fileText = `import "@tscircuit/core";\n\n${fileText}`
           }
 
-          fs.writeFileSync(fullPath, fileContent.package_file.content_text)
+          fs.writeFileSync(fullPath, fileText)
+        } catch (error) {
+          console.warn(
+            `Skipping ${filePath} due to error:`,
+            error instanceof Error ? error.message : error,
+          )
         }
+      }
 
-        const npmrcPath = path.join(dirPath, ".npmrc")
-        fs.writeFileSync(npmrcPath, "@tsci:registry=https://npm.tscircuit.com")
-
-        // Generate tsconfig.json
-        generateTsConfig(dirPath)
-
-        // Detect package manager and install dependencies
-        const packageManager = detectPackageManager()
-        console.log(`Detected package manager: ${packageManager}`)
+      fs.writeFileSync(
+        path.join(dirPath, ".npmrc"),
+        "@tsci:registry=https://npm.tscircuit.com",
+      )
 
-        // Install deps using the detected package manager
-        const dependencies = "@types/react @tscircuit/core"
-        try {
-          console.log("Installing dependencies...")
-          const installCommand =
-            packageManager === "yarn"
-              ? `cd ${dirPath} && yarn add -D ${dependencies}`
-              : packageManager === "pnpm"
-                ? `cd ${dirPath} && pnpm add -D ${dependencies}`
-                : packageManager === "bun"
-                  ? `cd ${dirPath} && bun add -D ${dependencies}`
-                  : `cd ${dirPath} && npm install -D ${dependencies}`
-          execSync(installCommand, { stdio: "inherit" })
-          console.log("Dependencies installed successfully.")
-        } catch (error) {
-          console.error("Failed to install dependencies:", error)
-        }
+      generateTsConfig(dirPath)
+      setupTsciProject(dirPath)
 
-        console.log(`Successfully cloned to ./${author}.${snippetName}/`)
-        console.log(`Run "cd ${dirPath} && tsci dev" to start developing.`)
-      } 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)
-      }
+      console.log(`Successfully cloned to ${dirPath}/`)
+      console.log(
+        `Run "cd ${path.dirname(dirPath)} && tsci dev" to start developing.`,
+      )
     })
 }

package/cli/init/register.ts

@@ -1,136 +1,70 @@
 import type { Command } from "commander"
 import * as fs from "node:fs"
 import * as path from "node:path"
-import { execSync } from "node:child_process"
-
-// Detect the package manager being used in the project
-const detectPackageManager = (): string => {
-  const userAgent = process.env.npm_config_user_agent || ""
-  if (userAgent.startsWith("yarn")) return "yarn"
-  if (userAgent.startsWith("pnpm")) return "pnpm"
-  if (userAgent.startsWith("bun")) return "bun"
-
-  if (fs.existsSync("yarn.lock")) return "yarn"
-  if (fs.existsSync("pnpm-lock.yaml")) return "pnpm"
-  if (fs.existsSync("bun.lockb")) return "bun"
-
-  return "npm" // Default to npm
-}
-
-// Generate a React-compatible tsconfig.json
-const generateTsConfig = (dir: string) => {
-  const tsconfigPath = path.join(dir, "tsconfig.json")
-  const tsconfigContent = JSON.stringify(
-    {
-      compilerOptions: {
-        target: "ES6",
-        module: "ESNext",
-        jsx: "react-jsx",
-        outDir: "dist",
-        strict: true,
-        esModuleInterop: true,
-        moduleResolution: "node",
-        skipLibCheck: true,
-        forceConsistentCasingInFileNames: true,
-        resolveJsonModule: true,
-        sourceMap: true,
-        allowSyntheticDefaultImports: true,
-        experimentalDecorators: true,
-      },
-    },
-    null,
-    2,
-  )
-  if (!fs.existsSync(tsconfigPath)) {
-    fs.writeFileSync(tsconfigPath, tsconfigContent.trimStart())
-    console.log(`Created: ${tsconfigPath}`)
-  } else {
-    console.log(`Skipped: ${tsconfigPath} already exists`)
-  }
-}
+import { setupTsciProject } from "lib/shared/setup-tsci-packages"
+import { generateTsConfig } from "lib/shared/generate-ts-config"
+import { writeFileIfNotExists } from "lib/shared/write-file-if-not-exists"
 
 export const registerInit = (program: Command) => {
   program
     .command("init")
-    .description("Initialize a new TSCircuit project in the current directory")
-    .action(() => {
-      const currentDir = process.cwd()
-      const indexFilePath = path.join(currentDir, "index.tsx")
-      const npmrcFilePath = path.join(currentDir, ".npmrc")
+    .description(
+      "Initialize a new TSCircuit project in the specified directory (or current directory if none is provided)",
+    )
+    .argument(
+      "[directory]",
+      "Directory name (optional, defaults to current directory)",
+    )
+    .action((directory?: string) => {
+      const projectDir = directory
+        ? path.resolve(process.cwd(), directory)
+        : process.cwd()
+
+      // Ensure the directory exists
+      fs.mkdirSync(projectDir, { recursive: true })
 
-      // Content for index.tsx
-      const indexContent = `
-import "@tscircuit/core"
+      // Create essential project files
+      writeFileIfNotExists(
+        path.join(projectDir, "index.tsx"),
+        `
+import "@tscircuit/core";
 
 export default () => (
   <board width="10mm" height="10mm">
-    <resistor
-      resistance="1k"
-      footprint="0402"
-      name="R1"
-      schX={3}
-      pcbX={3}
-    />
-    <capacitor
-      capacitance="1000pF"
-      footprint="0402"
-      name="C1"
-      schX={-3}
-      pcbX={-3}
-    />
+    <resistor resistance="1k" footprint="0402" name="R1" schX={3} pcbX={3} />
+    <capacitor capacitance="1000pF" footprint="0402" name="C1" schX={-3} pcbX={-3} />
     <trace from=".R1 > .pin1" to=".C1 > .pin1" />
   </board>
 );
-`.trim()
+`,
+      )
 
-      // Content for .npmrc
-      const npmrcContent = `
+      writeFileIfNotExists(
+        path.join(projectDir, ".npmrc"),
+        `
 @tsci:registry=https://npm.tscircuit.com
-`.trim()
-
-      // Create index.tsx if it doesn't exist
-      if (!fs.existsSync(indexFilePath)) {
-        fs.writeFileSync(indexFilePath, indexContent.trimStart())
-        console.log(`Created: ${indexFilePath}`)
-      } else {
-        console.log(`Skipped: ${indexFilePath} already exists`)
-      }
-
-      // Create .npmrc if it doesn't exist
-      if (!fs.existsSync(npmrcFilePath)) {
-        fs.writeFileSync(npmrcFilePath, npmrcContent.trimStart())
-        console.log(`Created: ${npmrcFilePath}`)
-      } else {
-        console.log(`Skipped: ${npmrcFilePath} already exists`)
-      }
-
-      // Detect the package manager
-      const packageManager = detectPackageManager()
-      console.log(`Detected package manager: ${packageManager}`)
+`,
+      )
 
-      // Install deps using the detected package manager
-      const dependencies = "@types/react @tscircuit/core"
+      // Setup project dependencies
       try {
-        console.log("Installing dependencies...")
-        const installCommand =
-          packageManager === "yarn"
-            ? `yarn add -D ${dependencies}`
-            : packageManager === "pnpm"
-              ? `pnpm add -D ${dependencies}`
-              : packageManager === "bun"
-                ? `bun add -D ${dependencies}`
-                : `npm install -D ${dependencies}`
-        execSync(installCommand, { stdio: "inherit" })
-        console.log("Dependencies installed successfully.")
+        setupTsciProject(projectDir)
       } catch (error) {
         console.error("Failed to install dependencies:", error)
+        process.exit(1)
       }
 
       // Generate tsconfig.json
-      generateTsConfig(currentDir)
+      try {
+        generateTsConfig(projectDir)
+      } catch (error) {
+        console.error("Failed to generate tsconfig.json:", error)
+        process.exit(1)
+      }
 
-      console.log(
-        `Initialization complete. Run "tsci dev" to start developing.`,
+      console.info(
+        `🎉 Initialization complete! Run ${directory ? `"cd ${directory}" & ` : ""}"tsci dev" to start developing.`,
       )
+      process.exit(0)
     })
 }