fuzzrunx 0.1.6 → 0.2.0

package/README.md

@@ -2,33 +2,34 @@
 
 Auto-correct mistyped commands/subcommands and re-run them automatically (no prompt) when the fix is high-confidence (edit distance 1 or the CLI provides a single suggestion). Base command corrections skip dangerous commands like `rm` or `mv`.
 
-### Quick run
-
-```
-node bin/fuzzrun.js git commmmit -m "msg"
-```
-
-Install (npm):
-
-```
-npm i -g fuzzrunx
-```
-
-On install, FuzzRun auto-enables shell hooks and will print:
-`FuzzRun is automatically enabled. Run "fuzzrun disable" to deactivate.`
-
-If you want to skip auto-enable, set `FUZZRUN_SKIP_ENABLE=1` during install.
-If auto-enable didn't run (scripts disabled or local install), running any command with `fuzzrun` will attempt a one-time auto-enable unless `FUZZRUN_SKIP_ENABLE=1` is set.
-
-### Bash/Zsh hook (auto-run on typos)
-
-Add to your shell rc:
-
-```bash
-FUZZRUN_BIN="/absolute/path/to/bin/fuzzrun.js"
-fuzzrun() { node "$FUZZRUN_BIN" "$@"; }
-command_not_found_handle() { fuzzrun "$@"; }
-git() { fuzzrun git "$@"; } # optional: wrap git to auto-fix subcommands
+### Quick run
+
+```
+node bin/fuzzrun.js git commmmit -m "msg"
+```
+
+Install (npm):
+
+```
+npm i -g fuzzrunx
+```
+
+On install, FuzzRun auto-enables shell hooks and will print:
+`FuzzRun is automatically enabled. Run "fuzzrun disable" to deactivate.`
+
+If you want to skip auto-enable, set `FUZZRUN_SKIP_ENABLE=1` during install.
+If auto-enable didn't run (scripts disabled or local install), running any command with `fuzzrun` will attempt a one-time auto-enable unless `FUZZRUN_SKIP_ENABLE=1` is set.
+On uninstall, FuzzRun automatically removes its shell hooks.
+
+### Bash/Zsh hook (auto-run on typos)
+
+Add to your shell rc:
+
+```bash
+FUZZRUN_BIN="/absolute/path/to/bin/fuzzrun.js"
+fuzzrun() { node "$FUZZRUN_BIN" "$@"; }
+command_not_found_handle() { fuzzrun "$@"; }
+git() { fuzzrun git "$@"; } # optional: wrap git to auto-fix subcommands
 ```
 
 Notes: `command_not_found_handle` is bash-only; on zsh use `command_not_found_handler`. Keep `FUZZRUN_BIN` absolute.
@@ -37,20 +38,32 @@ Notes: `command_not_found_handle` is bash-only; on zsh use `command_not_found_ha
 
 Append to `Documents\PowerShell\Microsoft.PowerShell_profile.ps1`:
 
-```powershell
-$fuzzrun = "C:\Users\HP\fuzzRun\bin\fuzzrun.js" # update path
-function global:fuzzrun { node $fuzzrun @args }
-$ExecutionContext.InvokeCommand.CommandNotFoundAction = {
+```powershell
+$fuzzrun = "C:\Users\HP\fuzzRun\bin\fuzzrun.js" # update path
+function global:fuzzrun { node $fuzzrun @args }
+$ExecutionContext.InvokeCommand.CommandNotFoundAction = {
     param($commandName, $eventArgs)
     fuzzrun $commandName @($eventArgs.Arguments)
 }
-function global:git { fuzzrun git @args } # optional git wrapper
-```
-
-### Manage hooks
-- `fuzzrun enable` (add hooks to your shell profile)
-- `fuzzrun disable` (remove hooks)
-- `fuzzrun status` (show which profiles are enabled)
+function global:git { fuzzrun git @args } # optional git wrapper
+```
+
+### Manage hooks
+- `fuzzrun enable` (add hooks to your shell profile)
+- `fuzzrun disable` (remove hooks)
+- `fuzzrun status` (show which profiles are enabled)
+
+### Preview & stats
+- `fuzzrun explain <command...>` — show the fix it *would* apply without running anything (dry-run). `fuzzrun --dry-run <command...>` works too.
+- `fuzzrun stats` — see how many commands FuzzRun has rescued, broken down by type, plus your most frequent typos.
+
+FuzzRun **learns**: every accepted correction is remembered in `~/.fuzzrun/state.json`, and that history is used to break ambiguous ties in favor of fixes you've chosen before.
+
+### Output & prompting
+- Corrections are printed in color with a `⚡` marker. Set `NO_COLOR=1` (or `FUZZRUN_NO_COLOR=1`) to disable color; `FUZZRUN_FORCE_COLOR=1` to force it.
+- By default, edit-distance-1 fixes auto-run and weaker (distance ≥ 2) fixes ask first.
+  - `FUZZRUN_PROMPT=1` — always ask before applying any fix.
+  - `FUZZRUN_YES=1` — never ask; auto-run every fix.
 
 ### How it works
 - Runs the command once; if it fails with "command not found" or "unknown subcommand", tries a one-edit-away fix or the CLI's own suggestion and re-runs automatically.
