配置

一个 Sumor Cloud 工具。
更多文档
Config Loader 支持 yaml 和 json 文件。它可以加载目录中的所有文件。
并自动将文件转换为指定的格式。

安装

npm i @sumor/config --save

先决条件

Node.JS 版本

需要 Node.JS 版本为 16.x 或更高。

需要 Node.JS ES 模块

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

{
  "type": "module"
}

使用方法

入口方法

load

import { load } from '@sumor/config'

• root: 字符串 - 根目录
• name: 字符串 - 文件名
• ext: 字符串 - 要转换的文件扩展名 (yml, json)

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
*/

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

旧方法

find

import { find } from '@sumor/config'

• root: 字符串 - 根目录
• category: 字符串 - 分类名称
• ext: 字符串 - 要转换的文件扩展名 (yml, json)

findReference

import { findReference } from '@sumor/config'

• root: 字符串 - 根目录
• references: 数组 - 引用文件扩展名 (vue, js)
• ext: 字符串 - 要转换的文件扩展名 (yml, json)

加载配置文件

import { load } from '@sumor/config'

const config1 = await load(process.cwd(), 'demo')
// 它将加载根目录中的 demo.yml 或 demo.json

const config2 = await load(process.cwd(), 'demo', 'yaml')
// 它将加载根目录中的 demo.yml 或 demo.json，并将其转换为 yaml 格式文件

查找配置文件

import { find } from '@sumor/config'

const config = await find(process.cwd(), 'entity')
// 它将加载根目录中所有 *.entity.yml 或 *.entity.json
/*
 * 例子:
 *   car.entity.yml, bike.entity.json
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */

从其他文件中查找配置文件

例如 .vue、.js 文件，具有相同名称的配置文件

import { findReference } from '@sumor/config'

const config = await findReference(process.cwd(), ['vue', 'js'])
// 它将加载根目录中与 *.vue 或 *.js 同名的所有 *.entity.yml 或 *.entity.json
/*
 * 例子:
 *   car.entity.yml, bike.entity.json
 *   car.vue, bike.js
 *   {
 *       "car": {...}
 *       "bike": {...}
 * */