Sign inSign up

backdevs/desniff

By backdevs

•Updated over 2 years ago

A PHP code sniffer for environment variables not declared in dotenv files. For Laravel projects.

Image
Languages & frameworks
Integration & delivery
Developer tools
1

1.4K

backdevs/desniff repository overview

⁠Laravel Dotenv Sniffer

A code sniffer for environment variables not declared in .env files

GitHub Workflow Status GitHub release (latest SemVer)

header

While working on large projects we've noticed that .env.example files would often get outdated.
This tool provides a fast and simple way of constantly checking your code against .env files either as a step in your CI/CD pipeline, a Git hook or whatever works best for your project.

⁠Requirements

⁠Usage

⁠Docker (recommended)

Inside your app's root directory, run:

docker run -t --rm -v $(pwd):/app backdevs/desniff:latest .env.example ./config ./app
⁠Composer dependency
composer require --dev backdevs/dotenv-sniffer

vendor/bin/desniff .env.example ./config ./app
⁠PHAR
curl -fsSL https://github.com/backdevs/php-dotenv-sniffer/releases/latest/download/desniff.phar -o /tmp/desniff

chmod +x /tmp/desniff

/tmp/desniff .env.example ./config ./app

⁠Options and Arguments

Options

  • --no-fail - Don't fail if errors are found (exit code = 0)
  • -w | --warn-with-default - Treat variables with default values in Laravel⁠'s env()⁠ calls as warnings
  • -c | --fail-code - The exit code to use when failing (default: 1), useful in CI/CD pipelines

Arguments

  • env-file - The .env file to check against (e.g.: .env, .env.example, .env.dev)
  • paths - One or more files and/or directories to check

⁠Simple Example

⁠The .env.example file:
APP_NAME=DotenvSniffer

DB_HOST=localhost
⁠The config.php file:
<?php

use Illuminate\Support\Env;

return [
    'app' => [
        'name' => env('APP_NAME'),
        'key' => Env::get('APP_KEY', sprintf('base64:%s', base64_encode('example'))),
    ],

    'mysql' => [
        'host' => env('DB_HOST', 'localhost'),
        'username' => getenv('DB_USERNAME'),
        'password' => \Illuminate\Support\Env::get('DB_PASSWORD', 'secret'),
        'database' => $_ENV['DB_DATABASE'],
    ],
];
⁠Output for vendor/bin/desniff -w .env.example config.php

image

Tag summary

Content type

Image

Digest

sha256:6e986578f…

Size

38 MB

Last updated

over 2 years ago

docker pull backdevs/desniff