@ui8kit/uxdx 0.1.1 → 0.1.3

package/README.md

@@ -1,20 +1,33 @@
 # UXDX
 
-CLI to accumulate operator and developer experience packs. One binary, two
-commands. Package name: [`@ui8kit/uxdx`](https://www.npmjs.com/package/@ui8kit/uxdx).
+CLI for operator files and SDLC harness packs. One binary (`uxdx`), two
+commands. Package: [`@ui8kit/uxdx`](https://www.npmjs.com/package/@ui8kit/uxdx).
 
-Homepage: [github.com/ui8kit/uxdx](https://github.com/ui8kit/uxdx)
+Repo: [github.com/ui8kit/uxdx](https://github.com/ui8kit/uxdx)
 
-```text
-npx @ui8kit/uxdx --help
-npx @ui8kit/uxdx project | p | -p | --project  [init] [--dir <path>] [--rules] [--force]
-npx @ui8kit/uxdx sdlc    | s | -s | --sdlc     [init] [--dir <path>] --level light|core|full [--force] [--no-install]
+## Run
+
+Prefer Bun (no Node `punycode` warning from `npx`):
+
+```bash
+bunx @ui8kit/uxdx --help
+bunx @ui8kit/uxdx -p
+bunx @ui8kit/uxdx -s --level light
 ```
 
-Same via Bun: `bunx @ui8kit/uxdx --help`.
+Same via npm (`@ui8kit/uxdx@0.1.3` or later; `0.1.2` shims do not run Node):
 
-The binary is still `uxdx`. After a local or global install you can call it
-without the scope:
+```bash
+npx @ui8kit/uxdx@latest --help
+npx @ui8kit/uxdx@latest -- -p
+npx @ui8kit/uxdx@latest -- -s --level light
+```
+
+`npx` may print `DEP0040` / `punycode`. That comes from npm’s Node, not this
+CLI. `--` keeps flags for `uxdx` (`npx` also has `-p`). Success still requires
+`uxdx: project init` or `uxdx: sdlc …` after the warning.
+
+After a local or global install the binary is unscoped:
 
 ```bash
 npm i -g @ui8kit/uxdx
@@ -24,15 +37,78 @@ npm i -D @ui8kit/uxdx
 npx uxdx --help
 ```
 
-- `project` writes `README.md`, `.gitignore`, `.cursorignore`, and `.manual/`.
-- `sdlc` copies a vendored harness pack into `.sdlc/`. `--level` is required.
-- After copy, `sdlc` runs `.sdlc/sdlc.sh install` unless `--no-install`.
+## Commands
+
+Aliases are equivalent. `init` is the default and may be omitted.
+
+```text
+uxdx [--help]
+uxdx project | p | -p | --project  [init] [--dir <path>] [--rules] [--force]
+uxdx sdlc    | s | -s | --sdlc     [init] [--dir <path>] --level light|core|full [--force] [--no-install]
+```
+
+| Flag | Command | Meaning |
+| --- | --- | --- |
+| `--dir <path>` | both | Target repo (default: cwd) |
+| `--force` | both | Overwrite files this tool owns |
+| `--rules` | `project` | Stub `.cursor/rules/uxdx.mdc` if missing |
+| `--level` | `sdlc` | Required: `light`, `core`, or `full` |
+| `--no-install` | `sdlc` | Copy `.sdlc/` only; skip `sdlc.sh install` |
+
+### `project` (`-p`)
+
+Writes the default operator layout. Existing filled files are left alone
+unless `--force`. If `.manual/` already exists, it is not touched.
+
+```bash
+bunx @ui8kit/uxdx -p
+bunx @ui8kit/uxdx -p --dir ./my-repo --rules
+```
+
+Creates or updates:
+
+- `README.md` (only if missing)
+- `.gitignore` (`.manual/*` + `!.manual/.gitkeep`)
+- `.cursorignore` (`.manual/`)
+- `.project/README.md` stub
+- `.manual/.gitkeep` (only if `.manual/` is missing)
 
-## Local
+Success:
+
+```text
+uxdx: project init in <dir>
+  README.md
+  .gitignore
+  .cursorignore
+  .project/
+  .manual/
+```
+
+### `sdlc` (`-s`)
+
+Copies one vendored pack into `.sdlc/`. `--level` is required (no silent
+`full`). Then runs `.sdlc/sdlc.sh install` unless `--no-install`.
+
+```bash
+bunx @ui8kit/uxdx -s --level light
+bunx @ui8kit/uxdx -s --level core --dir ./my-repo
+bunx @ui8kit/uxdx -s --level full --no-install
+```
+
+Do not stack two levels in one repo. Use `--force` only to replace a
+different level.
+
+Pack source: `packages/sdlc/harness/`.
+
+## This checkout
 
 ```bash
 bun install
 bun test
-bun run uxdx -- --help
 bun run build
+bun run uxdx -- --help
+bun run uxdx -- -p --help
+bun run uxdx -- -s --help
 ```
+
+`--` after `bun run uxdx` is required so flags go to the CLI, not to Bun.

package/dist/uxdx.mjs

@@ -1,5 +1,4 @@
-import { createRequire } from "node:module";
-var __require = /* @__PURE__ */ createRequire(import.meta.url);
+#!/usr/bin/env node
 
 // packages/cli/src/parse.ts
 var LEVELS = new Set(["light", "core", "full"]);
@@ -91,7 +90,7 @@ Usage:
   uxdx project | p | -p | --project  [init] [--dir <path>] [--rules] [--force]
   uxdx sdlc    | s | -s | --sdlc     [init] [--dir <path>] --level light|core|full [--force] [--no-install]
 
-  -p / --project   Scaffold README, ignores, and .manual/
+  -p / --project   Scaffold README, ignores, and .manual/.gitkeep if missing
   -s / --sdlc      Install an SDLC harness pack into .sdlc/
 
 Run uxdx project --help or uxdx sdlc --help for command flags.
@@ -141,6 +140,35 @@ function writeIfMissing(file, body, force) {
     return;
   writeFileSync(file, body);
 }
+function ensureManualGitignore(file) {
+  const block = `.manual/*
+!.manual/.gitkeep
+`;
+  if (!existsSync(file)) {
+    writeFileSync(file, block);
+    return;
+  }
+  const cur = readFileSync(file, "utf8");
+  const lines = cur.split(/\r?\n/);
+  if (lines.some((l) => l.trim() === ".manual/*")) {
+    ensureLine(file, "!.manual/.gitkeep", false);
+    return;
+  }
+  const withoutFull = lines.filter((l) => l.trim() !== ".manual/");
+  const next = withoutFull.join(`
+`);
+  const nl = next.endsWith(`
+`) || next.length === 0 ? "" : `
+`;
+  writeFileSync(file, `${next}${nl}${block}`);
+}
+function ensureManualDir(root) {
+  const dir = join(root, ".manual");
+  if (existsSync(dir))
+    return;
+  mkdirSync(dir, { recursive: true });
+  writeFileSync(join(dir, ".gitkeep"), "");
+}
 function initProject(opts) {
   const root = opts.dir;
   mkdirSync(root, { recursive: true });
@@ -150,7 +178,7 @@ function initProject(opts) {
   writeIfMissing(readme, `# ${name}
 `, opts.force);
   done.push("README.md");
-  ensureLine(join(root, ".gitignore"), ".manual/", opts.force);
+  ensureManualGitignore(join(root, ".gitignore"));
   done.push(".gitignore");
   ensureLine(join(root, ".cursorignore"), ".manual/", opts.force);
   done.push(".cursorignore");
@@ -161,7 +189,7 @@ function initProject(opts) {
 Operator notes for this repository. See \`intent.md\` when present.
 `, opts.force);
   done.push(".project/");
-  mkdirSync(join(root, ".manual"), { recursive: true });
+  ensureManualDir(root);
   done.push(".manual/");
   if (opts.rules) {
     const rulesDir = join(root, ".cursor", "rules");
@@ -288,9 +316,6 @@ function run(argv) {
     return 1;
   }
 }
-if (__require.main == __require.module) {
-  process.exit(run(process.argv));
-}
-export {
-  run
-};
+
+// packages/cli/src/bin.ts
+process.exit(run(process.argv));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ui8kit/uxdx",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "CLI to accumulate operator and developer experience packs",
   "type": "module",
   "bin": {
@@ -37,8 +37,8 @@
   "license": "MIT",
   "homepage": "https://github.com/ui8kit/uxdx",
   "scripts": {
-    "build": "bun build packages/cli/src/main.ts --outfile dist/uxdx.mjs --target node",
-    "uxdx": "bun packages/cli/src/main.ts",
+    "build": "bun build packages/cli/src/bin.ts --outfile dist/uxdx.mjs --target node",
+    "uxdx": "bun packages/cli/src/bin.ts",
     "test": "bun test",
     "prepack": "bun run build",
     "prepublishOnly": "bun test && bun run build",