dotenv-run

dotenv-run

多平台兼容的环境变量管理工具集

dotenv-run是一个环境变量管理工具集,支持从.env文件加载变量并提供多种集成方案。该工具适用于monorepo项目,集成了CLI、Webpack、Rollup、Vite、ESbuild和Angular等多个平台。它支持TypeScript和ESM模块,并具有环境变量前缀过滤功能。dotenv-run为开发者提供了一种管理不同环境配置的简便方法。

dotenv-run环境变量集成monorepoTypeScriptGithub开源项目
<h1>dotenv-run</h1>

每月下载量

dotenv-run是一系列包的集合,使用dotenv来支持从.env文件加载环境变量,并提供多种集成方式。

使用dotenv-run的一些好处包括:

  • Monorepo ✨:支持包含多个应用程序的monorepo项目。
  • 通用性:支持多种集成,包括CLI、Webpack、Rollup、Vite、ESbuild和Angular。
  • TypeScript:支持TS项目,为process.envimport.meta.env提供类型定义。
  • ESM:支持ESM模块中的process.envimport.meta.env
  • 安全性:支持通过前缀过滤环境变量。
<h2>集成方式</h2>
集成方式包名状态
CLI@dotenv-run/cli
核心@dotenv-run/core
ESBuild@dotenv-run/esbuild
Rollup@dotenv-run/rollup
Vite@dotenv-run/rollup
Node.js预加载@dotenv-run/load
Angular@ngx-env/builder

快速开始

假设你有以下monorepo结构:

platform ├── apps │ ├── vite-app │ ├── ng-app │ └── esbuild-app │ │ ├── .env.local # API_BASE=http://localhost:3001 │ │ ├── package.json │ │ └── webapp.config.mjs ├── libs │ └── rollup-lib │ ├── package.json │ └── rollup.config.mjs ├── .env.dev # API_BASE=https://dev.dotenv.run ├── .env.prod # API_BASE=https://prod.dotenv.run ├── .env # API_USERS=$API_BASE/api/v1/users;API_AUTH=https://$API_BASE/auth ├── nx.json └── package.json

以及以下dotenv-run选项:

{ "verbose": true, // 打印调试信息 "unsecure": true, // 显示环境变量值 "root": "../..", // 搜索.env文件的根目录 "environment": "dev", // 要加载的环境(默认:NODE_ENV) "files": [".env"], // 要加载的.env文件(默认:.env) "prefix": "^API_" // 用于过滤环境变量的前缀(与打包工具一起使用) }

dotenv-run将搜索并加载位于根工作空间/home/code/platform到应用程序当前工作目录的.env.*文件。

- 根目录:/home/code/platform - 工作目录:/codes/code/platform/apps/esbuild-app - 文件:.env - 环境:dev - 环境文件: ✔ /home/code/platform/apps/esbuild-app/.env.local ✔ /home/code/platform/.env.dev ✔ /home/code/platform/.env - 环境变量:API(不安全模式) ✔ API_USERS http://localhost:3001/api/v1/users ✔ API_AUTH https://localhost:3001/auth

@dotenv-run/cli

@dotenv-run/cli是一个独立的CLI工具,可用于运行脚本。

❯ npx dotenv-run 用法:dotenv-run [选项] -- <命令> 选项: -v, --verbose [regexp] 显示调试信息 -u, --unsecure 显示环境变量值 -e, --env [environment] 要加载的环境(默认:NODE_ENV) -r, --root 搜索.env文件的根目录 -f, --file [.env,.secrets] 要加载的.env文件(默认:.env) -h, --help 输出使用信息 示例: dotenv-run -d dotenv-run -- npm start dotenv-run -r ../.. -f .env,.secrets -- npm start dotenv-run -f ../.env,../.env.api -- npm start

@dotenv-run/core

@dotenv-run/core是核心包,可用于从.env文件加载环境变量。

env({ root: "../..", verbose: true, prefix: "^API_", files: [".env"], });

@dotenv-run/esbuild

@dotenv-run/esbuild是esbuild的插件,可用于将环境变量注入到应用程序中。

import { dotenvRun } from "@dotenv-run/esbuild"; await build({ write: false, bundle: true, entryPoints: [`test/app.js`], plugins: [ dotenvRun({ verbose: true, root: "../../", prefix: "^API", }), ], });

@ngx-env/builder

@ngx-env/builder是Angular CLI的插件,也是@dotenv-run/esbuild@dotenv-run/webpack的包装器,可用于将环境变量注入到Angular应用程序中。

演示

快速开始

ng add @ngx-env/builder

环境变量应以NG_APP_前缀开头,你可以定义自定义前缀。

NG_APP_VERSION=$npm_package_version NG_APP_COMMIT=$GITHUB_SHA NG_APP_ENABLE_SENTRY=false
@Component({ selector: "app-footer", template: `{{ branch }} - {{ commit }}`, standalone: true, }) export class MainComponent { branch = import.meta.env.NG_APP_BRANCH_NAME; // 推荐 commit = process.env.NG_APP_COMMIT; // 已废弃 }
<!-- index.html --> <head> <title>NgApp on %NG_APP_BRANCH_NAME% - %NG_APP_COMMIT%</title> </head>

可以在angular.json文件的ngxEnv部分传递配置选项给@ngx-env/builder

{ "builder": "@ngx-env/builder:application", "options": { "ngxEnv": { "verbose": true, "root": "../..", "prefix": "^NG_APP_" } } }

如果你想在运行时更新环境变量,可以使用runtime选项。

你可以在这里找到完整的@ngx-env/builder文档。

@dotenv-run/webpack

@dotenv-run/webpack是webpack的插件,可用于将环境变量注入到应用程序中。

import { DotenvRunPlugin } from "@dotenv-run/webpack"; import path from "path"; const __dirname = path.resolve(); export default { entry: "./src/index.js", output: { filename: "main.js", path: path.resolve(__dirname, "dist"), }, plugins: [ new DotenvRunPlugin( { prefix: "^API", verbose: true, root: "../.." }, __dirname ), ], };

@dotenv-run/rollup

@dotenv-run/rollup是rollup的插件,可用于将环境变量注入到应用程序中。

import env from "@dotenv-run/rollup"; export default { input: "src/index.js", output: { file: "dist/index.js", }, plugins: [env({ prefix: "API", verbose: true, root: "../../.." })], };

致谢

许可证

MIT © Chihab Otmani

编辑推荐精选

蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多