config

Uma Ferramenta Sumor Cloud.
Documentação Adicional Suporte ao Carregador de Configurações para arquivos yaml e json. Ele pode carregar todos os arquivos em um diretório. E converter automaticamente o arquivo para o formato especificado.

Instalação

npm i @sumor/config --save

Pré-requisitos

Versão Node.JS

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

Requer módulo ES Node.JS

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

{
  "type": "module"
}

Uso

Métodos de entrada

load

import { load } from '@sumor/config'

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

meta

carregar todos os arquivos no diretório

• root: string - diretório raiz
• sufixo: 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 do diretório de demonstração
- diretório raiz
  - car.json
  - car.sql
  - ship.js
  - plane.yml
*/

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

Métodos Legados

find

import { find } from '@sumor/config'

• root: string - diretório raiz
• categoria: string - nome da categoria
• ext: string - extensão do arquivo a ser convertido (yml, json)

findReference

import { findReference } from '@sumor/config'

• root: string - diretório raiz
• referências: array - extensão do arquivo de referência (vue, js)
• ext: string - extensão do arquivo a ser convertido (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 o arquivo no formato yaml

Encontrar arquivos de configuração

import { find } from '@sumor/config'

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

Encontrar arquivos de configuração de outros arquivos

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

import { findReference } from '@sumor/config'

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