config

Un outil Sumor Cloud.
Plus de documentation
Le chargeur de configuration prend en charge les fichiers yaml et json. Il peut charger tous les fichiers dans un répertoire. Et convertir automatiquement le fichier dans le format spécifié.

Installation

npm i @sumor/config --save

Prérequis

Version Node.JS

Nécessite la version 16.x ou supérieure de Node.JS

Module ES de Node.JS requis

Comme ce package est écrit en module ES, veuillez modifier le code suivant dans votre fichier package.json :

{
  "type": "module"
}

Utilisation

Méthodes

load

• root: string - répertoire racine
• name: string - nom du fichier
• ext: string - extension du fichier à convertir (yml, json)

find

* root: string - répertoire racine
* category: string - nom de la catégorie
* ext: string - extension du fichier à convertir (yml, json)

findReference

* root: string - répertoire racine
* references: tableau - extension du fichier de référence (vue, js)
* ext: string - extension du fichier à convertir (yml, json)

Charger un fichier de configuration

import { load } from '@sumor/config'

const config1 = await load(process.cwd(), 'demo')
// il chargera demo.yml ou demo.json dans le répertoire racine

const config2 = await load(process.cwd(), 'demo', 'yaml')
// il chargera demo.yml ou demo.json dans le répertoire racine, et le convertira en fichier au format yaml

Rechercher des fichiers de configuration

import { find } from '@sumor/config'

const config = await find(process.cwd(), 'entity')
// il chargera tous les *.entity.yml ou *.entity.json dans le répertoire racine
/*
 * exemple:
 *   car.entity.yml, bike.entity.json
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */

Rechercher des fichiers de configuration à partir d'autres fichiers

comme des fichiers .vue, .js, ayant le même nom de fichier de configuration

import { findReference } from '@sumor/config'

const config = await findReference(process.cwd(), ['vue', 'js'])
// il chargera tous les *.entity.yml ou *.entity.json ayant le même nom que les *.vue ou *.js dans le répertoire racine
/*
 * exemple:
 *   car.entity.yml, bike.entity.json
 *   car.vue, bike.js
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */