config

Инструмент Sumor Cloud.
Дополнительная Документация Config Loader поддерживает файлы yaml и json. Он может загружать все файлы в каталоге. И автоматически конвертирует файл в указанный формат.

Установка

npm i @sumor/config --save

Предварительные требования

Версия Node.JS

Требуется версия Node.JS 16.x или выше

Требование к ES-моделям Node.JS

Поскольку этот пакет написан на ES-моделях, пожалуйста, измените следующий код в вашем файле package.json:

{
  "type": "module"
}

Использование

Входные методы

load

import { load } from '@sumor/config'

• root: string - корневой каталог
• name: string - имя файла
• ext: string - расширение файла для конвертации (yml, json)

find

import { find } from '@sumor/config'

• root: string - корневой каталог
• category: string - имя категории
• ext: string - расширение файла для конвертации (yml, json)

findReference

import { findReference } from '@sumor/config'

• root: string - корневой каталог
• references: array - расширение файла ссылки (vue, js)
• ext: string - расширение файла для конвертации (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'])
// загрузит все *.entity.yml или *.entity.json, которые имеют файл конфигурации с тем же именем, что и *.vue или *.js в корневом каталоге
/*
 * пример:
 *   car.entity.yml, bike.entity.json
 *   car.vue, bike.js
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */