简介
enviro-conf
是一个 npm 包,用于在前端项目中管理环境变量。它可以根据运行环境自动加载对应的配置文件,并且可以通过命令行参数或者环境变量覆盖默认的配置。
安装
npm install enviro-conf --save
使用
1. 创建配置文件
在项目根目录下创建 config
文件夹,并且在该文件夹下创建对应的配置文件,如:
config ├── default.js ├── development.js ├── production.js └── staging.js
其中 default.js
是默认的配置文件,其他文件分别对应不同的环境。
每个配置文件都应该输出一个对象,在对象中定义需要配置的变量和对应的值,如:
module.exports = { serverUrl: 'http://localhost:3000', apiKey: '123456', ... };
2. 加载配置文件
在项目中使用 enviro-conf
加载配置文件,如:
const enviroConf = require('enviro-conf'); const config = enviroConf({ path: './config', env: process.env.NODE_ENV }); console.log(config.serverUrl);
这里的 path
参数指定配置文件所在的路径,env
参数指定当前的运行环境。enviro-conf
会根据 env
参数自动加载对应的配置文件,如果找不到对应的配置文件,则会加载默认配置文件。
3. 环境变量覆盖配置
enviro-conf
支持通过环境变量来覆盖配置文件中的默认值。
以 production
环境为例,可以通过以下的命令来设置环境变量:
export SERVER_URL=http://production.server.com export API_KEY=654321
然后在代码中使用 enviro-conf
时,会自动将环境变量中的配置覆盖默认配置:
-- -------------------- ---- ------- ----- ---------- - ----------------------- ----- ------ - ------------ ----- ----------- ---- ------------ --- ------------------------------ -- ---------------------------- --------------------------- -- ------
4. 命令行参数覆盖配置
除了环境变量外,enviro-conf
还支持通过命令行参数来覆盖配置。
以 development
环境为例,可以通过以下的命令来设置命令行参数:
node app.js --serverUrl=http://localhost:8080 --apiKey=abcdefg
然后在代码中使用 enviro-conf
时,会自动将命令行参数中的配置覆盖默认配置:
-- -------------------- ---- ------- ----- ---------- - ----------------------- ----- ------ - ------------ ----- ----------- ---- ------------- --- ------------------------------ -- --------------------- --------------------------- -- -------
推荐
本文介绍了如何使用 enviro-conf
来管理前端项目中的环境变量,可以让前端开发更加便捷和高效。建议开发者在实际项目中尝试此方式,以提高开发效率。
示例代码
const enviroConf = require('enviro-conf'); const config = enviroConf({ path: './config', env: process.env.NODE_ENV }); console.log(config.serverUrl);
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066e25a563576b7b1ecf1d