shipready 1.7.0 → 1.8.1

package/README.md

@@ -11,6 +11,8 @@ shipready is a CLI for developers who build with AI and vibe-coding tools. It sc
 
 **No API key required. Works fully offline. No telemetry.**
 
+![shipready finds a hardcoded API key, moves it to .env automatically, and the score goes from 55 to 80](.github/assets/demo.gif)
+
 ## Why shipready exists
 
 AI coding tools are great at producing working code fast, but they routinely:
@@ -136,29 +138,37 @@ shipready fix --dry-run
 
 ```txt
 ╭──────────────────────────────────────────────────────────╮
-│ shipready v1.3.0                                         │
-│ project Next.js  ·  pm pnpm                              │
+│ shipready v1.8.0                                         │
+│ project Next.js  ·  pm npm                               │
 ╰──────────────────────────────────────────────────────────╯
 
-  Score  ████████████████████░░░░░░░░  72/100  almost there
+  Score  ███████████████░░░░░░░░░░░░░  55/100  not ready to ship
+  -8 weak README  ·  -6 no test script  ·  -25 hardcoded secret  ·  -6 TODO comments (3)
 
-  ✓ package.json  ok
-  ✓ README        ok
-  ✗ Env safety    .env.example missing (3 env vars used in code)
-  ✗                .env is not ignored by git
-  ✓ Secrets       No obvious secrets found
-  ✗ Git history   1 secret buried in git history (removed from code but still exposed)
-  ⚠ Code hygiene  4 TODO/FIXME comments found
-  ⚠                2 console.log calls found
-  ✓ .gitignore    ok
+  ✓ package.json  package.json found
+  ⚠               Missing scripts: test, lint
+  ✓ README        README.md found
+  ⚠               README looks thin - add installation and usage instructions
+  ℹ Env safety    No environment variables detected in code
+  ✗ Secrets       1 potential secret detected
+  ⚠               1 possible secret detected (lower confidence)
+  ⚠ Code hygiene  2 TODO/FIXME comments found
+  ⚠               1 console.log call found
+  ⚠ .gitignore    .gitignore missing entries: .env, .env.local, .next
 
   Next steps
-    1. Purge leaked secrets from git history (BFG or git filter-repo) and rotate them
-    2. Add .env to .gitignore
-    3. Create .env.example (run: shipready fix)
-    4. Remove debug logs and debugger statements before shipping
+    1. Rotate and remove hardcoded secrets immediately
+    2. Expand README with installation and usage sections
+    3. Add missing entries to .gitignore (run: shipready fix)
+    4. Add missing package.json scripts (build/test/lint)
+    5. Remove debug logs and debugger statements before shipping
+    6. Resolve TODO/FIXME comments or track them as issues
+
+  Run with --verbose to see file locations.
 ```
 
