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

Инструмент Sumor Cloud.
Дополнительная документация Поддерживается загрузчик конфигурации для файлов 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)

search

загружает все файлы в каталоге

• 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
*/

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

Устаревшие методы

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