npm 包 config-mapper-env 使用教程

阅读时长 5 分钟读完

前言

在前端开发中,我们经常需要对不同环境使用不同的配置,而每个环境的配置可能会有很多差异,这时我们需要一个管理环境配置的工具来简化开发过程。本文将介绍一款 npm 包 config-mapper-env,它可以通过命令行或者配置文件映射环境变量,方便我们在不同环境下使用不同的配置。

安装 config-mapper-env

在使用 config-mapper-env 之前,我们需要先安装它。可以使用 npm 安装它:

使用 config-mapper-env

映射环境变量

我们可以在命令行中使用 config-mapper-env 命令来映射环境变量。例如我们有一个项目,它的开发环境和生产环境有不同的数据库配置,我们可以在命令行中运行以下命令:

这样我们就映射了不同的配置文件到不同的环境变量中,而在代码中我们可以通过 process.env 来访问它们。

config-xxx.json 文件中包含的是 json 格式的键值对,例如:

在命令行中我们需要指定源文件和目标文件,例如 --src config.development.json --dest .env.development 表示将 config.development.json 中的键值对映射到 .env.development 文件中的环境变量中,.env.development 文件中的键值对格式为 KEY=VALUE

编写配置文件

除了使用命令行之外,我们还可以通过配置文件来映射环境变量。首先我们需要在项目根目录下创建一个 config 文件夹,并在其中创建多个环境文件,例如 development.jsonproduction.json 等。

我们可以在一个 .env 文件中定义所有环境共享的环境变量,例如我们需要定义一个 PORT 环境变量,可以在 .env 中添加以下内容:

然后我们再在 config 文件夹中创建开发环境配置文件 development.json,并指定需要映射到的环境变量:

我们可以使用以下命令将 development.json 中的键值对映射到 .env.development 文件中的环境变量中:

然后我们可以在代码中使用以下方式来访问它们:

通过代码映射环境变量

除了使用命令行和配置文件之外,我们还可以在代码中映射环境变量。例如我们有一个配置文件 config.json,我们可以使用以下代码将其映射到环境变量中:

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

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

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

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

代码中 createMapper 方法用于创建一个映射器,prefix 指定了环境变量的前缀,如果不指定则不会添加前缀。然后我们通过 mapper 方法将配置对象映射到环境变量中。最后我们可以通过 mapper.getEnvVar(key) 方法来获取映射后的环境变量名。

结束语

config-mapper-env 是一款非常好用的 npm 包,它可以方便我们在不同环境下使用不同的配置。通过本文的介绍,相信您已经了解了如何使用它了。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055d6981e8991b448db2ce

纠错
反馈