@tscircuit/cli 0.0.5 → 0.0.6

package/lib/cmd-fns/publish/index.ts

@@ -0,0 +1,296 @@
+import kleur from "kleur"
+import { z } from "zod"
+import { AppContext } from "../../util/app-context"
+import * as Path from "path"
+import * as fs from "fs/promises"
+import { readFileSync } from "fs"
+import { getAllPackageFiles } from "lib/util/get-all-package-files"
+import prompts from "prompts"
+import { getGeneratedReadme } from "../init/get-generated-readme"
+import { soupify } from "../../soupify"
+import { inferExportNameFromSource } from "../dev/infer-export-name-from-source"
+import $ from "dax-sh"
+import semver from "semver"
+import { unlink } from "fs/promises"
+
+export const publish = async (ctx: AppContext, args: any) => {
+  const params = z
+    .object({
+      increment: z.boolean().optional(),
+      patch: z.boolean().optional(),
+      lock: z.boolean().optional(),
+    })
+    .parse(args)
+  if (typeof Bun === "undefined") {
+    console.log(
+      kleur.red(
+        "\n\n----------------------------------\nBun is currently required for publishing packages to the tscircuit registry. Try installing bun:\nhhttps://bun.sh/docs/installation\n\n---------------------"
+      )
+    )
+    process.exit(1)
+  }
+
+  const shouldIncrement = params.increment || params.patch
+
+  if (!(await fs.exists(Path.join(ctx.cwd, "package.json")))) {
+    console.log(kleur.red("No package.json found in current directory"))
+    process.exit(1)
+  }
+
+  const packageJson = JSON.parse(
+    await readFileSync(Path.join(ctx.cwd, "package.json"), "utf-8")
+  )
+
+  // TODO possibly use esbuild here, it's got stuff like packages: "external"
+  await Bun.build({
+    root: ctx.cwd,
+    // TODO determine entrypoint in a more clever way e.g.
+    // - package.json "main"
+    entrypoints: ["index.ts"],
+
+    // Everything should be external since it's a node module, esbuild has a
+    // packages: "external" option for this
+    external: [
+      ...Object.keys(packageJson.dependencies || {}),
+      ...Object.keys(packageJson.devDependencies || {}),
+      ...Object.keys(packageJson.peerDependencies || {}),
+      ...Object.keys(packageJson.trustedDependencies || {}),
+    ],
+
+    outdir: "dist",
+
+    target: "node",
+  })
+
+  // Publish to npm??
+
+  // Upload to tscircuit registry
+  // 1. Get the package name and version from package.json
+  let { name, version } = packageJson
+  name = name.replace(/^@/, "") // remove leading @ if it exists
+  // 2.1 Check if package already exists, if it doesn't, create it
+  const existingPackage = await ctx.axios
+    .post("/packages/get", { name })
+    .then((r) => r.data.package)
+    .catch((e) => {
+      if (e.response?.data?.error?.error_code === "package_not_found")
+        return null
+      throw e
+    })
+
+  if (!existingPackage) {
+    if (!packageJson.name.includes("/")) {
+      console.log(
+        kleur.yellow(
+          `Package name "${packageJson.name}" is not scoped. Scoped package names are recommended on the tscircuit registry.`
+        )
+      )
+      const myAccount = await ctx.axios
+        .get("/accounts/get")
+        .then((r) => r.data.account)
+      const newScopedName = `${myAccount.github_username}/${packageJson.name}`
+
+      const { confirmNameChange } = await prompts({
+        type: "confirm",
+        name: "confirmNameChange",
+        initial: true,
+        message: `Would you like to change the package name to the scoped name "@${newScopedName}"?`,
+      })
+
+      if (confirm === undefined) {
+        console.log(kleur.red("Aborted."))
+        process.exit(1)
+      }
+
+      if (confirmNameChange) {
+        packageJson.name = `@${newScopedName}`
+        await fs.writeFile(
+          Path.join(ctx.cwd, "package.json"),
+          JSON.stringify(packageJson, null, 2)
+        )
+        name = newScopedName
+      }
+    }
+
+    console.log(
+      kleur.green(
+        `Creating package "${packageJson.name}" on tscircuit registry...`
+      )
+    )
+    let description = packageJson.description
+    if (!description) {
+      description = (
+        await prompts({
+          type: "text",
+          name: "description",
+          message: "Enter a description for the package",
+        })
+      ).description
+    }
+    await ctx.axios
+      .post("/packages/create", { name, description })
+      .then((r) => r.data.package)
+  }
+  // 2.2 Check if package release already exists
+  const existingRelease = await ctx.axios
+    .post("/package_releases/get", {
+      package_name_with_version: `${name}@${version}`,
+    })
+    .then((r) => r.data.package_release)
+    .catch((e) => {
+      if (e.response?.data?.error?.error_code === "package_release_not_found")
+        return null
+      throw e
+    })
+  // 3. If it does, ask to increment the version or update the existing release, if increment is specified, increment the version automatically
+  if (existingRelease) {
+    console.log(
+      kleur.gray(`Package release already exists: ${name}@${version}`)
+    )
+    if (shouldIncrement) {
+      console.log(
+        kleur.green(
+          `Incrementing version from ${version} to ${semver.inc(
+            version,
+            "patch"
+          )}...`
+        )
+      )
+      version = semver.inc(version, "patch")
+      packageJson.version = version
+      await fs.writeFile(
+        Path.join(ctx.cwd, "package.json"),
+        JSON.stringify(packageJson, null, 2)
+      )
+    } else {
+      console.log(
+        kleur.blue(
+          `Want to increment the version and publish a new release? Use "--increment"!`
+        )
+      )
+
+      throw new Error("Package release already exists")
+    }
+  }
+  // 4. Create new package_release
+  const newRelease = await ctx.axios
+    .post("/package_releases/create", {
+      package_name_with_version: `${name}@${version}`,
+      is_latest: false, // only make it latest when locking
+    })
+    .then((r) => r.data.package_release)
+  // 5. Upload package_files
+  const filePaths = await getAllPackageFiles(ctx)
+  if (!filePaths.includes("README.md")) {
+    console.log(
+      kleur.yellow(
+        "No README.md found in package files. A README.md is recommended on the tscircuit registry."
+      )
+    )
+    const { confirmReadme } = await prompts({
+      type: "confirm",
+      name: "confirmReadme",
+      initial: true,
+      message: "Would you like to add a README.md?",
+    })
+
+    if (confirmReadme === undefined) {
+      console.log(kleur.red("Aborted."))
+      process.exit(1)
+    }
+
+    if (confirmReadme) {
+      await fs.writeFile(
+        Path.join(ctx.cwd, "README.md"),
+        getGeneratedReadme({ name })
+      )
+      filePaths.push("README.md")
+    }
+  }
+
+  for (const filePath of filePaths) {
+    const fileContent = await fs.readFile(Path.join(ctx.cwd, filePath))
+
+    await ctx.axios
+      .post("/package_files/create", {
+        file_path: filePath,
+        content_text: fileContent.toString(),
+        package_name_with_version: `${name}@${version}`,
+      })
+      .then((r) => r.data.package_file)
+  }
+  // 6. Upload package_examples
+  const exampleFilePaths = filePaths.filter((fp) => fp.startsWith("examples/"))
+  for (const filePath of exampleFilePaths) {
+    const fileContent = (
+      await fs.readFile(Path.join(ctx.cwd, filePath))
+    ).toString()
+
+    const exportName = inferExportNameFromSource(fileContent)
+
+    const tscircuit_soup = await soupify({
+      filePath,
+      exportName,
+    }).catch((e) => e)
+
+    if (tscircuit_soup instanceof Error) {
+      console.log(
+        kleur.red(`Error soupifying ${filePath}: ${tscircuit_soup}, skipping`)
+      )
+      continue
+    }
+
+    await ctx.axios
+      .post("/package_examples/create", {
+        file_path: filePath,
+        package_name_with_version: `${name}@${version}`,
+        export_name: exportName,
+        source_content: fileContent,
+        tscircuit_soup,
+      })
+      .then((r) => r.data.package_example)
+  }
+
+  // 7. Create tarball and upload
+  const tmpTarballPath = Path.join(
+    ctx.cwd,
+    ".tscircuit/tmp",
+    `${name.replace(/\//g, "-")}-${version}.tgz`
+  )
+  await fs.mkdir(Path.dirname(tmpTarballPath), { recursive: true })
+  const npm_pack_outputs = await $`cd ${
+    ctx.cwd
+  } && npm pack --json --pack-destination ${Path.dirname(
+    tmpTarballPath
+  )}`.json()
+
+  if (!(await fs.exists(tmpTarballPath))) {
+    console.log(kleur.red(`Couldn't find tarball at ${tmpTarballPath}`))
+    process.exit(1)
+  }
+
+  // Upload tarball
+  await ctx.axios.post("/package_files/create", {
+    file_path: `.tscircuit-internal/tarball.tgz`,
+    content_base64: (await fs.readFile(tmpTarballPath)).toString("base64"),
+    package_name_with_version: `${name}@${version}`,
+    is_release_tarball: true,
+    npm_pack_output: npm_pack_outputs?.[0],
+  })
+
+  // Clean up .tscircuit/tmp
+  await unlink(tmpTarballPath)
+
+  // 8. Lock/set release to latest version
+  await ctx.axios.post("/package_releases/update", {
+    package_name_with_version: `${name}@${version}`,
+    is_locked: params.lock ? true : false,
+    is_latest: true,
+  })
+
+  console.log(
+    kleur.green(
+      `Published ${name}@${version}!\nhttps://registry.tscircuit.com/${name}`
+    )
+  )
+}

