foxguard 0.3.1 → 0.3.3

package/README.md

@@ -1,52 +1,41 @@
 # foxguard
 
-Fast local security guard for changed files, built-in rules, and Semgrep-compatible YAML. Written in Rust.
+Sub-second local security scanning for real codebases.
 
-This is the npm wrapper for foxguard. It downloads the correct prebuilt binary for your platform from GitHub Releases.
-
-foxguard scans JS/TS, Python, and Go with built-in security rules by default and can load a useful Semgrep-compatible YAML subset with `--rules`.
-Built-ins now cover local code risks like SSRF client variants, file/path traversal sinks, session/cookie misconfig, transport misconfig, and framework-specific auth issues.
-Current built-ins include Express/JWT/session lifecycle checks on JavaScript plus Flask/Django session, CSRF, Flask-WTF, host, redirect, and exemption hardening checks on Python.
+```sh
+npx foxguard .
+```
 
-Use `--rules` to add external rules on top of the built-ins. Use `--no-builtins --rules ...` for an external-rules-only compatibility run.
+## Why people use it
 
-It also includes a dedicated `secrets` mode for common leaked credentials and private key material, with redacted output, binary-file skipping, and baseline-safe suppression data.
-Secrets mode also supports path-scoped excludes and per-rule ignores for fixtures, generated files, or intentionally fake tokens.
-foxguard can also auto-discover a repo config file such as `.foxguard.yml` for shared baselines, rule paths, and secrets defaults.
-The Semgrep-compatible subset also supports regex clauses like `pattern-regex` and `pattern-not-regex`.
-It also supports rule-level path filters like `paths.include` and `paths.exclude`.
-It also supports `metavariable-regex` for filtering bound metavariables in structural rules.
-It also supports `pattern-not-inside` for excluding safe wrapper contexts.
+- Fast enough to run locally instead of waiting for CI
+- Useful built-in rules out of the box across 10 languages
+- Semgrep-compatible YAML subset when you already have existing rules
+- JSON and SARIF output for automation
 
-Local-first workflow:
+It scans for SQL injection, XSS, SSRF, hardcoded secrets, command injection, weak crypto, unsafe deserialization, and framework-specific mistakes.
 
-```sh
-npx foxguard --changed .
-npx foxguard secrets --changed .
-npx foxguard baseline --output .foxguard/baseline.json
-npx foxguard init
-```
+**Languages:** JavaScript, TypeScript, Python, Go, Ruby, Java, PHP, Rust, C#, Swift
 
-`foxguard init` also writes a starter `.foxguard.yml` when the repo does not already have one.
+## How it works
 
-## Usage
+This is the npm wrapper. It downloads the correct prebuilt Rust binary for your platform from GitHub Releases and caches it locally.
 
 ```sh
-npx foxguard .
+npx foxguard .                    # scan everything
+npx foxguard --changed .          # only modified files
+npx foxguard secrets .            # leaked credentials
+npx foxguard --format sarif .     # SARIF for GitHub Code Scanning
+npx foxguard init                 # install pre-commit hook
 ```
 
-Or install globally:
-
-```sh
-npm install -g foxguard
-foxguard .
-```
+## Scope
 
-## How it works
+foxguard is built around fast local feedback.
 
-1. If foxguard is installed via `cargo install foxguard`, the npm wrapper uses that binary directly.
-2. Otherwise, it downloads the prebuilt binary for your platform from GitHub Releases.
-3. The binary is cached in `node_modules/.cache/foxguard/` for subsequent runs.
+- built-in rules are the default product
+- Semgrep/OpenGrep-compatible YAML is the adoption bridge
+- full external-rule-engine parity is intentionally out of scope
 
 ## Supported platforms
 
@@ -54,6 +43,8 @@ foxguard .
 - Linux (x64, arm64)
 - Windows (x64)
 
-## Full documentation
+## More
 
-See the [main repository](https://github.com/peaktwilight/foxguard) for full documentation, rules reference, and configuration options.
+- [GitHub](https://github.com/peaktwilight/foxguard)
+- [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=peaktwilight.foxguard)
+- [foxguard.dev](https://foxguard.dev)

package/bin/foxguard

@@ -65,7 +65,12 @@ function findCargoInstall() {
       encoding: "utf8",
     }).trim();
     if (result && !result.includes("node_modules")) {
-      return result;
+      // Resolve symlinks to avoid finding ourselves (the npm wrapper)
+      const resolved = fs.realpathSync(result);
+      const thisScript = fs.realpathSync(__filename);
+      if (resolved !== thisScript) {
+        return result;
+      }
     }
   } catch {}
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "foxguard",
-  "version": "0.3.1",
-  "description": "Security scanner as fast as a linter. 118 built-in rules, 10 languages, sub-second scans.",
+  "version": "0.3.3",
+  "description": "Security scanner as fast as a linter. 100+ built-in rules, 10 languages, sub-second scans.",
   "license": "MIT",
   "repository": {
     "type": "git",