+Run `shipready fix` and the hardcoded key moves to `.env`, `.gitignore` gets patched, and the score jumps to 80 - see the [secret autofix](#secret-autofix) section.
+
 ## What it checks
 
 | Check | What it looks for |
@@ -242,6 +252,29 @@ console.log("startup banner"); // shipready-ignore
 
 For project-wide exceptions, prefer `secretAllowlist` in the config (see below) so the suppression is reviewable in one place.
 
+## Secret autofix
+
+`shipready fix` moves hardcoded secrets out of your code into `.env`:
+
+```js
+// before
+const githubToken = "ghp_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
+// after
+const githubToken = process.env.GITHUB_TOKEN;
+```
+
+The value lands in `.env` (gitignored), a placeholder lands in `.env.example`, and env var names are derived from your identifiers (`stripeApiKey` becomes `STRIPE_API_KEY`). TypeScript gets `process.env.NAME!` to keep strict mode compiling; Python gets `os.environ["NAME"]` with the `import os` added.
+
+It never breaks your program - a rewrite only happens when it is provably safe:
+
+- only complete quoted string literals are replaced; a password embedded in a database URL is flagged for manual restructuring instead
+- client-side code (`"use client"`, `import.meta.env`) is never rewritten - an env var would still ship to the browser, so shipready tells you to move the call behind a server endpoint
+- after rewriting, the file is re-scanned; if the secret somehow survived, the file is restored untouched
+- identical values across files map to one env var; name collisions get numeric suffixes; existing `.env` entries are never overwritten
+- if nothing in your project loads `.env` (no dotenv/Next.js/Vite), shipready tells you to run with `node --env-file=.env`
+
+Use `--dry-run` to preview every change first. Remember to rotate any key that was already pushed - moving it to `.env` does not un-leak it.
+
 ## Scoring
 
 The score starts at 100 and every deduction is itemized right under the score bar - the number is never a black box:
@@ -358,24 +391,6 @@ Catch secrets **before** they enter history at all — see [`shipready staged`](
 
 Use `--json` to feed the report into other tooling, or `--sarif` for anything that speaks SARIF.
 
-## Scoring
-
-Every project starts at 100 and loses points for issues:
-
-| Issue | Deduction |
-| --- | --- |
-| Missing package.json | -20 |
-| Missing README | -15 |
-| Weak README | -8 |
-| Missing build script | -8 |
-| Missing test script | -6 |
-| Missing .env.example (when env vars exist) | -10 |
-| .env not gitignored | -15 |
-| Possible secret | -25 each (max -50) |
-| TODO/debug leftovers | -2 each (max -15) |
-
-The score never goes below 0.
-
 ## Development
 
 ```bash

package/dist/cli.js

@@ -7,6 +7,7 @@ import { detectProject, runScan, scanFiles } from "./scanner.js";
 import { loadConfig } from "./config.js";
 import { fixAgentFiles } from "./fixers/agentFiles.js";
 import { fixEnvExample } from "./fixers/envExample.js";
+import { fixSecrets, projectLoadsDotenv } from "./fixers/secrets.js";
 import { fixGitignore } from "./fixers/gitignore.js";
 import { renderReport } from "./utils/report.js";
 import { toSarif } from "./utils/sarif.js";
@@ -47,12 +48,33 @@ function resolveRoot(dir) {
 async function applyFixes(root, force, dryRun = false) {
     const config = loadConfig(root);
     const project = await detectProject(root, config);
-    const { envUsages } = scanFiles(root, project.sourceFiles, config.secretAllowlist);
-    return [
-        fixEnvExample(root, envUsages, force, dryRun),
-        fixGitignore(root, dryRun),
+    const { envUsages, secrets } = scanFiles(root, project.sourceFiles, config.secretAllowlist);
+    const secretFix = fixSecrets(root, secrets, dryRun);
+    const handled = new Set(secretFix.results.map((r) => r.file));
+    const results = [
+        ...secretFix.results,
+        ...[fixEnvExample(root, envUsages, force, dryRun)].filter((r) => !(r.action === "skipped" && handled.has(r.file))),
+        fixGitignore(root, dryRun, project.framework, {
+            hasBuildScript: Boolean(project.scripts["build"]),
+            usesEnv: envUsages.length > 0 || secretFix.envAdditions.length > 0,
+        }),
         ...fixAgentFiles(root, project, force, dryRun),
     ];
+    for (const { finding, reason } of secretFix.manual) {
+        results.push({
+            file: finding.file,
+            action: "skipped",
+            reason: `secret at line ${finding.line} needs a manual fix: ${reason}`,
+        });
+    }
+    if (secretFix.envAdditions.length > 0 && !projectLoadsDotenv(root)) {
+        results.push({
+            file: ".env",
+            action: "skipped",
+            reason: "heads up: nothing loads .env automatically - run with `node --env-file=.env` (Node 20+) or add dotenv",
+        });
+    }
+    return results;
 }
 /** Reads the CLI's own version from its package.json (works from dist/ at runtime). */
 function ownVersion() {
@@ -152,7 +174,7 @@ export function buildProgram() {
     });
     program
         .command("fix")
-        .description("Apply safe automatic fixes (.env.example, .gitignore, agent files)")
+        .description("Apply safe automatic fixes (move secrets to .env, .env.example, .gitignore, agent files)")
         .argument("[path]", "project directory (defaults to current directory)")
         .option("-f, --force", "overwrite existing files")
         .option("--dry-run", "show what would change without writing anything")

package/dist/fixers/gitignore.js

@@ -1,13 +1,13 @@
-import { importantIgnoresFor, missingIgnoreEntries } from "../checks/gitignore.js";
+import { importantIgnoresFor, missingIgnoreEntries, } from "../checks/gitignore.js";
 import { readTextFile, writeTextFile } from "../utils/files.js";
 /** Adds missing important entries to .gitignore (creates it if absent). */
-export function fixGitignore(root, dryRun = false, framework) {
+export function fixGitignore(root, dryRun = false, framework, ctx) {
     const file = ".gitignore";
     const existing = readTextFile(root, file);
     if (existing === null) {
         const content = [
             "# Added by shipready",
-            ...importantIgnoresFor(framework),
+            ...importantIgnoresFor(framework, ctx),
             "",
         ].join("\n");
         if (!dryRun) {
@@ -15,7 +15,7 @@ export function fixGitignore(root, dryRun = false, framework) {
         }
         return { file, action: "created", dryRun, preview: content };
     }
-    const missing = missingIgnoreEntries(existing, framework);
+    const missing = missingIgnoreEntries(existing, framework, ctx);
     if (missing.length === 0) {
         return { file, action: "skipped", reason: "already complete" };
     }

package/dist/fixers/secrets.js

@@ -0,0 +1,269 @@
+import path from "node:path";
+import { scanContentForSecrets } from "../checks/secrets.js";
+import { fileExists, readTextFile, writeTextFile } from "../utils/files.js";
+/** File extensions where we know how to rewrite a string literal safely. */
+const CODE_EXTENSIONS = new Set([
+    ".js", ".jsx", ".ts", ".tsx", ".mjs", ".cjs", ".py",
+]);
+const QUOTES = new Set(["'", '"', "`"]);
+/**
+ * Converts an identifier (stripeKey, api_key, STRIPE_KEY) to
+ * SCREAMING_SNAKE_CASE for use as an env var name.
+ */
+function toEnvName(identifier) {
+    return identifier
+        .replace(/([a-z0-9])([A-Z])/g, "$1_$2")
+        .replace(/[^A-Za-z0-9]+/g, "_")
+        .replace(/^_+|_+$/g, "")
+        .toUpperCase();
+}
+/** Names too vague to stand alone as env vars. */
+const GENERIC_NAMES = new Set(["KEY", "TOKEN", "SECRET", "PASSWORD", "AUTH", "API_KEY"]);
+/** Derives an env var name from the secret's kind ("GitHub token" -> GITHUB_TOKEN). */
+function nameFromKind(kind) {
+    return toEnvName(kind);
+}
+/**
+ * Derives an env var name from the code context: the identifier being
+ * assigned right before the literal, falling back to the finding's kind.
+ */
+function deriveEnvName(linePrefix, kind) {
+    const m = linePrefix.match(/([A-Za-z_$][A-Za-z0-9_$]*)\s*["']?\s*[:=]\s*$/);
+    if (m) {
+        const name = toEnvName(m[1]);
+        // "key" or "token" alone says nothing - qualify it with the kind.
+        if (GENERIC_NAMES.has(name))
+            return nameFromKind(kind);
+        if (name.length >= 3)
+            return name;
+    }
+    return nameFromKind(kind);
+}
+/** Builds the language-appropriate replacement expression. */
+function replacementFor(file, envName) {
+    const ext = path.extname(file);
+    if (ext === ".py")
+        return `os.environ["${envName}"]`;
+    // Non-null assertion keeps TS strict mode compiling; at runtime the
+    // behavior matches plain JS (undefined if unset).
+    if (ext === ".ts" || ext === ".tsx")
+        return `process.env.${envName}!`;
+    return `process.env.${envName}`;
+}
+/** True when the file is client-bundle code where env vars still leak. */
+function looksLikeClientCode(content) {
+    return (/^\s*["']use client["']/m.test(content) || content.includes("import.meta.env"));
+}
+/** Ensures `import os` exists in a Python file, inserting it if needed. */
+function ensurePythonOsImport(lines) {
+    if (lines.some((l) => /^\s*(import os\b|from os\b)/.test(l)))
+        return;
+    // Insert after shebang / encoding comments, before the first real line.
+    let insertAt = 0;
+    while (insertAt < lines.length &&
+        (lines[insertAt].startsWith("#!") || /^#.*coding[:=]/.test(lines[insertAt]))) {
+        insertAt++;
+    }
+    lines.splice(insertAt, 0, "import os");
+}
+/**
+ * Moves hardcoded secrets out of source code into .env, replacing each
+ * literal with the language's env accessor.
+ *
+ * Safety rules - a replacement only happens when ALL hold, otherwise the
+ * finding is reported for manual fixing:
+ * - the file is a known code type (JS/TS family or Python)
+ * - the file is not client-bundle code (env vars still ship to the browser)
+ * - the secret is a COMPLETE quoted string literal, not a substring of one
+ *   (a password inside a URL needs restructuring, not substitution)
+ * - after rewriting, a re-scan of the file confirms the raw value is gone;
+ *   if not, the file is restored untouched
+ */
+export function fixSecrets(root, secrets, dryRun = false) {
+    const results = [];
+    const manual = [];
+    const envAdditions = [];
+    // Same raw value everywhere maps to one env var; name collisions with
+    // different values get numeric suffixes.
+    const valueToName = new Map();
+    const nameToValue = new Map();
+    // Pre-seed with existing .env so we never clobber an existing entry.
+    const existingEnv = readTextFile(root, ".env") ?? "";
+    for (const line of existingEnv.split("\n")) {
+        const m = line.match(/^([A-Z0-9_]+)=(.*)$/);
+        if (m)
+            nameToValue.set(m[1], m[2]);
+    }
+    const claimName = (wanted, value) => {
+        const known = valueToName.get(value);
+        if (known)
+            return known;
+        let name = wanted;
+        let n = 2;
+        while (nameToValue.has(name) && nameToValue.get(name) !== value) {
+            name = `${wanted}_${n++}`;
+        }
+        valueToName.set(value, name);
+        nameToValue.set(name, value);
+        return name;
+    };
+    const byFile = new Map();
+    for (const f of secrets) {
+        if (!f.raw)
+            continue;
+        const list = byFile.get(f.file) ?? [];
+        list.push(f);
+        byFile.set(f.file, list);
+    }
+    for (const [file, findings] of byFile) {
+        const ext = path.extname(file);
+        if (!CODE_EXTENSIONS.has(ext)) {
+            for (const f of findings) {
+                manual.push({ finding: f, reason: `unsupported file type (${ext || "no extension"}) - move the value manually` });
+            }
+            continue;
+        }
+        const original = readTextFile(root, file);
+        if (original === null) {
+            for (const f of findings)
+                manual.push({ finding: f, reason: "file unreadable" });
+            continue;
+        }
+        if (looksLikeClientCode(original)) {
+            for (const f of findings) {
+                manual.push({
+                    finding: f,
+                    reason: "client-side code - an env var would still ship to the browser; move this call behind a server endpoint",
+                });
+            }
+            continue;
+        }
+        const lines = original.split("\n");
+        const fixedNames = [];
+        let changed = false;
+        // Bottom-up so earlier line numbers stay valid if we insert imports.
+        const sorted = [...findings].sort((a, b) => b.line - a.line);
+        for (const f of sorted) {
+            const raw = f.raw;
+            const lineIdx = f.line - 1;
+            const line = lines[lineIdx];
+            if (line === undefined) {
+                manual.push({ finding: f, reason: "line not found (file changed since scan)" });
+                continue;
+            }
+            const idx = line.indexOf(raw);
+            if (idx === -1) {
+                manual.push({ finding: f, reason: "value not found on its line (file changed since scan)" });
+                continue;
+            }
+            const before = line[idx - 1];
+            const after = line[idx + raw.length];
+            const isWholeLiteral = before !== undefined && after !== undefined && before === after && QUOTES.has(before);
+            if (!isWholeLiteral) {
+                manual.push({
+                    finding: f,
+                    reason: "secret is embedded inside a larger string (e.g. a URL) - restructure it manually",
+                });
+                continue;
+            }
+            const envName = claimName(deriveEnvName(line.slice(0, idx - 1), f.kind), raw);
+            const replacement = replacementFor(file, envName);
+            lines[lineIdx] =
+                line.slice(0, idx - 1) + replacement + line.slice(idx + raw.length + 1);
+            envAdditions.push({ name: envName, value: raw });
+            fixedNames.push(envName);
+            changed = true;
+        }
+        if (!changed)
+            continue;
+        if (ext === ".py")
+            ensurePythonOsImport(lines);
+        const updated = lines.join("\n");
+        // Verification gate: the raw values must be gone from a fresh scan.
+        const stillLeaking = scanContentForSecrets(updated, file).some((s) => findings.some((f) => f.raw === s.raw && fixedNames.length > 0));
+        const rawsGone = findings
+            .filter((f) => f.raw && fixedNames.length > 0)
+            .every((f) => !updated.includes(f.raw) || manual.some((m) => m.finding === f));
+        if (stillLeaking || !rawsGone) {
+            // Restore and report rather than half-fix.
+            for (const f of findings) {
+                manual.push({ finding: f, reason: "post-fix verification failed - file left untouched" });
+            }
+            // Roll back env additions for this file.
+            for (const name of fixedNames) {
+                const value = nameToValue.get(name);
+                if (value !== undefined) {
+                    valueToName.delete(value);
+                    nameToValue.delete(name);
+                }
+                const i = envAdditions.findIndex((e) => e.name === name);
+                if (i !== -1)
+                    envAdditions.splice(i, 1);
+            }
+            continue;
+        }
+        if (!dryRun)
+            writeTextFile(root, file, updated);
+        results.push({
+            file,
+            action: "updated",
+            dryRun,
+            preview: fixedNames.map((n) => `-> ${replacementFor(file, n)}`).join("\n"),
+        });
+    }
+    // Write .env and .env.example additions.
+    if (envAdditions.length > 0) {
+        const uniqueAdditions = envAdditions.filter((e, i) => envAdditions.findIndex((x) => x.name === e.name) === i);
+        const newEnvLines = uniqueAdditions
+            .filter((e) => !new RegExp(`^${e.name}=`, "m").test(existingEnv))
+            .map((e) => `${e.name}=${e.value}`);
+        if (newEnvLines.length > 0) {
+            const envContent = existingEnv.length > 0
+                ? existingEnv.replace(/\n*$/, "\n") + newEnvLines.join("\n") + "\n"
+                : "# Managed by shipready - do not commit this file.\n" + newEnvLines.join("\n") + "\n";
+            if (!dryRun)
+                writeTextFile(root, ".env", envContent);
+            results.push({
+                file: ".env",
+                action: existingEnv ? "updated" : "created",
+                dryRun,
+                preview: newEnvLines.map((l) => l.replace(/=.*/, "=***")).join("\n"),
+            });
+        }
+        const existingExample = readTextFile(root, ".env.example") ?? "";
+        const newExampleLines = uniqueAdditions
+            .filter((e) => !new RegExp(`^${e.name}=`, "m").test(existingExample))
+            .map((e) => `${e.name}=`);
+        if (newExampleLines.length > 0) {
+            const exampleContent = existingExample.length > 0
+                ? existingExample.replace(/\n*$/, "\n") + newExampleLines.join("\n") + "\n"
+                : newExampleLines.join("\n") + "\n";
+            if (!dryRun)
+                writeTextFile(root, ".env.example", exampleContent);
+            results.push({
+                file: ".env.example",
+                action: fileExists(root, ".env.example") && existingExample ? "updated" : "created",
+                dryRun,
+                preview: newExampleLines.join("\n"),
+            });
+        }
+    }
+    return { results, envAdditions, manual };
+}
+/**
+ * True when the project will pick up .env automatically at runtime; when
+ * false the caller should tell the user how to load it.
+ */
+export function projectLoadsDotenv(root) {
+    const pkgRaw = readTextFile(root, "package.json");
+    if (!pkgRaw)
+        return false;
+    try {
+        const pkg = JSON.parse(pkgRaw);
+        const deps = { ...pkg.dependencies, ...pkg.devDependencies };
+        return Boolean(deps["dotenv"] || deps["next"] || deps["vite"] || deps["@dotenvx/dotenvx"]);
+    }
+    catch {
+        return false;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shipready",
-  "version": "1.7.0",
+  "version": "1.8.1",
   "description": "Pre-flight check for your repo before shipping. Scans AI-coded projects for secrets, env issues, debug leftovers, and generates AI-agent instruction files.",
   "type": "module",
   "license": "MIT",