npm 包 compile-env-templates 使用教程

简介

在前端开发中,我们通常需要准备多个环境的配置(如开发环境、测试环境、生产环境等),这些配置包括但不限于 API 地址、账号密码、静态资源域名等,但这些环境配置于不同的开发人员之间可能略有出入,因此需要一个统一的环境变量管理方案来避免因配置不同而导致的错误问题,一般我们会将这些环境变量写到一个 .env 文件中,然后通过环境变量管理工具(如 dotenv)将其注入到应用程序中使用。

compile-env-templates 可以帮助我们更简单地管理环境变量,通过预置的模板变量,在实际部署时自动将模板转化为目标环境的.env 文件。本篇文章将介绍如何使用 compile-env-templates 这个 npm 包。

安装

compile-env-templates 是一个 npm 包,可通过 npm 安装,使用如下命令安装:

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

使用

第一步: 执行安装命令之后,你需要创建一个名为 .env.template 的文件,用来存放模板变量。

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

模板文件中的模板变量使用 {{VARIABLE_NAME}} 进行标记,其中 VARIABLE_NAME 自定义。

第二步: 执行安装命令之后,在你的脚本中进行以下配置:

(1)引入 compile-env-templates

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

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

(2)实例化 CompileEnvTemplates 并指定输出目录:

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

其中 outputDir 可选,用于指定生成的 .env 文件目录,默认值为与 CLI 执行命令的根目录。

(3)编译并创建 .env 文件。

使用 compiler.compile() 编译,该方法将启动命令行交互式问题,以按照 .env.template 文件中的预定义变量,并自动创建 .env 文件:

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

这将在运行时产生以上询问:

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

用户输入完成后,将自动生成 .env 文件。

示例

添加 Template

在你的根目录下创建 .env.template 文件,并添加下面的内容:

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

模板文件中的“模板”变量使用 {{variable_name}} 进行标记,variable_name 可以自定义。

配置

添加以下代码到你的调用代码中:

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

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

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

-- ---

编译出.env文件

执行 npm run shuffle-env,回答命令行中的问题并等待执行成功。

输出.env文件

生成的 .env 文件的目录会在引入时指定,CompileEnvTemplates 的输出目录为 .env,如下所示:

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

结论

使用 compile-env-templates 能够更方便地管理环境变量,解决部署不同环境产生的问题,也能够方便管理和维护 .env 文件,如果在开发过程中使用 compile-env-templates,无论是在对于环境配置的快速迭代,还是对于各种环境的快速切换,都有着它不可替代的作用。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/600566a981e8991b448e2e02


