Envful

Envful 是一个 CLI 工具，用于验证环境变量的存在。它检查你的 .env 文件和宿主系统。你可以用它来运行任何进程，同时确保所有变量都已设置。

再也不用因为环境配置错误而浪费时间调试你的应用程序。

安装

安装脚本

使用适用于所有 bash 系统的便捷安装脚本。在你的终端（Windows 的 git bash）中运行以下命令。

# Warning: always examine scripts downloaded from the internet before running them locally.
curl https://raw.githubusercontent.com/arvindell/envful/main/install.sh -o install.sh && bash install.sh

此命令还可以用于更新您的安装。

NPM

您可以使用 NPM 安装 Envful。

# Install locally
npm install envful

# Or globally
npm install -g envful

crates.io

使用 cargo 直接从 crates.io 安装。

cargo install envful

使用方法

Envful 使用 .env.example 文件作为需要哪些变量的清单。如果你的项目有一个 .env.example 文件，它已经支持 envful！🚀

使用 check 检查变量和未声明的变量

envful check

如果检查成功，你也可以指定一个要运行的命令，使用 '--' 分隔符。如果缺少变量，它会立即失败，并显示有用的消息。

envful -- echo "I am envful!"

这对于检查 package.json 脚本中的环境非常有用

"scripts": {
    "dev": "envful -- next",
    "build": "envful -- next build"
}

参数

USAGE:
    envful [OPTIONS] <SUBCOMMAND>

OPTIONS:
    -f, --file <FILE>            Path to environment file. Defaults to ./.env
    -h, --help                   Print help information
    -m, --manifest <MANIFEST>    Path to manifest file. Defaults to ./.env.example
        --show-optional          Whether to print missing optional variables. Defaults to false
        --show-undeclared        Whether to show undeclared variables in output. Defaults to false
    -V, --version                Print version information

SUBCOMMANDS:
    check    Check if env has all required variables and warns if missing
    help     Print this message or the help of the given subcommand(s)

如何声明变量

在你的 .env.example 文件中，你可以声明应用程序所需的变量。你可以使用三哈标记 (###) 为变量添加描述。

对于警告而不是失败，将 [optional] 添加到变量。

示例

### The URL to the database instance
DATABASE_URL=

### The app secret used to sign JSON Web Tokens
APP_SECRET=

### Google Analytics ID [optional]
GA_ID=

注意：目前任何 ### 标记都将被解释为文件中下一个变量的注释，无论这两行之间有多少空白。

欢迎贡献

本项目欢迎各种形式的贡献，无论您是想添加新功能、改进文档，还是只想提供反馈。

许可协议

Envful 在 MIT 许可协议下发布。有关更多信息，请参阅 LICENSE 文件。