README

该包旨在避免.env和.env.example文件内容不匹配的问题。

安装

首先使用composer要求包

composer require justcoded/dotenv-sync

或者将其添加到你的composer.json中并运行composer update

将以下行添加到你的git pre-commit hooks（.git/hooks/pre-commit）以防止在.env缺少在.env.example中定义的参数，反之亦然。确保文件vendor/bin/dotenv-diff是可执行的。

exec vendor/bin/dotenv-diff {envFileName} {envExampleFileName}

我们还建议使用此包在composer.json中管理你的git钩子：https://github.com/BrainMaestro/composer-git-hooks

要使bin脚本可执行，只需运行

chmod +x vendor/bin/dotenv-diff vendor/bin/dotenv-sync

要将缺失的变量sync到你的.env和.env.example文件中，运行以下命令

vendor/bin/dotenv-sync {envFileName} {envExampleFileName}

你也可以在composer install时通知关于diff的结果。为此，将以下脚本添加到你的composer.json

{
  // ...
  "scripts": {
    "post-install-cmd": [
      "dotenv-diff"
    ],
    "post-update-cmd": [
      "dotenv-diff"
    ]
  }