create-mushi-mushi 0.4.0 → 0.5.0

package/README.md

@@ -10,9 +10,17 @@ yarn create mushi-mushi
 bun create mushi-mushi
 ```
 
-Auto-detects your framework (Next.js, Nuxt, SvelteKit, Angular, Expo, Capacitor, plain React/Vue/Svelte, vanilla JS), installs the right `@mushi-mushi/*` SDK, writes your env vars, and prints the snippet to drop into your app.
+## What it does
 
-This is a **scaffold for existing projects** — it does not generate a new app from scratch. To add Mushi to an app you already have, run it from the project root.
+1. **Detects your framework** — Next.js, Nuxt, SvelteKit, Angular, Expo, Capacitor, plain React/Vue/Svelte, or vanilla JS.
+2. **Picks the right SDK** — `@mushi-mushi/react`, `@mushi-mushi/vue`, `@mushi-mushi/svelte`, `@mushi-mushi/angular`, `@mushi-mushi/react-native`, `@mushi-mushi/capacitor`, or `@mushi-mushi/web`.
+3. **Detects your package manager** — uses `npm`, `pnpm`, `yarn`, or `bun` based on your lockfile.
+4. **Writes env vars** — `MUSHI_PROJECT_ID` and `MUSHI_API_KEY` land in `.env.local` with the right framework prefix (`NEXT_PUBLIC_`, `NUXT_PUBLIC_`, `VITE_`).
+5. **Warns about `.gitignore`** — won't ship secrets if your env file isn't ignored.
+6. **Prints the provider snippet** — framework-specific code to paste in.
+7. **Sends a test report** (opt-in) — closes the loop so you see your first classified bug immediately.
+
+This is a **scaffold for existing projects** — it does not generate a new app from scratch. Run it from the project root of an existing app.
 
 ## Flags
 
@@ -20,22 +28,42 @@ This is a **scaffold for existing projects** — it does not generate a new app
 npm create mushi-mushi -- --framework next
 npm create mushi-mushi -- --project-id proj_xxx --api-key mushi_xxx
 npm create mushi-mushi -- --skip-install
+npm create mushi-mushi -- --skip-test-report
+npm create mushi-mushi -- --cwd apps/web
+npm create mushi-mushi -- --endpoint https://mushi.your-company.com
 npm create mushi-mushi -- -y
 npm create mushi-mushi -- --help
 ```
 
-## Equivalent
+> `npm create` and `pnpm create` need the `--` separator before flags. Yarn 1 and Bun do not.
+
+## Equivalent commands
 
 ```bash
-npx mushi-mushi               # same wizard, shorter to type
-npx @mushi-mushi/cli init     # same wizard, scoped name
+npx mushi-mushi               # shorter
+npx @mushi-mushi/cli init     # scoped name
 ```
 
+## Troubleshooting
+
+- **Wrong framework detected?** Pass `--framework <id>` explicitly. Valid IDs: `next, react, vue, nuxt, svelte, sveltekit, angular, expo, react-native, capacitor, vanilla`.
+- **Running in a monorepo?** `cd` into the package you want Mushi in first, or pass `--cwd apps/web`.
+- **`npx` cache serving an old version?** Run `npm cache clean --force` or `npx mushi-mushi@latest`.
+- **Non-interactive (CI)?** Pass all of `--yes`, `--project-id`, and `--api-key`. The wizard exits with a clear error otherwise.
+- **Key pasted with quotes/whitespace?** The wizard strips them, but still validates against `mushi_[A-Za-z0-9_-]{10,}` / `proj_[A-Za-z0-9_-]{10,}`.
+
+## Security
+
+- Credentials accepted via `--api-key` flag leak into `ps -ef`. Prefer the interactive prompt on dev machines; on CI, pass them via the environment and an explicit `--api-key "$MUSHI_API_KEY"` at the boundary.
+- The `~/.mushirc` credentials cache is written with mode `0o600` (owner read/write only) on Unix.
+- All env-file writes strip CR/LF/NUL from secrets to prevent accidental `.env` injection.
+
 ## Links
 
-- 🌐 [Console](https://kensaur.us/mushi-mushi/)
-- 📦 [GitHub](https://github.com/kensaurus/mushi-mushi)
-- 📚 [Docs](https://github.com/kensaurus/mushi-mushi#readme)
+- [Console](https://kensaur.us/mushi-mushi/)
+- [GitHub](https://github.com/kensaurus/mushi-mushi)
+- [Docs](https://github.com/kensaurus/mushi-mushi#readme)
+- [Report a bug](https://github.com/kensaurus/mushi-mushi/issues)
 
 ## License
 

package/dist/index.js

@@ -2,44 +2,46 @@
 
 // src/index.ts
 import { runInit } from "@mushi-mushi/cli/init";
+import { FRAMEWORK_IDS, isFrameworkId } from "@mushi-mushi/cli/detect";
+var VERSION = true ? "0.5.0" : "0.0.0-dev";
+var MIN_NODE_MAJOR = 18;
+var ISSUES_URL = "https://github.com/kensaurus/mushi-mushi/issues";
 var HELP = `create-mushi-mushi \u2014 add Mushi Mushi to your existing project
 
 Usage:
   npm create mushi-mushi              run the setup wizard
   npm create mushi-mushi -- --help    show all flags
 
+Note: \`npm create\` requires the \`--\` separator before flags.
+      \`yarn create mushi-mushi --help\` works without it on Yarn 1.
+      \`pnpm create mushi-mushi -- --help\` mirrors npm.
+      \`bun create mushi-mushi --help\` works without it.
+
 Flags (forwarded to the wizard):
   --project-id <id>            skip the project ID prompt
-  --api-key <key>              skip the API key prompt
-  --framework <id>             force a framework (next, react, vue, nuxt,
-                               svelte, sveltekit, angular, expo,
-                               react-native, capacitor, vanilla)
+  --api-key <key>              skip the API key prompt (CI only)
+  --framework <id>             force a framework (${FRAMEWORK_IDS.join(", ")})
   --skip-install               print the install command instead of running it
+  --skip-test-report           don't offer to send a test report at the end
+  --cwd <path>                 run in a different directory
+  --endpoint <url>             override the Mushi API endpoint (self-hosted)
   -y, --yes                    accept the detected framework without prompting
+  -v, --version                print the version and exit
 
 Docs:    https://github.com/kensaurus/mushi-mushi
 Console: https://kensaur.us/mushi-mushi/`;
-var VALID_FRAMEWORKS = [
-  "next",
-  "react",
-  "vue",
-  "nuxt",
-  "svelte",
-  "sveltekit",
-  "angular",
-  "expo",
-  "react-native",
-  "capacitor",
-  "vanilla"
-];
 function parseArgs(args) {
-  const out = { showHelp: false };
+  const out = { showHelp: false, showVersion: false };
   for (let i = 0; i < args.length; i++) {
     const a = args[i];
     if (a === "-h" || a === "--help") {
       out.showHelp = true;
       continue;
     }
+    if (a === "-v" || a === "--version") {
+      out.showVersion = true;
+      continue;
+    }
     if (a === "-y" || a === "--yes") {
       out.yes = true;
       continue;
@@ -48,6 +50,10 @@ function parseArgs(args) {
       out.skipInstall = true;
       continue;
     }
+    if (a === "--skip-test-report") {
+      out.skipTestReport = true;
+      continue;
+    }
     if (a === "--project-id") {
       out.projectId = args[++i];
       continue;
@@ -56,10 +62,18 @@ function parseArgs(args) {
       out.apiKey = args[++i];
       continue;
     }
+    if (a === "--cwd") {
+      out.cwd = args[++i];
+      continue;
+    }
+    if (a === "--endpoint") {
+      out.endpoint = args[++i];
+      continue;
+    }
     if (a === "--framework") {
       const fw = args[++i];
-      if (!VALID_FRAMEWORKS.includes(fw)) {
-        throw new Error(`Unknown framework: ${fw}. Valid: ${VALID_FRAMEWORKS.join(", ")}`);
+      if (!isFrameworkId(fw)) {
+        throw new Error(`Unknown framework: ${fw}. Valid: ${FRAMEWORK_IDS.join(", ")}`);
       }
       out.framework = fw;
       continue;
@@ -70,16 +84,33 @@ function parseArgs(args) {
   }
   return out;
 }
+function assertNodeVersion() {
+  const major = Number(process.versions.node.split(".")[0]);
+  if (!Number.isFinite(major) || major < MIN_NODE_MAJOR) {
+    process.stderr.write(
+      `create-mushi-mushi requires Node.js ${MIN_NODE_MAJOR} or newer. You are on ${process.versions.node}.
+Upgrade Node (https://nodejs.org/) and try again.
+`
+    );
+    process.exit(1);
+  }
+}
 async function main() {
+  assertNodeVersion();
   let parsed;
   try {
     parsed = parseArgs(process.argv.slice(2));
   } catch (err) {
-    console.error(err instanceof Error ? err.message : String(err));
+    process.stderr.write(`${err instanceof Error ? err.message : String(err)}
+`);
     process.exit(1);
   }
   if (parsed.showHelp) {
-    console.log(HELP);
+    process.stdout.write(HELP + "\n");
+    return;
+  }
+  if (parsed.showVersion) {
+    process.stdout.write(VERSION + "\n");
     return;
   }
   await runInit({
@@ -87,10 +118,22 @@ async function main() {
     apiKey: parsed.apiKey,
     framework: parsed.framework,
     skipInstall: parsed.skipInstall,
-    yes: parsed.yes
+    yes: parsed.yes,
+    cwd: parsed.cwd,
+    endpoint: parsed.endpoint,
+    sendTestReport: parsed.skipTestReport ? false : void 0
   });
 }
 main().catch((err) => {
-  console.error(err instanceof Error ? err.message : String(err));
+  const message = err instanceof Error ? err.message : String(err);
+  process.stderr.write(`
+create-mushi-mushi: ${message}
+`);
+  if (process.env.DEBUG?.includes("mushi") && err instanceof Error && err.stack) {
+    process.stderr.write(err.stack + "\n");
+  }
+  process.stderr.write(`
+If this is a bug, please report it at ${ISSUES_URL}
+`);
   process.exit(1);
 });

package/package.json

@@ -1,19 +1,20 @@
 {
   "name": "create-mushi-mushi",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "license": "MIT",
   "description": "Run `npm create mushi-mushi` to add the Mushi Mushi bug-reporting SDK to your existing project — the wizard auto-detects your framework (React, Vue, Svelte, Angular, React Native, Expo, Capacitor) and installs the right package.",
   "bin": {
     "create-mushi-mushi": "./dist/index.js"
   },
   "dependencies": {
-    "@mushi-mushi/cli": "^0.4.0"
+    "@mushi-mushi/cli": "^0.5.0"
   },
   "devDependencies": {
     "@types/node": "^22.15.3",
     "eslint": "^10.2.0",
     "tsup": "^8.5.1",
     "typescript": "^6.0.2",
+    "vitest": "^4.1.4",
     "@mushi-mushi/eslint-config": "0.0.0"
   },
   "author": "Kenji Sakuramoto",
@@ -26,8 +27,13 @@
   "bugs": {
     "url": "https://github.com/kensaurus/mushi-mushi/issues"
   },
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/kensaurus"
+  },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "files": [
     "dist",
@@ -66,6 +72,7 @@
   "scripts": {
     "build": "tsup",
     "lint": "eslint src/",
+    "test": "vitest run",
     "typecheck": "tsc --noEmit"
   }
 }