Конфигурация

Инструмент Sumor Cloud.
Дополнительная документация

Загрузчик конфигурации поддерживает файлы .yml, .yaml, .json и .config.js. Он может загружать все файлы в директории.

Установка

npm i @sumor/config --save

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

Версия Node.JS

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

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

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

{
  "type": "module"
}

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

Методы входа

Загрузка

import { load } from '@sumor/config'

const config = await load(process.cwd(), 'config')
// будет загружать config.yml, config.yaml, config.json, config.config.js

• root: string - корневая директория
• name: string - имя файла

Мета

Загрузить все файлы в директории

• root: string - корневая директория
• suffix: string - суффикс объекта, который будет загружен в конфигурацию (для js будет загружен только путь)

import { meta } from '@sumor/config'

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

/*
Демонстрация структуры каталога
- root
  - car.json
  - car.sql
  - ship.js
  - plane.yml
  - truck.config.js
*/

// загрузит все файлы конфигурации, как показано ниже
/*
{
  car: {
    name: 'car',
    sql: "..."
  },
  ship: {
    name: 'ship'
    js: '<root>/ship.js'
  },
  plane: {
    name: 'plane'
  },
  truck: {
    name: 'truck'
  }
*/