@tscircuit/cli 0.0.4 → 0.0.6

package/lib/cmd-fns/init/create-or-modify-npmrc.ts

@@ -0,0 +1,21 @@
+import { existsSync, writeFileSync } from "fs"
+import kleur from "kleur"
+import * as Path from "path"
+import { getGeneratedNpmrc } from "./get-generated-npmrc"
+import { AppContext } from "lib/util/app-context"
+
+export const createOrModifyNpmrc = async (
+  { quiet = true }: { quiet?: boolean },
+  ctx: AppContext
+) => {
+  const npmrcPath = Path.join(ctx.cwd, ".npmrc")
+
+  if (existsSync(npmrcPath)) {
+    // TODO check that @tsci registry is correctly set
+    if (!quiet) {
+      console.log(kleur.yellow("npmrc already exists, not doing anything"))
+    }
+  } else {
+    writeFileSync(npmrcPath, getGeneratedNpmrc(ctx))
+  }
+}

package/lib/cmd-fns/init/get-generated-npmrc.ts

@@ -0,0 +1,8 @@
+import { AppContext } from "lib/util/app-context"
+
+export const getGeneratedNpmrc = (ctx: AppContext) =>
+  `
+
+@tsci:registry=${ctx.registry_url}/npm
+
+`.trim()

package/lib/cmd-fns/init/get-generated-readme.ts

@@ -0,0 +1,34 @@
+export const getGeneratedReadme = ({
+  name,
+  shouldHaveProjectGeneratedNotice = false,
+}: {
+  name: string
+  shouldHaveProjectGeneratedNotice?: boolean
+}) => {
+  return `
+# ${name}
+${
+  shouldHaveProjectGeneratedNotice
+    ? `\n\n> This project was generated using [tsci](https://github.com/tscircuit/tscircuit)\n`
+    : ""
+}
+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\`
+  
+  
+`.trim()
+}

package/lib/cmd-fns/init/get-generated-tsconfig.ts

@@ -0,0 +1,34 @@
+export const getGeneratedTsconfig = () =>
+  `
+
+{
+  "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()

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

@@ -1,4 +1,4 @@
-import { AppContext } from "../util/app-context"
+import { AppContext } from "../../util/app-context"
 import { z } from "zod"
 import {
   readFileSync,
@@ -10,6 +10,10 @@ import {
 } from "fs"
 import * as Path from "node:path"
 import $ from "dax-sh"
+import { getGeneratedReadme } from "./get-generated-readme"
+import { getGeneratedTsconfig } from "./get-generated-tsconfig"
+import { getGeneratedNpmrc } from "./get-generated-npmrc"
+import { createOrModifyNpmrc } from "./create-or-modify-npmrc"
 
 export const initCmd = async (ctx: AppContext, args: any) => {
   const params = z
@@ -59,6 +63,9 @@ export const initCmd = async (ctx: AppContext, args: any) => {
     await $`${pkm} add -D typescript tsx`
   }
 
+  // TODO just allow adding "tscircuit" in the future
+  await $`${pkm} add -D @tscircuit/react-fiber @tscircuit/builder`
+
   console.log("Changing package name...")
   // Change package.json "name" to params.name
   const packageJson = JSON.parse(readFileSync("package.json", "utf-8"))
@@ -66,11 +73,14 @@ export const initCmd = async (ctx: AppContext, args: any) => {
   writeFileSync("package.json", JSON.stringify(packageJson, null, 2))
 
   console.log(`Adding ".tscircuit" to .gitignore`)
-  appendFileSync(".gitignore", "\n.tscircuit", {
+  appendFileSync(".gitignore", "\n.tscircuit\n*.__tmp_entrypoint.tsx\ndist", {
     encoding: "utf-8",
-    flag: "w+",
+    flag: "a+",
   })
 
+  console.log("Add .npmrc with tscircuit registry...")
+  await createOrModifyNpmrc({ quiet: false }, ctx)
+
   console.log("Creating lib and examples directories...")
   mkdirSync("examples", { recursive: true })
   mkdirSync("lib", { recursive: true })
@@ -104,69 +114,14 @@ export const MyExample = () => (
   // 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()
+    getGeneratedReadme({
+      name: params.name!,
+      shouldHaveProjectGeneratedNotice: true,
+    })
   )
 
   // 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()
-  )
+  writeFileSync("tsconfig.json", getGeneratedTsconfig())
 
-  console.log("Done! Run `tsck dev` to start developing!")
+  console.log("Done! Run `tsci dev` to start developing!")
 }

package/lib/cmd-fns/install.ts

@@ -0,0 +1,34 @@
+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 installCmd = async (ctx: AppContext, args: any) => {
+  const params = z
+    .object({
+      packages: z.array(z.string()),
+      flags: z
+        .object({ dev: z.boolean().optional().default(false) })
+        .optional()
+        .default({}),
+    })
+    .parse(args)
+
+  params.packages = params.packages.map((p) => p.replace(/^@/, ""))
+
+  await createOrModifyNpmrc({ quiet: true }, ctx)
+
+  $.cd(ctx.cwd)
+
+  const flagsString = params.flags.dev ? "--dev" : ""
+
+  const cmd = `npm install ${flagsString} ${params.packages
+    .map((p) => `@tsci/${p.replace(/\//, ".")}`)
+    .join(" ")}`
+  console.log(kleur.gray(`> ${cmd}`))
+
+  await $`npm install ${flagsString} ${params.packages
+    .map((p) => `@tsci/${p.replace(/\//, ".")}`)
+    .join(" ")}`
+}

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(" ")}`
+}