Configuration

Le chargeur de configuration prend en charge les fichiers yaml et json. Il peut charger tous les fichiers d'un répertoire. Et convertir automatiquement le fichier dans le format spécifié.

Installation

npm i @sumor/config --save

Prérequis

Version de Node.js

Nécessite Node.js version 16.x ou supérieure

Requiert le module ES de Node.js

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: chaîne de caractères - répertoire racine
• name: chaîne de caractères - nom du fichier
• ext: chaîne de caractères - extension du fichier à convertir (yml, json)

find

* root: chaîne de caractères - répertoire racine
* category: chaîne de caractères - nom de la catégorie
* ext: chaîne de caractères - extension du fichier à convertir (yml, json)

Charger le 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

Trouver les fichiers de configuration

import { find } from '@sumor/config'

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

Trouver les fichiers de configuration à partir d'autres fichiers

comme les fichiers .vue, .js, il a le même fichier de configuration au même nom

import { find } from '@sumor/config'

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