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 convertit 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 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 d'entrée

load

import { load } from '@sumor/config'

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

find

import { find } from '@sumor/config'

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

findReference

import { findReference } from '@sumor/config'

• root: string - répertoire racine
• references: array - extension des fichiers 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')
// 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 un fichier au format yaml

Trouver des 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 des fichiers de configuration à partir d'autres fichiers

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

import { findReference } from '@sumor/config'

const config = await findReference(process.cwd(), ['vue', 'js'])
// il chargera tous les fichiers *.entity.yml ou *.entity.json ayant 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": {...}
 *   }
 * */