Konfiguration

Ein Sumor-Cloud-Tool.
Weitere Dokumentation
Der Konfigurationsladeprozess unterstützt YAML- und JSON-Dateien. Es kann alle Dateien in einem Verzeichnis laden und automatisch in das angegebene Format konvertieren.

Installation

npm i @sumor/config --save

Vorbedingungen

Node.JS-Version

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

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

Einstiegsmethoden

load

import { load } from '@sumor/config'

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

search

Alle Dateien im Verzeichnis laden

• root: string - Stammverzeichnis
• Datensuffix: string - Objektsuffix, das in die Konfiguration geladen wird
• Mögliche Suffixe: array - Objektsuffix, das geladen wird, wenn in der Konfiguration fehlend

import { meta } from '@sumor/config'

const config = await meta(process.cwd(), ['sql'], ['js', 'sql'])

/*
Beispiel Verzeichnisstruktur
- root
  - car.json
  - car.sql
  - ship.js
  - plane.yml
*/

// Es werden alle Konfigurationsdateien wie folgt geladen
/*
{
  car: {
    name: 'car',
    sql: "..."
  },
  ship: {
    name: 'ship'
    // js-Datei wird nicht geladen
  },
  plane: {
    name: 'plane'
  }
}
*/

Legacy-Methoden

find

import { find } from '@sumor/config'

• root: string - Stammverzeichnis
• Kategorie: string - Kategoriename
• ext: string - Dateierweiterung zur Konvertierung (yml, json)

findReference

import { findReference } from '@sumor/config'

• root: string - Stammverzeichnis
• Referenzen: array - Referenzdateierweiterung (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 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 aus anderen Dateien finden

wie z.B. .vue, .js-Dateien, die eine Konfigurationsdatei mit gleichem 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": {...}
 *   }
 * */