@hfcjoy/load-config
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

🏗️

load-config

为程序搜索并加载配置数据

npm (scoped) Libraries.io dependency status for latest release, scoped npm package npm type definitions

基于 javascript 生态传统的智能默认值,load-config将按照一下优先级搜索配置文件:

  • package.json 配置的属性值
  • rc文件:.reeluprc
  • rc并且是以下后缀的文件:.json, .yaml, .yml, .ts, .js, .cjs,例如:.reeluprc.json
  • 是以下后缀的文件:.config.ts.config.js.config.cjs

更强大的功能

  • 让配置文件支持不限层级的继承,包括:从本地文件继承、或者 npm 包的方式继承;以及混合继承,例如:json配置文件可以继承.ts配置文件
{
  // 本地继承
  "$extends": "../config.json",
  // npm包继承
  "$extends": "@xx/reelup",
  // 混合继承
  "$extends": "../config.ts"
}

用法

设置一个配置项的名称,load-config将自动搜索:

import { loadConfig } from '@hfcjoy/load-config'

await loadConfig('reelup')

Package Sidebar

Install

npm i @hfcjoy/load-config

Weekly Downloads

0

Version

1.0.1

License

ISC

Unpacked Size

259 kB

Total Files

8

Last publish

Collaborators

  • hfcjoy