andrey-helldar/env-sync

此包已被 废弃 并不再维护。作者建议使用 dragon-code/env-sync 包代替。

保持 .env.example 文件更新

4.1.0 2024-03-13 07:10 UTC

README

Environment Synchronization

Stable Version Unstable Version Total Downloads Github Workflow Status License

安装

如果你使用 Laravel 框架,则请安装 dragon-code/env-sync-laravel 包。

要获取最新版本的 环境同步,只需使用 Composer 引入项目。

$ composer require dragon-code/env-sync --dev

或者手动更新 composer.json 中的 require-dev 块并运行 composer update

{
    "require-dev": {
        "dragon-code/env-sync": "^4.0"
    }
}

如何使用

此包会扫描指定文件夹中具有 *.php*.json*.yml*.yaml*.twig 扩展名的文件,从中获取对 envgetenv 函数的调用。根据获取的值,该包创建一个键值数组。在保存时,键由 _ 字符之前的第一个单词分割成块。

此外,所有键都按字母顺序排序。

框架

  • Laravel / Lumen 框架 - 请参阅此存储库中的文档 此处

原生使用

要调用应用程序中的命令,你需要做以下操作

use DragonCode\EnvSync\Services\Syncer;

protected function syncer(): Syncer
{
    return Syncer::make();
}

protected function sync()
{
    $this->syncer()
       ->path(__DIR__)
       ->filename('.env.example')
       ->store();
}

如果你想要定义默认值或指定哪些键值应该被存储,你需要向 Config 类的构造函数传递一个数组

use DragonCode\EnvSync\Services\Syncer;

protected function syncer(): Syncer
{
    return Syncer::make($this->config());
}

protected function config(): array
{
    return require realpath(__DIR__ . '/your-path/your-config.php');
}

你也可以通过发送 PR 来建议你的实现。我们将非常高兴 😊

许可证

此包根据 MIT 许可证 许可。