Konfiguration

Ein Sumor Cloud Werkzeug.
Mehr Dokumentation Der Konfigurations-Lader unterstützt yaml- und JSON-Dateien. Er 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 einem ES-Modul geschrieben ist, ändern Sie bitte den folgenden Code in Ihrer package.json:

{
  "type": "module"
}

Verwendung

Methoden

laden

• root: string - Stammverzeichnis
• name: string - Dateiname
• ext: string - Dateierweiterung zur Konvertierung (yml, json)

suchen

* root: string - Stammverzeichnis
* Kategorie: string - Kategorienname
* ext: string - Dateierweiterung zur Konvertierung (yml, json)

findReference

* root: string - Stammverzeichnis
* Referenzen: Array - Referenzdateiendung (vue, js)
* ext: string - Dateierweiterung zur Konvertierung (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 eine YAML-Formatdatei 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 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": {...}
 *   }
 * */