config

Un Sumor Cloud Tool.
Plus de documentation Le chargeur de configuration supporte 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

Require Node.JS version 16.x or above

Réquiert Node.JS ES module

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: array - extension des fichiers de référence (vue, js)
* ext: string - extension du fichier à convertir (yml, json)

Chargement du fichier de configuration

import { load } from '@sumor/config'

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

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

Rechercher des fichiers de configuration

import { find } from '@sumor/config'

const config = await find(process.cwd(), 'entity')
// il va charger tous les fichiers *.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 les fichiers .vue, .js, qui ont un fichier de configuration du même nom

import { findReference } from '@sumor/config'

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