config

A Sumor Cloud Tool.
Больше документации Поддерживает загрузку файлов yaml и json. Может загружать все файлы в каталоге. И автоматически конвертирует файл в указанный формат.

Установка

npm i @sumor/config --save

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

Версия Node.JS

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

Требуется ES-модуль Node.JS

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

{
  "type": "module"
}

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

Методы

load

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

find

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

findReference

* 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'])
// загружает все *.entity.yml или *.entity.json, у которых совпадает имя с *.vue или *.js в корневом каталоге
/*
 * пример:
 *   car.entity.yml, bike.entity.json
 *   car.vue, bike.js
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */