mathiasgrimm / laravel-dot-env-gen
A Laravel 5 artisan command to generate a .env.gen file based on the existing project.
Installs: 80 047
Dependents: 0
Suggesters: 0
Security: 0
Stars: 167
Watchers: 5
Forks: 8
Open Issues: 5
Requires
- php: >=5.4.0
This package is auto-updated.
Last update: 2024-11-22 10:54:52 UTC
README
A Laravel 5 command that generates a .env.gen
file containing all environment
variables defined in .env
as well as any undefined variables that are being
used throughout the project.
Installation
Install the package using composer:
composer require mathiasgrimm/laravel-dot-env-gen:dev-master
Add the service provider:
// config/app.php 'providers' => [ ... 'MathiasGrimm\LaravelDotEnvGen\DotEnvGenServiceProvider', ... ],
Add .env.gen
to your .gitignore
Configuration
You can control which directories are scanned by providing exclusion rules in
the dotenvgen.php
config file. For a fresh Laravel install, we suggest that
all subdirectories inside vendor
are ignored except for vendor/laravel
.
Publish the config file:
php artisan vendor:publish --provider="MathiasGrimm\LaravelDotEnvGen\DotEnvGenServiceProvider" --tag="config"
Example config:
// config/dotenvgen.php 'rules' => [ // Ignores all files inside `vendor` except for those in `vendor/laravel` 'vendor' => ['laravel'], // Ignores the `database/seeds` directory 'database/seeds' => [], ],
Usage
From the command line, run php artisan env:gen
.
A .env.gen
file will be generated in your project's root folder. Make any
changes you may need, then rename the file to .env
.
Along with generating the .env.gen
file, the command will notify you if a
defined environment variable is unused as well as alert you if an undefined
environment variable is being used.