猜你喜欢

  • npm 包 benben-model 使用教程

    在前端开发中,经常会使用到各种各样的第三方库和插件来提高开发效率和实现一些功能。而 npm 是目前其中应用最广、也最方便的一个包管理工具。本文要介绍的 benben-model 就是一个常用的 npm...

    3 年前
  • npm 包 jamstik 使用教程

    介绍 Jamstik 是一种便携式吉他,旨在为音乐制作人和初学者提供更简单和更具可操作性的选择。 npm 包 jamstik 为前端开发人员提供了使用 Jamstik 的便捷方法。

    3 年前
  • npm 包 do-ddns 使用教程

    1、认识 do-ddns do-ddns 是一个使用 node.js 编写的动态域名解析工具,可以帮助你将动态 IP 映射到你的域名。举个例子,如果你的家庭网站的 IP 是动态的,每次重连路由器时 I...

    3 年前
  • npm 包 `@~lisfan/vue-upyun-image-format` 使用教程

    介绍 @~lisfan/vue-upyun-image-format 是一个 Vue.js 插件,可用于在 Vue 应用程序中处理又拍云图像的格式和尺寸。该插件支持以下格式: 调整大小 裁剪 旋转 ...

    3 年前
  • npm 包 rn-alipay-duang 使用教程

    简介 rn-alipay-duang 是一款基于 React Native 开发的支付宝插件,它提供了简便易行的支付宝支付接口。 rn-alipay-duang 使用 Node.js 和 npm 进行...

    3 年前
  • npm 包 mini-csv 使用教程

    mini-csv 是一个小巧且功能强大的 npm 包,可以用于字符串与 CSV 格式的互相转换。在前端通过 JSON 数据进行处理时,CSV 格式也经常会被用到。在这篇文章中,我们将会为大家详细讲解 ...

    3 年前
  • npm 包 casibeans-pricing 使用教程

    casibeans-pricing 是一个方便的 npm 包,为前端开发者提供了轻松创建价格表的工具。它是使用 React 组件实现的,这使得它在 React 项目中使用起来非常方便。

    3 年前
  • npm 包 enflow-laravel-elixir 使用教程

    前言 enflow-laravel-elixir 是一款基于 Laravel Elixir 的前端构建工具,可以帮助我们更加方便地管理前端代码,并且提供了一些自动化构建的功能,如压缩、合并、版本号生成...

    3 年前
  • npm 包 Topolis 使用教程

    在前端开发中,有时我们需要生成网站的拓扑图,以便更好地了解网站的结构和关系。而 Topolis 正是解决这个问题的 npm 包。 本文将详细介绍 Topolis 的使用方法,包括安装、初始化、配置以及...

    3 年前
  • npm 包 babel-plugin-transform-jsx-directives 使用教程

    前言 在进行前端开发时,我们经常会使用到 JSX,将 React 组件写成类似 HTML 的形式,直观方便。不过,有些时候我们需要在 JSX 中使用一些自定义指令(Directive),如 v-sho...

    3 年前
  • npm 包 cgjs-about 使用教程

    在前端开发过程中,我们通常需要使用很多 npm 包来辅助我们完成项目的开发和维护。其中,cgjs-about 也是一个非常有用的 npm 包,它可以帮助我们轻松构建关于页。

    3 年前
  • npm 包 daemon-boaty 使用教程

    如果你是一个前端开发者,或者正在向成为一个前端开发者的路上努力,那么你一定已经听说过 npm。npm 是 Node.js 的包管理器,它可以让你轻松地安装、更新和管理第三方 JavaScript 包,...

    3 年前
  • npm包dom-toggle-mixin使用教程

    随着Web技术的不断发展,前端编程也变得越来越复杂。为了提高开发效率和可维护性,前端开发者经常需要使用各种工具和技术。其中一个重要的部分就是npm包,npm包是一个前端开发者必须掌握的技术之一。

    3 年前
  • npm 包 microfeedback-github 使用教程

    概述 在开发和维护软件的过程中,我们经常会收到一些用户反馈和建议,为了更好地跟进和解决这些问题,我们需要一个功能强大且易于使用的反馈工具。microfeedback-github 就是这样一款针对 G...

    3 年前
  • npm 包 skyux-lib-j-tags 使用教程

    介绍 skyux-lib-j-tags 是一个可以快速生成标签云的前端组件库。标签云作为传统 UI 中的一种重要元素,在现代网站设计中也占有重要的位置。skyux-lib-j-tags 提供了丰富的 ...

    3 年前
  • npm 包 colorts 使用教程

    前言 在前端开发过程中,我们经常需要处理颜色值,从而设计更美观的界面。而在 Node.js 中,有许多优秀的 npm 包可以帮助我们高效地处理颜色相关的计算、转换工作。

    3 年前
  • npm 包 iiif-evented-canvas 使用教程

    什么是 iiif-evented-canvas? iiif-evented-canvas 是一个用于构建数字展览的 JavaScript 库,它是基于 IIIF Canvas Data Model 构...

    3 年前
  • npm包ember-dynamic-fields 使用教程

    ember-dynamic-fields 是一个方便易用的用于在Ember.js应用程序中创建动态表单的npm包。这个包提供了许多有用的组件和工具,以帮助你在你的应用程序中创建和管理表单。

    3 年前
  • npm 包 jsonresume-theme-verbum 使用教程

    在现代的前端开发中,我们经常需要使用到不同的工具和框架,以提高开发效率和代码质量。其中,npm 是前端开发中最常用的包管理器之一,而 jsonresume-theme-verbum 是一款基于 JSO...

    3 年前
  • npm 包 knex-luke 使用教程

    在前端开发中,经常需要与数据库进行交互。为了方便开发,我们通常会使用 ORM 框架来简化数据库操作。其中,Knex.js 是一个非常流行的 SQL 查询构建器和 ORM 框架。

    3 年前

相关推荐

    暂无文章