Konfiguration

Ein Sumor Cloud Tool.
Weitere Dokumentation
Der Konfigurationsladen unterstützt YAML- und JSON-Dateien. Er kann alle Dateien in einem Verzeichnis laden. Und konvertiert die Datei automatisch in das angegebene Format.

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 einem ES-Modul geschrieben ist, bitte ändern Sie den folgenden Code in Ihrer package.json-Datei:

{
  "type": "module"
}

Verwendung

Methoden

laden

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

finden

* root: Zeichenfolge - Stammverzeichnis
* Kategorie: Zeichenfolge - Kategoriename
* ext: Zeichenfolge - Dateierweiterung zum Konvertieren (yml, json)

findReference

* root: Zeichenfolge - Stammverzeichnis
* Verweise: Array - Referenzdateierweiterung (vue, js)
* ext: Zeichenfolge - 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 YAML-Format konvertiert

Konfigurationsdateien finden

import { find } from '@sumor/config'

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

Konfigurationsdateien aus anderen Dateien finden

wie z.B. .vue, .js-Dateien, die eine Konfigurationsdatei mit demselben Namen haben

import { findReference } from '@sumor/config'

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