@claude-agent/envcheck 1.0.0 → 1.2.0

package/README.md

@@ -190,6 +190,49 @@ Extra (in env but not in example):
 - **Documentation**: List required variables from example file
 - **Debugging**: Compare env files across environments
 
+## CI/CD Integration
+
+### GitHub Action
+
+Use envcheck in your GitHub Actions workflow:
+
+```yaml
+- name: Validate environment
+  uses: claude-agent-tools/envcheck@v1
+  with:
+    env-file: '.env'
+    example-file: '.env.example'
+    required: 'DATABASE_URL,API_KEY'
+    strict: 'true'
+```
+
+See [action/README.md](./action/README.md) for full documentation.
+
+### Pre-commit Hook
+
+Use with the [pre-commit](https://pre-commit.com/) framework:
+
+```yaml
+# .pre-commit-config.yaml
+repos:
+  - repo: local
+    hooks:
+      - id: envcheck
+        name: Validate environment variables
+        entry: npx @claude-agent/envcheck
+        language: system
+        files: '\.env.*'
+        pass_filenames: false
+```
+
+Or install the hook directly:
+
+```bash
+# Copy hook to git hooks directory
+curl -o .git/hooks/pre-commit https://raw.githubusercontent.com/claude-agent-tools/envcheck/master/pre-commit-hook.sh
+chmod +x .git/hooks/pre-commit
+```
+
 ## .env File Format
 
 Supports standard .env syntax:
@@ -211,12 +254,19 @@ WITH_EQUALS=postgres://user:pass@host/db?opt=val
 - **Comprehensive** - Parse, validate, compare, generate
 - **Well-tested** - 46 tests covering edge cases
 
-## Related Tools
+## vs. dotenv-safe / envalid
+
+| Feature | envcheck | dotenv-safe | envalid |
+|---------|----------|-------------|---------|
+| Validates presence | ✅ | ✅ | ✅ |
+| Based on .env.example | ✅ | ✅ | ❌ (schema) |
+| **Static validation** | ✅ | ❌ | ❌ |
+| **CI/CD integration** | ✅ GitHub Action | ❌ | ❌ |
+| **Pre-commit hook** | ✅ | ❌ | ❌ |
+| Type validation | ❌ | ❌ | ✅ |
+| Zero dependencies | ✅ | ❌ | ❌ |
 
-- [@claude-agent/changelog-gen](https://www.npmjs.com/package/@claude-agent/changelog-gen) - Generate changelogs from commits
-- [@claude-agent/gitstat](https://www.npmjs.com/package/@claude-agent/gitstat) - Git repository statistics
-- [@claude-agent/portfinder](https://www.npmjs.com/package/@claude-agent/portfinder) - Find/kill processes by port
-- [@claude-agent/cron-explain](https://www.npmjs.com/package/@claude-agent/cron-explain) - Explain cron expressions
+**Key difference:** envcheck validates *before* deployment (shift-left), while dotenv-safe and envalid validate at runtime when your app starts. Catch missing env vars in CI, not in production.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@claude-agent/envcheck",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Validate .env files, compare with .env.example, find missing or empty variables",
   "main": "src/index.js",
   "bin": {
@@ -16,7 +16,11 @@
     "variables",
     "validate",
     "lint",
-    "cli"
+    "cli",
+    "github-action",
+    "ci-cd",
+    "pre-commit",
+    "git-hooks"
   ],
   "author": "Claude Agent <claude-agent@agentmail.to>",
   "license": "MIT",
@@ -33,6 +37,7 @@
   },
   "files": [
     "src/",
-    "bin/"
+    "bin/",
+    "pre-commit-hook.sh"
   ]
 }

package/pre-commit-hook.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+# Pre-commit hook for envcheck
+# Add to .git/hooks/pre-commit or use with pre-commit framework
+#
+# Usage with pre-commit framework (.pre-commit-config.yaml):
+#   - repo: local
+#     hooks:
+#       - id: envcheck
+#         name: Validate environment variables
+#         entry: npx @claude-agent/envcheck
+#         language: system
+#         files: '\.env.*'
+#         pass_filenames: false
+#
+# Or install directly:
+#   cp pre-commit-hook.sh .git/hooks/pre-commit
+#   chmod +x .git/hooks/pre-commit
+
+set -e
+
+# Check if envcheck is available
+if command -v envcheck &> /dev/null; then
+  ENVCHECK="envcheck"
+elif command -v npx &> /dev/null; then
+  ENVCHECK="npx @claude-agent/envcheck"
+else
+  echo "Warning: envcheck not found, skipping env validation"
+  exit 0
+fi
+
+# Find .env files being committed
+ENV_FILES=$(git diff --cached --name-only --diff-filter=ACM | grep -E '\.env(\..+)?$' || true)
+
+if [ -z "$ENV_FILES" ]; then
+  # No .env files being committed
+  exit 0
+fi
+
+echo "Validating environment files..."
+
+# Run envcheck on each modified env file
+for file in $ENV_FILES; do
+  if [ -f "$file" ]; then
+    echo "Checking $file..."
+    $ENVCHECK "$file" --quiet || {
+      echo "Error: Environment validation failed for $file"
+      exit 1
+    }
+  fi
+done
+
+echo "Environment validation passed"
+exit 0