env-cmd 技术文档

env-cmd 技术文档

env-cmd Setting environment variables from a file 项目地址: https://gitcode.com/gh_mirrors/en/env-cmd

env-cmd 是一个简洁的 Node.js 工具，专为使用来自环境文件的环境变量执行命令而设计，简化了在不同环境中管理配置的需求。

安装指南

env-cmd可通过npm轻松安装，适合各种规模的项目。

全局安装

如果你希望在任何项目中都能快速使用它，可以通过全局安装：

npm install -g env-cmd

局部安装

对于单个项目应用，推荐局部安装：

npm install env-cmd --save-dev

项目使用说明

基本用法

环境文件设置

创建一个名为 .env 的文件于项目根目录下，以 key=value 格式定义环境变量。例如：

ENV1=THANKS
ENV2=FOR_ALL
ENV3=THE_FISH

在package.json中使用

编辑或创建项目中的 package.json 文件，添加如下的脚本命令来利用 env-cmd：

{
  "scripts": {
    "run-with-env": "env-cmd mocha -R spec"
  }
}

之后运行 npm run run-with-env 将自动读取 .env 文件并执行指定的Mocha测试。

自定义环境文件路径

若需要指向自定义的环境文件，可使用 -f 或 --file 参数：

env-cmd -f ./custom-env/.env npm start

项目API使用文档

env-cmd不仅支持从命令行调用，还提供了API接口供程序内集成：

const envCmd = require('env-cmd');

// 异步获取环境变量并执行命令
envCmd({
  command: 'node index.js',
  envFile: {
    filePath: './custom-path.env', // 自定义环境文件路径
    fallback: true, // 是否回退到默认的`.env`
  },
}).then(envVariables => {
  console.log('Loaded env variables:', envVariables);
}).catch(error => {
  console.error('Error loading env:', error);
});

GetEnvVars函数

用于直接解析环境变量文件内容：

const { getEnvVars } = require('env-cmd');

getEnvVars({
  envFile: { filePath: './.env' }, // 指定环境文件
}).then(vars => {
  console.log('Environment Variables:', vars);
});

项目安装方式总结

• 局部安装：推荐做法，适用于项目内部环境管理。
• 全局安装：便于快速在多个项目间切换使用。
• 环境文件格式多样：.env, .env.json, .env.js, 和 .env-cmdrc 支持不同的配置风格。

通过上述步骤，你可以有效地利用env-cmd管理项目环境变量，实现不同环境下一致且便捷的配置管理。记得，处理敏感信息时避免提交至版本控制系统。

env-cmd Setting environment variables from a file 项目地址: https://gitcode.com/gh_mirrors/en/env-cmd