ship18ion 1.1.3 → 1.2.1

package/walkthrough.md

@@ -1,51 +0,0 @@
-ship18ion - Production Readiness Inspector
-I have successfully built ship18ion, a CLI tool to check for production readiness.
-
-Features Implemented
-1. Environment Variable Safety
-Unused Variable Detection: Scans 
-
-.env
- files and code to find variables defined but never used.
-Missing Variable Detection: Identifies process.env.VAR usages that lack a corresponding definition in 
-
-.env
- (or config).
-Format Support: Supports 
-
-.env
-, .env.production files.
-Robust AST Parsing: Correctly detects process.env.VAR, import.meta.env.VAR (Vite), and process.env["VAR"].
-2. Secrets Detection
-Pattern Matching: Detects AWS Keys, Google API Keys, Stripe Keys, and generic private keys.
-Entropy Heuristics: Detects potential high-entropy strings assigned to "secret" or "key" variables.
-3. Framework & Security Checks
-Next.js Safety: Scans for NEXT_PUBLIC_ variables that appear to contain secrets (e.g. NEXT_PUBLIC_SECRET_KEY).
-Git Safety: Warns if deploying from a dirty working directory or a non-production branch.
-Debug Mode: Alerts on debug: true.
-CORS Wildcards: Fails if origin: '*' is detected.
-Database Credentials: Detects hardcoded connection strings.
-4. Dependency & Build Safety
-Dev Dependencies: Warns if eslint or other dev tools are in dependencies.
-Build Artifacts: Alerts if source maps (.map) or 
-
-.env
- files are found in build directories.
-Usage
-# In your project root
-npx ship18ion check
-# CI Mode (minimal output)
-npx ship18ion check --ci
-How to Ship & Share
-See 
-
-SHIPPING.md
- for detailed instructions on:
-
-Local Testing: Using npm link to test on your other projects instantly.
-Publishing: Pushing to NPM so anyone can use npx ship18ion.
-Architecture
-CLI: Built with commander.
-Engine: TypeScript-based rule engine.
-Parsing: Babel-based AST parsing.
-Config: ship18ion.config.json support.