Config

Una Herramienta Sumor Cloud.
Más Documentación
El cargador de Config soporta archivos yaml y json. Puede cargar todos los archivos de un directorio. Y automáticamente convertir el archivo al formato especificado.

Instalación

npm i @sumor/config --save

Prerrequisitos

Versión de Node.JS

Requiere Node.JS versión 16.x o superior

Requiere módulo ES de Node.JS

Como este paquete está escrito en módulo ES, por favor cambia el siguiente código en tu archivo package.json:

{
  "type": "module"
}

Uso

Métodos

load

• root: string - directorio raíz
• name: string - nombre de archivo
• ext: string - extensión de archivo para convertir (yml, json)

find

* root: string - directorio raíz
* category: string - nombre de categoría
* ext: string - extensión de archivo para convertir (yml, json)

findReference

* root: string - directorio raíz
* references: array - extensión de archivo de referencia (vue, js)
* ext: string - extensión de archivo para convertir (yml, json)

Cargar archivo de configuración

import { load } from '@sumor/config'

const config1 = await load(process.cwd(), 'demo')
// cargará demo.yml o demo.json en el directorio raíz

const config2 = await load(process.cwd(), 'demo', 'yaml')
// cargará demo.yml o demo.json en el directorio raíz, y lo convertirá a un archivo en formato yaml

Encontrar archivos de configuración

import { find } from '@sumor/config'

const config = await find(process.cwd(), 'entity')
// cargará todos los archivos *.entity.yml o *.entity.json en el directorio raíz
/*
 * ejemplo:
 *   car.entity.yml, bike.entity.json
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */

Encontrar archivos de configuración desde otros archivos

como archivos .vue, .js, que tengan el mismo nombre de archivo de configuración

import { findReference } from '@sumor/config'

const config = await findReference(process.cwd(), ['vue', 'js'])
// cargará todos los archivos *.entity.yml o *.entity.json que tengan el mismo nombre que *.vue o *.js en el directorio raíz
/*
 * ejemplo:
 *   car.entity.yml, bike.entity.json
 *   car.vue, bike.js
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */