🚢 deployguard

A lightweight CLI tool that scans your project before deployment and detects common production issues.

✨ What it does

Run npx @amrendrasharma/deployguard in any Node.js project before you deploy and get an instant health check:

──────────────────────────────────────────────────────────────────────────
  🚢 deployguard v1.0.0 — Pre-deployment project scanner
──────────────────────────────────────────────────────────────────────────

  Scanning: /Users/you/my-project

  ✔  Scanning for console.log statements...
  ✔  Checking environment variables...
  ✔  Checking for unused dependencies...
  ✔  Scanning for large files (> 5MB)...

──────────────────────────────────────────────────────────────────────────
  Results

  ⚠   Found 3 console.log statement(s) — remove before deploying
  ⚠     → src/routes/auth.js:42
  ⚠     → src/utils/debug.js:7
  ⚠     → src/utils/debug.js:18
  ⚠   2 env var(s) from .env not found in environment:
  ⚠     → STRIPE_SECRET_KEY is not set
  ⚠     → SENDGRID_API_KEY is not set
  ✔  All dependencies appear to be in use
  ⚠   1 large file(s) found — consider adding to .gitignore:
  ⚠     → assets/promo-video.mp4 (87.3 MB)

──────────────────────────────────────────────────────────────────────────

  ⚠  Deployment Readiness Score: 62/100
     Several issues need attention

     [████████████████████████░░░░░░░░░░░░░░░░] 62%

──────────────────────────────────────────────────────────────────────────

🚀 Quick Start

Run without installing:

npx @amrendrasharma/deployguard

Or install globally:

npm install -g @amrendrasharma/deployguard
deployguard

Scan a specific directory:

deployguard --dir ./my-app

📦 Installation

# Install globally
npm install -g @amrendrasharma/deployguard

# Or use as a dev dependency
npm install --save-dev @amrendrasharma/deployguard

🔍 Checks Performed

| Check | Points | What it detects | |-------|--------|-----------------| | console.log | 25 pts | console.log() statements left in .js, .ts, .jsx, .tsx files | | Environment Variables | 25 pts | Variables in .env that aren't set in the current environment | | Unused Dependencies | 25 pts | Packages in package.json that aren't imported anywhere in source code | | Large Files | 25 pts | Any file over 5MB (accidentally committed assets, DB dumps, etc.) |

Scoring

| Score | Status | |-------|--------| | 90–100 | 🚀 Ready to ship! | | 70–89 | ⚠ Minor issues to fix | | 50–69 | ⚠ Several issues need attention | | 0–49 | ✖ Not ready for deployment |

🔧 CLI Options

Options:
  -d, --dir <path>   Target directory to scan (default: current directory)
  --no-color         Disable colored output (useful for CI logs)
  --debug            Show verbose error information
  -v, --version      Output the current version
  -h, --help         Show help information

📂 Project Structure

deployguard/
├── bin/
│   └── cli.js              # CLI entry point (Commander.js setup, orchestration)
├── checks/
│   ├── consoleCheck.js     # Scans for console.log statements
│   ├── envCheck.js         # Verifies .env variables are set
│   ├── dependencyCheck.js  # Detects unused npm dependencies
│   └── sizeCheck.js        # Finds files larger than 5MB
├── utils/
│   ├── display.js          # Terminal output (banner, colors, score display)
│   ├── helpers.js          # Pure utility functions (formatBytes, truncatePath)
│   └── score.js            # Final score calculation
├── package.json
├── README.md
└── .gitignore

🏗️ Adding to Your Workflow

npm script (recommended)

Add to your package.json:

{
  "scripts": {
    "precheck": "deployguard",
    "deploy": "deployguard && your-deploy-command"
  }
}

GitHub Actions

# .github/workflows/deployguard.yml
name: Pre-deploy Check

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  deployguard:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
      - run: npm ci
      - run: npx @amrendrasharma/deployguard --no-color

🤝 Contributing

1. Fork the repository: github.com/amrendrasharma1328-a11y/shipcheck
2. Create your feature branch: git checkout -b feat/new-check
3. Commit your changes: git commit -m 'feat: add secretsCheck'
4. Push and open a Pull Request

👨‍💻 Author

Amrendra Sharma

• npm: @amrendrasharma
• GitHub: amrendrasharma1328-a11y

📄 License

MIT © Amrendra Sharma