Config

O carregador de configurações suporta arquivos yaml e json. Ele pode carregar todos os arquivos em um diretório. E automaticamente converter o arquivo para o formato especificado.

Instalação

npm i @sumor/config --save

Pré-requisitos

Versão do Node.JS

Requer versão do Node.JS 16.x ou superior

Requer módulo ES do Node.JS

Como este pacote é escrito em módulo ES, por favor altere o seguinte código em seu arquivo package.json:

{
  "type": "module"
}

Uso

Métodos

carregar

• root: string - diretório raiz
• name: string - nome do arquivo
• ext: string - extensão do arquivo para conversão (yml, json)

encontrar

* root: string - diretório raiz
* category: string - nome da categoria
* ext: string - extensão do arquivo para conversão (yml, json)

Carregar arquivo de configuração

import { load } from '@sumor/config'

const config1 = await load(process.cwd(), 'demo')
// irá carregar demo.yml ou demo.json no diretório raiz

const config2 = await load(process.cwd(), 'demo', 'yaml')
// irá carregar demo.yml ou demo.json no diretório raiz e convertê-lo para arquivo de formato yaml

Encontrar arquivos de configuração

import { find } from '@sumor/config'

const config = await find(process.cwd(), 'entity')
// irá carregar todos os *.entity.yml ou *.entity.json no diretório raiz
/*
 * exemplo:
 *   car.entity.yml, bike.entity.json
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */

Encontrar arquivos de configuração a partir de outros arquivos

como arquivos .vue, .js, que têm o mesmo nome do arquivo de configuração

import { find } from '@sumor/config'

const config = await find(process.cwd(), 'entity', null, ['vue', 'js'])
// irá carregar todos os *.entity.yml ou *.entity.json que têm o mesmo nome que os arquivos *.vue ou *.js no diretório raiz
/*
 * exemplo:
 *   car.entity.yml, bike.entity.json
 *   car.vue, bike.js
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */