git-env-checker

A CLI tool to check if .env files are properly listed in .gitignore to prevent accidentally committing sensitive environment variables.

Installation

No installation needed! Just run it with npx:

npx git-env-checker

Usage

Navigate to your project directory and run:

npx git-env-checker

The tool will:

1. Scan the current directory (and subdirectories) for .env files
2. Check if .env patterns are listed in .gitignore
3. Show a HIGH ALERT if .env files are not protected by .gitignore

Example Output

When .env files are NOT in .gitignore:

🔍 Scanning for .env files...

Found 2 .env file(s):
  - .env
  - .env.local

🚨 HIGH ALERT: .env files are NOT listed in .gitignore!

This is a security risk. Please add .env files to your .gitignore:

  echo ".env*" >> .gitignore
  echo "**/.env*" >> .gitignore

When .env files are properly protected:

🔍 Scanning for .env files...

Found 1 .env file(s):
  - .env

✅ .env files are properly listed in .gitignore

Publishing

Setup

1. Get your npm token:

   • Log in to npm: npm login
   • Or create a token at https://www.npmjs.com/settings/YOUR_USERNAME/tokens

2. Set the token as an environment variable:

   export NPM_TOKEN=your_npm_token_here

   Or add it to your ~/.zshrc or ~/.bashrc:

   echo 'export NPM_TOKEN=your_npm_token_here' >> ~/.zshrc
   source ~/.zshrc

Publishing Commands

• Dry run (test without publishing):

  npm run publish:dry-run

• Publish patch version (1.0.0 → 1.0.1):

  npm run publish:patch

• Publish minor version (1.0.0 → 1.1.0):

  npm run publish:minor

• Publish major version (1.0.0 → 2.0.0):

  npm run publish:major

• Manual publish:

  npm publish

The prepublishOnly script will automatically run the env checker before publishing.

License

MIT