db-hygiene 0.1.0

package/README.md

@@ -0,0 +1,61 @@
+# db-hygiene
+
+Scan databases and SQL dumps for PII & credentials; optionally anonymise with [anonymiser](https://www.npmjs.com/package/anonymiser). CLI-first, CI/CD friendly.
+
+## Install
+
+```bash
+npm install db-hygiene
+```
+
+Or run without installing:
+
+```bash
+npx db-hygiene <command>
+```
+
+## Commands
+
+| Command     | Description |
+|------------|-------------|
+| `scan`     | Detect PII and credentials (alias for `audit`) |
+| `audit`    | Same as `scan` — read-only, no writes |
+| `anonymise`| Run anonymisation (delegates to anonymiser) |
+| `report`   | Output report (human-readable or JSON) |
+
+## Usage
+
+```bash
+npx db-hygiene scan --config audit.config.js
+npx db-hygiene audit
+npx db-hygiene anonymise --config anonymiser.config.mjs
+npx db-hygiene report
+npx db-hygiene --help
+npx db-hygiene --version
+```
+
+## Exit codes
+
+| Code | Meaning |
+|------|---------|
+| `0`  | Clean / no findings |
+| `2`  | Findings present |
+| `1`  | Error |
+
+Use these in CI to fail pipelines when issues are found, e.g. `if [ $? -eq 2 ]; then exit 1; fi` or your runner’s equivalent.
+
+## CI example
+
+```yaml
+# GitHub Actions
+- run: npx db-hygiene scan --config audit.config.js
+- run: npx db-hygiene anonymise --config anonymiser.config.mjs
+```
+
+## Requirements
+
+- Node.js >= 18
+
+## License
+
+MIT

package/dist/cli.js

@@ -0,0 +1,69 @@
+#!/usr/bin/env node
+#!/usr/bin/env node
+
+// src/cli.ts
+var VERBS = ["scan", "audit", "anonymise", "report"];
+var EXIT = { ok: 0, findings: 2, error: 1 };
+function showHelp() {
+  console.log(`
+db-hygiene \u2013 scan DBs/SQL dumps for PII & credentials; optionally anonymise.
+
+Usage: db-hygiene <command> [options]
+
+Commands:
+  scan        Detect PII and credentials (alias for audit)
+  audit       Same as scan \u2013 read-only, no writes
+  anonymise   Run anonymisation (delegates to anonymiser)
+  report      Output report (human-readable or JSON)
+
+Exit codes:
+  0  Clean / no findings
+  2  Findings present
+  1  Error
+
+Examples:
+  npx db-hygiene scan --config audit.config.js
+  npx db-hygiene audit
+  npx db-hygiene anonymise --config anonymiser.config.mjs
+  npx db-hygiene report
+`);
+}
+async function main() {
+  const [, , verb] = process.argv;
+  const cmd = verb && verb.toLowerCase();
+  if (!cmd || cmd === "-h" || cmd === "--help") {
+    showHelp();
+    process.exit(EXIT.ok);
+  }
+  if (cmd === "-v" || cmd === "--version") {
+    try {
+      const { readFileSync } = await import("fs");
+      const { dirname } = await import("path");
+      const { fileURLToPath } = await import("url");
+      const p = dirname(fileURLToPath(import.meta.url));
+      const pkg = JSON.parse(readFileSync(p + "/../package.json", "utf8"));
+      console.log(pkg.version || "0.1.0");
+    } catch {
+      console.log("0.1.0");
+    }
+    process.exit(EXIT.ok);
+  }
+  if (!VERBS.includes(cmd)) {
+    console.error(`Unknown command: ${cmd}. Use: ${VERBS.join(", ")}`);
+    process.exit(EXIT.error);
+  }
+  if (cmd === "scan" || cmd === "audit") {
+    console.log(`db-hygiene: ${cmd} (no findings in stub)`);
+    process.exit(EXIT.ok);
+  }
+  if (cmd === "anonymise") {
+    console.log("db-hygiene: anonymise (stub \u2013 will delegate to anonymiser)");
+    process.exit(EXIT.ok);
+  }
+  if (cmd === "report") {
+    console.log("db-hygiene: report (stub)");
+    process.exit(EXIT.ok);
+  }
+  process.exit(EXIT.ok);
+}
+main().catch(() => process.exit(EXIT.error));

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "db-hygiene",
+  "version": "0.1.0",
+  "description": "Scan databases and SQL dumps for PII & credentials; optionally anonymise with anonymiser. CLI-first, CI/CD friendly.",
+  "type": "module",
+  "main": "dist/index.js",
+  "bin": {
+    "db-hygiene": "dist/cli.ts"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "node esbuild.mjs",
+    "prepublishOnly": "npm run build",
+    "dev": "node src/cli.ts"
+  },
+  "keywords": [
+    "pii",
+    "credentials",
+    "secrets",
+    "database",
+    "audit",
+    "anonymise",
+    "ci",
+    "db-hygiene"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "devDependencies": {
+    "esbuild": "^0.24.0",
+    "tsx": "^4.21.0"
+  }
+}