配置

一个Sumor Cloud工具。
更多文档
配置加载器支持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）

search

加载目录中的所有文件

• root: 字符串 - 根目录
• data suffix: 字符串 - 将加载到配置中的对象后缀
• possible suffix: 数组 - 如果缺少配置，将加载的对象后缀

import { meta } from '@sumor/config'

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

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

// 它会加载所有配置文件如下
/*
{
  car: {
    name: 'car',
    sql: "..."
  },
  ship: {
    name: '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": {...}
 * */