config

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

Установка

npm i @sumor/config --save

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

Версия Node.JS

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

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

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

{
  "type": "module"
}

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

Методы

load

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

find

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

findReference

* 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": {...}
 *   }
 * */