在前端开发过程中,我们经常需要使用环境变量来配置和管理我们的 App。而 envig 是一种可以通过脚本文件自动创建和测试环境变量的 npm 包。本文将详细介绍 envig 的安装、使用和测试方法。
安装
通过 npm 安装 envig:
npm install envig --save-dev
使用
使用 envig 需要新建一个配置文件,例如 .envigrc.js
,将需要的环境变量以及对应的值写入该文件中:
module.exports = { APP_NAME: 'My App', APP_ENV: 'development', APP_URL: 'http://localhost:3000/' }
使用 import 引入 envig,然后调用 config 方法导出配置:
import envig from 'envig' export const env = envig.config()
另外,可以在定义中传递一个名为 prefix
的参数,用于指定环境变量的前缀。例如:
import envig from 'envig' export const env = envig.config({ prefix: 'REACT_APP_' })
传递前缀参数后,使用环境变量时需要加上 REACT_APP_
前缀,例如 process.env.REACT_APP_APP_NAME
。
测试
测试 envig 环境变量是否正确被导入,可以创建一个简单的测试文件 envig.test.js
:
-- -------------------- ---- ------- ------ - --- - ---- ----------------------- ----------------- -- -- - ---------- ------ - ----- ---------- -- -- - ----------------------------- ----- -- ---------- ------ - ----- --------- -- -- - --------------------------------------- -- ---------- ------ - ----- --------- -- -- - -------------------------------------------------- -- --
在 package.json
中添加 npm script:
"scripts": { "test:envig": "jest envig.test.js" },
然后在命令行中输入 npm run test:envig
运行测试文件。
指导意义
使用 envig 能够自动创建和测试环境变量,而且能够在项目中通过 import 引入的方式获取环境变量,在前端开发过程中使用非常方便。
同时,测试能够保证环境变量被正确地导入和使用,防止在开发中出现错误。建议在项目中使用 envig 进行环境变量管理。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066e25a563576b7b1ecf1c