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 de Node.JS

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

Nécessite le module Node.JS ES

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 le fichier de configuration

import { load } from '@sumor/config'

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

const config2 = await load(process.cwd(), 'demo', 'yaml')
// charger demo.yml ou demo.json dans le répertoire racine, et le convertir au format yaml

Trouver les fichiers de configuration

import { find } from '@sumor/config'

const config = await find(process.cwd(), 'entity')
// charger 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, ayant le même nom de fichier de configuration

import { findReference } from '@sumor/config'

const config = await findReference(process.cwd(), ['vue', 'js'])
// charger 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": {...}
 *   }
 * */