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 d'un répertoire.
Et convertir automatiquement le fichier au 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

Nécessite un module ES de Node.JS

Comme ce package est écrit en module ES,
veuillez changer 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 de fichier à convertir (yml, json)

find

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

findReference

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

Charger un fichier de configuration

import { load } from '@sumor/config'

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

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

Trouver des fichiers de configuration

import { find } from '@sumor/config'

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

Trouver des fichiers de configuration à partir d'autres fichiers

comme les 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'])
// cela chargera tous les *.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": {...}
 *   }
 * */