package/lib/cmd-fns/remove.ts

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

package/lib/cmd-fns/uninstall.ts

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

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("tsck")
+  const cmd = new Command("tsci")
 
   cmd.version(packageJson.version)
 
@@ -139,7 +139,7 @@ export const getProgram = (ctx: AppContext) => {
 
   packageFiles
     .command("upload-directory")
-    .requiredOption("--directory <directory>", "Directory to upload")
+    .requiredOption("--dir <dir>", "Directory to upload")
     .action((args) => CMDFN.packageFilesUploadDirectory(ctx, args))
 
   const packageExamples = cmd.command("package_examples")
@@ -159,11 +159,16 @@ export const getProgram = (ctx: AppContext) => {
     .option("--export <export>", "Name of export to soupify")
     .action((args) => CMDFN.packageExamplesCreate(ctx, args))
 
-  cmd.command("publish").action((args) => CMDFN.publish(ctx, args))
+  cmd
+    .command("publish")
+    .option("--increment", "Increase patch version")
+    .option("--patch", "Increase patch version")
+    .option("--lock", "Lock the release after publishing to prevent changes")
+    .action((args) => CMDFN.publish(ctx, args))
 
   cmd
     .command("version")
-    .action(() => console.log(`tsck v${packageJson.version}`))
+    .action(() => console.log(`tsci v${packageJson.version}`))
 
   cmd.command("login").action((args) => CMDFN.authLogin(ctx, args))
   cmd.command("logout").action((args) => CMDFN.authLogout(ctx, args))
@@ -196,9 +201,45 @@ export const getProgram = (ctx: AppContext) => {
     )
     .action((args) => CMDFN.init(ctx, args))
 
-  cmd.command("add").action((args) => {})
-  cmd.command("remove").action((args) => {})
-  cmd.command("install").action((args) => {})
+  cmd
+    .command("add")
+    .argument(
+      "<packages...>",
+      "Packages to install from registry.tscircuit.com, optionally with version"
+    )
+    .option("-D, --dev", "Add to devDependencies")
+    .action((packages, flags) => CMDFN.add(ctx, { packages, flags }))
+
+  cmd
+    .command("remove")
+    .argument("<packages...>", "Packages to remove")
+    .action((packages, flags) => CMDFN.remove(ctx, { packages, flags }))
+
+  cmd
+    .command("install")
+    .argument(
+      "<packages...>",
+      "Packages to install from registry.tscircuit.com, optionally with version"
+    )
+    .option("-D, --dev", "Add to devDependencies")
+    .action((packages, flags) => CMDFN.install(ctx, { packages, flags }))
+
+  cmd
+    .command("uninstall")
+    .argument("<packages...>", "Packages to uninstall")
+    .action((packages, flags) => CMDFN.install(ctx, { packages, flags }))
+
+  const devServerCmd = cmd.command("dev-server")
+
+  devServerCmd
+    .command("upload")
+    .option(
+      "--dir <dir>",
+      "Directory to upload (defaults to current directory)"
+    )
+    .option("-w, --watch", "Watch for changes")
+    .option("-p, --port", "Port dev server is running on (default: 3020)")
+    .action((args) => CMDFN.devServerUpload(ctx, args))
 
   return cmd
 }

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("tsck")
+  const global_config = new Configstore("tsci")
   const current_profile =
     args.profile ?? global_config.get("current_profile") ?? "default"
   const profile_config: typeof global_config = {

package/lib/util/get-all-package-files.ts

@@ -0,0 +1,35 @@
+import * as fs from "fs/promises"
+import { AppContext } from "./app-context"
+import * as Glob from "glob"
+import ignore from "ignore"
+
+/**
+ * Get all package files
+ *
+ * Package files are any files that aren't explicitly ignored in the
+ * .npmignore (or if that doesn't exist, the .gitignore). All package
+ * files must have a .ts or .tsx extension.
+ *
+ * Returns an array of files paths.
+ */
+export const getAllPackageFiles = async (
+  ctx: AppContext
+): Promise<Array<string>> => {
+  const gitignore = await fs
+    .readFile("./.gitignore")
+    .then((b) => b.toString().split("\n").filter(Boolean))
+    .catch((e) => null)
+
+  const npmignore = await fs
+    .readFile("./.promptignore")
+    .then((b) => b.toString().split("\n").filter(Boolean))
+    .catch((e) => null)
+
+  const ig = ignore().add([
+    ...(npmignore ?? gitignore ?? []),
+    ".tscircuit",
+    "node_modules/*",
+  ])
+
+  return Glob.globSync("**/*.{ts,tsx,md}", {}).filter((fp) => !ig.ignores(fp))
+}

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@tscircuit/cli",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "private": false,
   "type": "module",
   "description": "Command line tool for developing, publishing and installing tscircuit circuits",
   "main": "./dist/cli.js",
   "scripts": {
+    "bootstrap": "bun i && cd dev-server-api && bun i && cd ../dev-server-frontend && bun i",
     "start": "bun cli.ts",
     "start:dev-server:dev": "TSCI_DEV_SERVER_DB=$(pwd)/.tscircuit/dev-server.db concurrently 'cd dev-server-api && bun start' 'cd dev-server-frontend && bun start'",
     "start:dev-server": "bun build:dev-server && bun cli.ts dev -y --cwd ./tests/assets/example-project",
@@ -16,8 +17,7 @@
   },
   "bin": {
     "tscircuit": "./dist/cli.js",
-    "tsci": "./dist/cli.js",
-    "tsck": "./dist/cli.js"
+    "tsci": "./dist/cli.js"
   },
   "keywords": [],
   "author": "",
@@ -35,7 +35,9 @@
     "dax-sh": "^0.39.2",
     "delay": "^6.0.0",
     "edgespec": "^0.0.69",
+    "glob": "^10.3.10",
     "hono": "^4.1.0",
+    "ignore": "^5.3.1",
     "kleur": "^4.1.5",
     "kysely-bun-sqlite": "^0.3.2",
     "lodash": "^4.17.21",
@@ -43,9 +45,10 @@
     "minimist": "^1.2.8",
     "node-persist": "^4.0.1",
     "open": "^10.1.0",
-    "perfect-cli": "1.0.13",
+    "perfect-cli": "^1.0.16",
     "prompts": "^2.4.2",
     "react": "^18.2.0",
+    "semver": "^7.6.0",
     "zod": "latest"
   },
   "devDependencies": {
@@ -58,9 +61,10 @@
     "@types/node": "^20.10.6",
     "@types/prompts": "^2.4.9",
     "@types/react": "^18.2.64",
+    "@types/semver": "^7.5.8",
     "ava": "^6.1.1",
     "concurrently": "^8.2.2",
     "tsx": "^4.7.1",
     "typescript": "^5.3.3"
   }
-}
+}

package/tests/assets/example-project/README.md

@@ -0,0 +1,18 @@
+# seveibar/example-project-3
+
+To develop and view the examples, run `tsci 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 `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`

package/tests/assets/example-project/index.ts

@@ -0,0 +1 @@
+export * from "./src/MyCircuit"

package/tests/assets/example-project/package.json

@@ -1,6 +1,7 @@
 {
   "name": "example-project",
-  "version": "1.2.3",
+  "version": "1.2.26",
+  "main": "dist/index.js",
   "dependencies": {
     "@tscircuit/builder": "^1.5.4",
     "@tscircuit/react-fiber": "^1.0.6"

package/tests/init.test.ts

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