@holistics/cli-core 0.4.1 → 0.5.0

package/README.md

@@ -8,3 +8,86 @@ The CLI core is using our private packages (such as aml, aml-std, etc...), so to
 1. We use `bun` to build all the dependencies into a single giant `commands.js` file.
 2. Publish this file to public npm registry (https://www.npmjs.com/package/@holistics/cli-core)
 3. The CLI app **directly download and use** the `commands.js` file from the npm registry. Note that it **won't** go through the normal package installation process e.g. `npm install` because it will fail since it cannot access private packages referenced by '@holistics/cli-core'
+
+## Publishing for cli-core
+
+Currently, for other packages, we publish to our private Github registry
+We need to change the publish flow to publish to the public npm registry instead.
+
+We also want to support `npm install` normally for this cli-core package
+
+This is the current package.json on npmjs.com:
+```
+{
+  "name": "@holistics/cli-core",
+  "type": "module",
+  "version": "0.2.9",
+  "files": [
+    "dist"
+  ],
+  "main": "src/commands.js",
+  "module": "src/commands.mjs",
+  "types": "src/commands.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/holistics/holistics-core.git",
+    "directory": "packages/cli-core"
+  },
+  "devDependencies": {
+    "tsx": "^4.19.3",
+    "typescript": "^5.6.2",
+    "@types/js-yaml": "^4.0.5",
+    "vitest": "^2.1.9",
+    "@holistics/configs": "0.2.3"
+  },
+  "dependencies": {
+    "@commander-js/extra-typings": "^13.1.0",
+    "@holistics/aml": "4.0.4",
+    "@holistics/aml-std": "2.58.0",
+    "axios": "^1.7.7",
+    "commander": "13.1.0",
+    "fast-glob": "^3.3.3",
+    "form-data": "^4.0.2",
+    "glob": "^11.0.1",
+    "js-yaml": "^4.1.0"
+  },
+  "scripts": {
+    "dev": "tsx src/cli.ts",
+    "build": "bun build src/commands.ts --outdir dist --target node --minify"
+  }
+}
+```
+
+One idea is to modify the `package.json` (in dist/, after bun build and before publishing to npm) to remove any @holistics packages
+Ok, I think we can remove all the dependencies since everything is already bundled into the `commands.js` file.
+
+Brief about our Circle CI flow (ci_config.template.yml)
+- Our CI step uses 2 workflows: build (test) and publish
+- Build workflow is handled by turbo_orb.yml.
+- Publish workflow is handled by pnpm_orb.yml. For cli-core, the publish step will publish to npmjs.com
+  -  npmjs.com requires a token set at `~/.npmrc` to publish
+
+
+Design the CI flow:
+- currently: generate_js_jobs.rb -> publish_js_packages (with proper flags) -> [pnpm_install, turbo_build, pnpm_publish]. This is for our internal private packages
+Also, each of our package has a `.holistics_ci.yml` at the root of the package to customize the CI flow.
+- for cli-core, there are 2 main differences: build via bun, and publish to npmjs.com
+  - Option 1: generate .npmrc inside the cli-core package to store the npmjs token, and hope that `pnpm publish` will use it and skip the root Github token.
+    Pros: reuse the current publish flow
+    Cons: it's very unclear about the places that the publish flow happens, can mistakenly publish internal packages to npmjs.com
+  - Option 2: create another job publish_js_packages_to_npmjs.com. Try to use whitelist to include packages that are allowed to publish to npmjs.com to avoid mistakenly publishing internal packages to npmjs.com
+    - generate_js_jobs.rb -> [publish_js_packages_to_npmjs.com, publish_js_packages] depending on the holistics_ci.yml. If it contains `publish_to_npmjs: true`, then use publish_js_packages_to_npmjs.com, otherwise use publish_js_packages
+
+
+## Context for Claude
+You only need to care about these folders:
+- .circleci/
+- packages/* (include packages/cli-core)
+
+The rest of the folders are not relevant to this task.
+
+The CircleCI flow is using dynamic job: the ci_config.template.yml predefine the jobs and the commands, then the generate_config.rb -> generate_js_jobs.rb generates the actual running jobs on CircleCI.
+
+## Tasks
+- Implement the new publish to npmjs.com flow in the ci_config.template.yml
+- The special build for cli-core is already handled inside that package, here we can only call the build command like the publish_js_packages job