config

Der Config Loader unterstützt YAML- und JSON-Dateien. Es kann alle Dateien in einem Verzeichnis laden und automatisch die Datei in das angegebene Format konvertieren.

Installation

npm i @sumor/config --save

Voraussetzungen

Node.JS-Version

Erfordert Node.JS-Version 16.x oder höher

Erforderliches Node.JS-ES-Modul

Da dieses Paket in ES-Modul geschrieben ist, ändern Sie bitte den folgenden Code in Ihrer package.json-Datei:

{
  "type": "module"
}

Verwendung

Methoden

load

• root: string - Stammverzeichnis
• name: string - Dateiname
• ext: string - Dateierweiterung zum Konvertieren (yml, json)

find

* root: string - Stammverzeichnis
* category: string - Kategorienname
* ext: string - Dateierweiterung zum Konvertieren (yml, json)

Konfigurationsdatei laden

import { load } from '@sumor/config'

const config1 = await load(process.cwd(), 'demo')
// es wird demo.yml oder demo.json im Stammverzeichnis geladen

const config2 = await load(process.cwd(), 'demo', 'yaml')
// es wird demo.yml oder demo.json im Stammverzeichnis geladen und in das yaml-Format konvertiert

Konfigurationsdateien finden

import { find } from '@sumor/config'

const config = await find(process.cwd(), 'entity')
// es werden alle *.entity.yml oder *.entity.json im Stammverzeichnis geladen
/*
 * Beispiel:
 *   car.entity.yml, bike.entity.json
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */

Konfigurationsdateien von anderen Dateien finden

zum Beispiel .vue-, .js-Dateien, die eine gleichnamige Konfigurationsdatei haben

import { find } from '@sumor/config'

const config = await find(process.cwd(), 'entity', null, ['vue', 'js'])
// es werden alle *.entity.yml oder *.entity.json geladen, die den gleichen Namen wie *.vue oder *.js im Stammverzeichnis haben
/*
 * Beispiel:
 *   car.entity.yml, bike.entity.json
 *   car.vue, bike.js
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */