pretty-env 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2026-03-14
+
+### Added
+- Initial release of pretty-env
+- Core library with .env file parsing and validation
+- Command-line interface (CLI) for validation and comparison
+- Comprehensive security warnings for sensitive variables
+- Support for required keys and allowed keys validation
+- Pretty printing of loaded environment variables
+- Full test coverage with Jest
+- ESLint and Prettier configuration
+- GitHub Actions CI workflow
+- Detailed documentation and examples
+
+### Features
+- Zero-config usage: `require('pretty-env').load()`
+- Validates .env file syntax and key names
+- Warns on weak/missing credentials
+- Detects common mistakes and naming convention issues
+- Supports custom validation rules
+- Environment variable reporting and analysis

package/README.md

@@ -107,16 +107,16 @@ Validate from terminal:
 
 ```bash
 # Validate current .env
-$ pretty-env validate
+$ npx pretty-env validate
 
 # Validate specific file
-$ pretty-env validate .env.production
+$ npx pretty-env validate .env.production
 
 # Compare two files
-$ pretty-env compare .env.example .env
+$ npx pretty-env compare .env.example .env
 
 # Show help
-$ pretty-env help
+$ npx pretty-env help
 ```
 
 **Output example:**
@@ -378,7 +378,7 @@ module.exports = {
 # deploy.sh
 
 echo "📋 Validating .env..."
-pretty-env validate .env.production
+npx pretty-env validate .env.production
 
 if [ $? -eq 0 ]; then
   echo "✅ Env validation passed"
@@ -420,7 +420,7 @@ require('pretty-env').load({
 
 ```bash
 # Make sure you're not deploying old config
-pretty-env compare .env.example .env.production
+npx pretty-env compare .env.example .env.production
 
 # Fix any issues
 npm run validate:env

package/cli/pretty-env-cli.js

@@ -125,7 +125,7 @@ function help() {
 ${colorize('pretty-env', 'bright')} - Validate and prettify .env files
 
 ${colorize('Usage:', 'bright')}
-  pretty-env [command] [options]
+  npx pretty-env [command] [options]
 
 ${colorize('Commands:', 'bright')}
   validate [file]     Validate .env file (default: .env)
@@ -133,10 +133,10 @@ ${colorize('Commands:', 'bright')}
   help                Show this help message
 
 ${colorize('Examples:', 'bright')}
-  $ pretty-env validate
-  $ pretty-env validate .env.production
-  $ pretty-env compare .env.example .env
-  $ pretty-env help
+  $ npx pretty-env validate
+  $ npx pretty-env validate .env.production
+  $ npx pretty-env compare .env.example .env
+  $ npx pretty-env help
 `);
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pretty-env",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Validates and prettifies .env files with clear error messages. Warns on missing keys, typos, or insecure values. Drop-in replacement for dotenv.",
   "main": "src/index.js",
   "bin": {