Skip to content

RELEASE_NOTES.md

Latest commit

 

History

History
139 lines (102 loc) · 3.48 KB

RELEASE_NOTES.md

File metadata and controls

139 lines (102 loc) · 3.48 KB

envcheck-cli v1.0.0 Release Notes

🎉 Initial Release

We're excited to announce the first stable release of envcheck-cli - a zero-dependency CLI tool for validating environment variables across codebases.

What is envcheck?

envcheck scans your codebase and compares environment variable usage against your .env.example file. It catches three types of problems:

  • MISSING - Variables used in code but not documented in .env.example
  • UNUSED - Variables documented but not referenced anywhere
  • UNDOCUMENTED - Variables that exist but lack explanatory comments

Key Features

🚀 Zero Dependencies

Built entirely with Node.js built-ins. No bloated node_modules, just fast and reliable tooling.

🌍 Multi-Language Support

  • JavaScript/TypeScript (.js, .jsx, .ts, .tsx, .mjs, .cjs)
  • Python (.py)
  • Go (.go)
  • Ruby (.rb)
  • Rust (.rs)
  • Shell/Bash (.sh, .bash, .zsh)

🎨 Multiple Output Formats

  • Human-readable text with color support
  • JSON for scripting and automation
  • GitHub Actions annotations for CI/CD
  • Table format for structured display

💬 Interactive REPL Mode

Start an interactive session with persistent configuration, command history, and tab completion:

envcheck --repl

👀 Watch Mode

Auto-rerun validation when files change during development:

envcheck --watch

🔧 Auto-Fix

Automatically add missing variables to .env.example with smart defaults:

envcheck --fix

🧠 Intelligent Suggestions

  • Typo detection with similarity scoring
  • Context-aware example values
  • Actionable hints for common issues

⚙️ Configuration Files

Save your settings in .envcheckrc.json for consistent team workflows:

{
  "path": ".",
  "envFile": ".env.example",
  "failOn": "missing",
  "ignore": ["node_modules/**", "**/*.test.js"]
}

🔄 CI/CD Ready

Configurable failure conditions and exit codes for automation:

envcheck --format github --fail-on all

Installation

npm install -g envcheck-cli

Or run directly without installing:

npx envcheck-cli

Quick Start

# Basic scan
envcheck

# Watch mode for development
envcheck --watch

# Auto-fix missing variables
envcheck --fix

# CI/CD integration
envcheck --format github --fail-on missing

Requirements

  • Node.js 18.0.0 or higher

Documentation

What's Next?

Check out our ROADMAP for planned features including:

  • Plugin system for custom scanners
  • Additional language support
  • Cloud configuration integration

Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

License

MIT License - see LICENSE for details.

Links

Built with ☕, mild frustration, and the belief that developer tools should be both simple and powerful.