配置

Sumor Cloud 工具.
更多文档

配置加载器支持 .yml, .yaml, .json 以及 .config.js 文件。它可以加载目录中的所有文件。

安装

npm i @sumor/config --save

先决条件

Node.js 版本

要求 Node.js 版本 18.x 或以上

需要 Node.js ES 模块

由于此软件包采用 ES 模块编写，请在您的 package.json 文件中更改以下代码：

{
  "type": "module"
}

用法

入口方法

load

import { load } from '@sumor/config'

const config = await load(process.cwd(), 'config')
// 将加载 config.yml、config.yaml、config.json、config.config.js

• root: 字符串 - 根目录
• name: 字符串 - 文件名

meta

加载目录中的所有文件

• root: 字符串 - 根目录
• suffix: 字符串数组 - 将加载到配置中的对象后缀(js 只会加载路径)

import { meta } from '@sumor/config'

const config = await meta(process.cwd(), ['js', 'sql'])

/*
演示目录结构
- root
  - car.json
  - car.sql
  - ship.js
  - plane.yml
  - truck.config.js
*/

// 将加载所有配置文件如下
/*
{
  car: {
    name: 'car',
    sql: "..."
  },
  ship: {
    name: 'ship',
    js: '<root>/ship.js'
  },
  plane: {
    name: 'plane'
  },
  truck: {
    name: 'truck'
  }
*/