运行时配置加载器.
Daniel Bannert的开源工作得到了社区的支持 GitHub 赞助商
安装
npm install @anolilab/rc
yarn add @anolilab/rc
pnpm add @anolilab/rc
使用量
本模块提供的主要功能为rc. 它允许您从不同来源加载您的应用程序的配置设置 .
import { rc } from "@anolilab/rc";
const { config, files } = rc("npm");
// returns a merged config object with all found npmrc files and a files list what files where found.
阿庇语Name
- 名称(字符串):应用程序名. 用于定位配置文件和环境变量.
- 选项(对象,可选): 具有下列属性的对象:
- 配置( 字符串, 可选) : 特定配置文件的路径 .
- cwd(字符串,可选) : 当前要开始搜索配置文件的工作目录 。 默认处理. cwd ().
- 默认( 对象, 可选) : 默认配置值 .
- 家( 字符串, 可选) : 要使用的家目录 。 默认为 os. homedir () .
- startAt( 字符串, 可选) : 停止搜索配置文件的目录 .
标准
鉴于您的应用程序名称( appname) , rc 将查看所有明显的配置位置 .
- 默认对象
/etc/${appname}/config/etc/${appname}rc$HOME/.config/${appname}/config$HOME/.config/${appname}$HOME/.${appname}/config$HOME/.${appname}rc- a 当地
.${appname}/config财务报告和审定财务报表.${appname}rc所有发现在寻找../../../ ../../ ../ ./包括:. - 如果您通过环境变量
${appname}_config然后从文件 - 如果你通过了选择。 配置变量, 然后从该文件中
- 环境变量的前缀
${appname}_或使用 “ ” 表示嵌入属性
(例如:.appname_foo__bar__baz=>foo.bar.baz(中文(简体) )
所有被找到的配置源都会被平整成一个对象,按这个确切顺序排列.
Api 文档
@anolilab/rc (英语)
职能
弧( )
function rc(name, options?): object;
定义如下: 指数.ts:193
从多个来源(默认、配置文件和环境变量)汇总配置
输入单个对象,遵循与原对象相同的分辨率逻辑 rc npm 软件包.
解析顺序是(最后最高优先):
options.defaults- 呼叫者提供的默认值- 通过获取ConfigFiles 发现的配置文件
- 以
${name}_(通过__(中文(简体) )
函数还返回解析时读取的配置文件路径列表 配置 。 在任何已发现的文件上都没有进行突变——它们只被读取.
参数
名称
string
应用程序的基名(用于得出env-var前缀和文件名).
选项?
可选行为开关.
装扮?
string
明确的配置文件路径, 最终应当合并 .
阴道?
string
开始搜索本地配置文件的工作目录 .
默认?
Record<string, (中文(简体) ), any> 翻译:
默认配置值作为最低优先级.
家吗?
string
查找用户级配置文件的主目录 。 默认为当前用户主目录 .
停下来?
string
绝对路径,在翻转目录树时作为边界.
回返
object
包含最终合并对象 config 和命令清单 files 考虑过.
配置
config: Record<string, any>;
文件
files: string[];
相关
- 弧形 - 为懒惰者设计的不可配置配置加载器.
支持的节点.js版本
这一生态系统中的图书馆尽最大努力追踪 Node.js的释放时间表。 。 。 . 这里 关于为什么我们认为这很重要的文章。 。 。 .
捐款
说明: 请注意,该项目已连同《协助者行为守则》一起公布。 通过参加这个项目,你同意遵守其条款.
贷项
在阿诺利拉布制造的
这是一个开源项目,将永远可以自由使用。 如果你觉得这很酷,请 显示它. 阿诺利拉布 是一个开发与AI工作室。 联系我们 你好@anolilab.com 如果你需要任何帮助 这些技术 或者只是想打个招呼!
许可证
Anolilab rc是开源软件,根据 麻省理工学院