npm 包 enforce-envvars 使用教程-JavaScript中文网-JavaScript教程资源分享门户

在开发前端应用时，我们经常会使用环境变量来控制应用的行为。例如，在不同的环境部署应用时，数据库的连接信息和 API 的地址都是不同的。但是，如果这些环境变量没有被正确设置，可能会导致应用出现问题。为了避免这种情况的发生，我们可以使用 npm 包 enforce-envvars 来强制要求环境变量的必填项。

安装

可以使用 npm 来安装 enforce-envvars:

npm install enforce-envvars

使用方法

1. 简单示例

在使用之前，我们需要定义一个规则集合用来检测环境变量是否被正确设置。例如，我们要求应用在生产环境中必须设置以下 3 个环境变量：

NODE_ENV
DATABASE_URL
API_ENDPOINT

可以在项目根目录下创建一个 .env.example 文件，然后添加以下内容：

NODE_ENV=
DATABASE_URL=
API_ENDPOINT=

这个文件是用来展示必填项的。运行 enforce-envvars 之前，需要先将其复制到 .env 文件中：

cp .env.example .env

最后，在应用的入口文件中加入以下代码：

const enforceEnvVars = require('enforce-envvars');

enforceEnvVars(['NODE_ENV', 'DATABASE_URL', 'API_ENDPOINT']);

这样，当在生产环境中运行应用时，如果没有设置其中任何一个环境变量，则会在控制台中输出以下信息：

Error: Environment variable NODE_ENV is not set

2. 进阶用法

enforce-envvars 提供了一些选项，可以对环境变量的检测行为进行配置。例如：

-- -------------------- ---- -------
---------------
  ------------ --------------- ----------------
  -
    ------- -----
    ------- --------------
    ---------- -------- -- -
      -------------------- ----------- --------- --------------
    -
  -
--

strict 选项如果设置为 true，则会在检测到未定义的环境变量时抛出一个错误。如果设置为 false，则只会记录一条警告信息。
logger 选项可以指定一个函数，用来记录日志。默认情况下使用 console.log。
onInvalid 选项可以指定一个回调函数，用于处理无效的环境变量。

总结

enforce-envvars 是一个非常实用的 npm 包，它可以帮助我们在开发过程中确保环境变量被正确设置。在使用时，我们需要先定义一个规则集合，然后引入 enforce-envvars 并传入这个规则集合。除此之外，该包还提供了很多选项，可以根据自己的需要进行配置，以便更好地适配不同的应用场景。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/60066e25a563576b7b1ecedf