config

Uma Ferramenta Sumor Cloud.
Documentação Adicional

O Carregador de Config suporta arquivos .yml, .yaml, .json e .config.js. Ele pode carregar todos os arquivos em um diretório.

Instalação

npm i @sumor/config --save

Pré-requisitos

Versão do Node.JS

Requer Node.JS versão 18.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 de Entrada

load

import { load } from '@sumor/config'

const config = await load(process.cwd(), 'config')
// irá carregar config.yml, config.yaml, config.json, config.config.js

• root: string - diretório raiz
• name: string - nome do arquivo

meta

Carregar todos os arquivos no diretório

• root: string - diretório raiz
• suffix: string - sufixo do objeto que será carregado na configuração (js carregará apenas o caminho)

import { meta } from '@sumor/config'

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

/*
Estrutura de diretório de demonstração
- root
  - car.json
  - car.sql
  - ship.js
  - plane.yml
  - truck.config.js
*/

// irá carregar todos os arquivos de configuração conforme abaixo
/*
{
  car: {
    name: 'car',
    sql: "..."
  },
  ship: {
    name: 'ship'
    js: '<root>/ship.js'
  },
  plane: {
    name: 'plane'
  },
  truck: {
    name: 'truck'
  }
*/