romanzipp / laravel-env-normalizer
根据您的 .env.example 结构格式化 .env 文件,以跟踪使用和未使用的变量
1.2.0
2024-03-19 08:17 UTC
Requires
- php: ^8.0
- illuminate/database: ^5.4|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
- illuminate/support: ^5.4|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.0
- mockery/mockery: ^1.3.2
- orchestra/testbench: >=3.8
- phpstan/phpstan: ^0.12.99|^1.0
- phpunit/phpunit: ^7.0|^8.0|^9.0
- romanzipp/php-cs-fixer-config: ^3.0
README
根据您的 .env.example
结构格式化 .env
文件,以跟踪使用和未使用的变量。
为什么?
我喜欢通过向我受版本控制管理的 .env.example
文件添加一些默认值来清晰地概述所有可用的环境变量。这个包可以帮助您构建示例文件的结构。
内容
安装
composer require romanzipp/laravel-env-normalizer --dev
用法
php artisan env:normalize
列出所有可用选项
php artisan env:normalize --help
指定参考和目标文件
参考和目标选项是可选的。如果没有指定,则命令将只查找 .env.example
(作为参考)和 .env
文件(作为目标)。
php artisan env:normalize --reference=.env.example --target=.env --target=.env.local
自动格式化所有其他 .env 文件
此选项将发现位于基本路径中的任何其他 .env.*
文件并将它们添加到目标列表中。
php artisan env:normalize --auto
创建备份文件
这将为每个修改的目标文件创建一个 {name}.bak
备份文件。
php artisan env:normalize --backup
试运行
将预期输出记录到控制台而不是写入文件。
php artisan env:normalize --dry
示例标准化
- 所有目标
.env
文件的基本结构将采用参考.env.example
文件 - 值将替换为现有内容
- 未使用(未被覆盖)的示例变量将不会添加
- 来自
.env
文件的其他变量将被附加到底部,这样您可以稍后将其添加到您的受版本控制管理的示例文件中 - 以注释行
#FOO=bar
结尾的行,但不以哈希加空格#
开头,将被附加到末尾
路线图
- 检测相似变量并将它们放置在现有变量下方(将
MAIL_FROM
放置在MAIL_CONNECTION
下方,而不是将其附加到末尾)
测试
./vendor/bin/phpunit