@@ -58,11 +71,12 @@ function global:git { fuzzrun git @args } # optional git wrapper
 - Skips auto-run when risky flags are present (`--force`, `--hard`, `-rf`, etc.) and blocks dangerous bases (`rm`, `mv`, `dd`, etc.).
 - Subcommand suggestions are preloaded for popular CLIs (git, npm/yarn/pnpm, pip, docker, kubectl, gh) plus "did you mean" parsing.
 - Context-aware fixes for `git checkout/switch <branch>` and `npm/yarn/pnpm run <script>` after a failure.
+- Fuzzy flag correction for common long flags (e.g. `git commit --mesage` → `--message`); never corrects *into* a destructive flag.
 
-### Config
-- `FUZZRUN_MAX_DISTANCE=1` (set to 2 if you want more aggressive matching)
-- `FUZZRUN_ALLOW_ANY_SUBCOMMANDS=1` (allow subcommand fixes for any base that prints suggestions)
-- `FUZZRUN_PREFER_BASES=git,npm,docker` (breaks ties in favor of preferred commands)
+### Config
+- `FUZZRUN_MAX_DISTANCE=1` (set to 2 if you want more aggressive matching)
+- `FUZZRUN_ALLOW_ANY_SUBCOMMANDS=1` (allow subcommand fixes for any base that prints suggestions)
+- `FUZZRUN_PREFER_BASES=git,npm,docker` (breaks ties in favor of preferred commands)
 
 ### Limits
 - Only one retry; only unique matches; no prompt.

package/bin/fuzzrun.js

@@ -1,6 +1,6 @@
-#!/usr/bin/env node
-'use strict';
-
-const { main } = require('../src/cli');
-
-main();
+#!/usr/bin/env node
+'use strict';
+
+const { main } = require('../src/cli');
+
+main();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fuzzrunx",
-  "version": "0.1.6",
+  "version": "0.2.0",
   "description": "Auto-correct mistyped commands and subcommands and re-run them safely.",
   "bin": {
     "fuzzrun": "bin/fuzzrun.js"
@@ -9,6 +9,8 @@
   "license": "MIT",
   "scripts": {
     "start": "node bin/fuzzrun.js",
-    "postinstall": "node scripts/postinstall.js"
+    "test": "node --test",
+    "postinstall": "node scripts/postinstall.js",
+    "postuninstall": "node scripts/postuninstall.js"
   }
 }

package/scripts/postinstall.js

@@ -1,36 +1,36 @@
-'use strict';
-
-const fs = require('fs');
-const os = require('os');
-const path = require('path');
-const installer = require('../src/installer');
-
-const skip = process.env.FUZZRUN_SKIP_ENABLE === '1';
-
-function getStatePath() {
-  return path.join(os.homedir(), '.fuzzrun', 'state.json');
-}
-
-function writeState(next) {
-  const filePath = getStatePath();
-  fs.mkdirSync(path.dirname(filePath), { recursive: true });
-  fs.writeFileSync(filePath, JSON.stringify(next, null, 2), 'utf8');
-}
-
-if (skip) {
-  process.stderr.write('fuzzrun: auto-enable skipped\n');
-  process.exit(0);
-}
-
-const foregroundScripts =
-  process.env.npm_config_foreground_scripts === 'true' ||
-  process.env.npm_config_foreground_scripts === '1';
-
-try {
-  installer.enable({});
-  process.stderr.write('FuzzRun is automatically enabled. Run "fuzzrun disable" to deactivate.\n');
-  writeState({ bannerShown: foregroundScripts, enableSucceeded: true });
-} catch (err) {
-  process.stderr.write(`fuzzrun: auto-enable failed: ${err.message}\n`);
-  writeState({ bannerShown: false, enableSucceeded: false, lastError: err.message });
-}
+'use strict';
+
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+const installer = require('../src/installer');
+
+const skip = process.env.FUZZRUN_SKIP_ENABLE === '1';
+
+function getStatePath() {
+  return path.join(os.homedir(), '.fuzzrun', 'state.json');
+}
+
+function writeState(next) {
+  const filePath = getStatePath();
+  fs.mkdirSync(path.dirname(filePath), { recursive: true });
+  fs.writeFileSync(filePath, JSON.stringify(next, null, 2), 'utf8');
+}
+
+if (skip) {
+  process.stderr.write('fuzzrun: auto-enable skipped\n');
+  process.exit(0);
+}
+
+const foregroundScripts =
+  process.env.npm_config_foreground_scripts === 'true' ||
+  process.env.npm_config_foreground_scripts === '1';
+
+try {
+  installer.enable({});
+  process.stderr.write('FuzzRun is automatically enabled. Run "fuzzrun disable" to deactivate.\n');
+  writeState({ bannerShown: foregroundScripts, enableSucceeded: true });
+} catch (err) {
+  process.stderr.write(`fuzzrun: auto-enable failed: ${err.message}\n`);
+  writeState({ bannerShown: false, enableSucceeded: false, lastError: err.message });
+}

package/scripts/postuninstall.js

@@ -0,0 +1,10 @@
+'use strict';
+
+const installer = require('../src/installer');
+
+try {
+  installer.disable();
+  process.stderr.write('FuzzRun hooks removed. Restart your terminal if needed.\n');
+} catch (err) {
+  process.stderr.write(`fuzzrun: postuninstall cleanup failed: ${err.message}\n`);
+}