@siddhaartha_bs/monkcli 0.1.0

package/README.md

@@ -0,0 +1,92 @@
+# monkcli
+
+CLI typing test inspired by Monkeytype.
+
+## Requirements
+
+- Node.js 20+
+- npm
+
+## Install
+
+### npm
+
+```bash
+npm install -g @siddhaartha_bs/monkcli
+monkcli
+```
+
+### npx
+
+```bash
+npx @siddhaartha_bs/monkcli
+```
+
+## Upgrade
+
+```bash
+npm install -g @siddhaartha_bs/monkcli@latest
+```
+
+## Uninstall
+
+```bash
+npm uninstall -g @siddhaartha_bs/monkcli
+```
+
+## Source Development
+
+```bash
+npm install
+npm run build
+node ./bin/monkcli.mjs
+```
+
+For interactive local development without a full rebuild:
+
+```bash
+npm run dev
+```
+
+## If `monkcli` Is Not Found
+
+This is usually a PATH issue with your npm global bin directory.
+
+```bash
+npm prefix -g
+```
+
+Make sure the corresponding bin directory is on your PATH:
+
+- Linux: `$(npm prefix -g)/bin`
+- macOS: `$(npm prefix -g)/bin`
+- Windows: the prefix directory reported by `npm prefix -g`
+
+## Where Data Is Stored
+
+`monkcli` writes three files:
+- `results.json` (test history)
+- `stats.json` (running totals + average WPM/accuracy)
+- `settings.json` (saved language/mode/options)
+
+Default locations:
+
+- Linux:
+  - results/stats: `~/.local/state/monkcli/`
+  - settings: `~/.config/monkcli/`
+- macOS:
+  - results/stats/settings: `~/Library/Application Support/monkcli/`
+- Windows:
+  - results/stats: `%LOCALAPPDATA%\\monkcli\\`
+  - settings: `%APPDATA%\\monkcli\\`
+
+Overrides:
+- `MONKCLI_DATA_DIR` overrides results + stats directory.
+- `MONKCLI_CONFIG_DIR` overrides settings directory.
+
+## Docker (Optional)
+
+```bash
+docker build -t monkcli:local .
+docker run --rm -it monkcli:local
+```

package/bin/monkcli.mjs

@@ -0,0 +1,59 @@
+#!/usr/bin/env node
+import { existsSync, readFileSync } from "node:fs";
+import { realpath } from "node:fs/promises";
+import path from "node:path";
+import { fileURLToPath, pathToFileURL } from "node:url";
+
+const thisFile = await realpath(fileURLToPath(import.meta.url));
+const binDir = path.dirname(thisFile);
+const packageDir = path.resolve(binDir, "..");
+const packageJsonPath = path.join(packageDir, "package.json");
+const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf8"));
+const entrypoint = path.join(packageDir, "dist", "monkcli.js");
+
+function printHelp() {
+  process.stdout.write(
+    [
+      "monkcli",
+      "",
+      "Usage:",
+      "  monkcli",
+      "  monkcli --help",
+      "  monkcli --version",
+      "",
+      "A terminal typing test inspired by Monkeytype.",
+      "",
+    ].join("\n"),
+  );
+}
+
+const args = process.argv.slice(2);
+if (args.includes("--help") || args.includes("-h")) {
+  printHelp();
+  process.exit(0);
+}
+
+if (args.includes("--version") || args.includes("-v")) {
+  process.stdout.write(`${packageJson.version}\n`);
+  process.exit(0);
+}
+
+if (!existsSync(entrypoint)) {
+  process.stderr.write(
+    [
+      "Error: monkcli is not built correctly.",
+      "",
+      "If you are developing locally, run:",
+      "  npm install",
+      "  npm run build",
+      "",
+    ].join("\n"),
+  );
+  process.exit(1);
+}
+
+if (!process.env.MONKCLI_ENGINE_DATA_DIR) {
+  process.env.MONKCLI_ENGINE_DATA_DIR = path.join(packageDir, "engine-data");
+}
+
+await import(pathToFileURL(entrypoint).href);