Konfiguration

Ein Sumor Cloud Tool.
Weitere Dokumentation Der Config Loader 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 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 zum Konvertieren (yml, json)

meta

Lädt alle Dateien im Verzeichnis

• root: string - Stammverzeichnis
• suffix: string - Objektsuffix, das in die Konfiguration geladen wird (js lädt nur den Pfad)

import { meta } from '@sumor/config'

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

/*
Beispiel für Verzeichnisstruktur
- Stamm
  - car.json
  - car.sql
  - ship.js
  - plane.yml
*/

// alle Konfigurationsdateien werden wie folgt geladen
/*
{
  car: {
    name: 'car',
    sql: "..."
  },
  ship: {
    name: 'ship'
    js: '<root>/ship.js'
  },
  plane: {
    name: 'plane'
  }
}
*/

Legacy-Methoden

find

import { find } from '@sumor/config'

• root: string - Stammverzeichnis
• category: string - Kategoriename
• ext: string - Dateierweiterung zum Konvertieren (yml, json)

findReference

import { findReference } from '@sumor/config'

• root: string - Stammverzeichnis
• references: array - Referenzdateierweiterung (vue, js)
• ext: string - Dateierweiterung zum Konvertieren (yml, json)

Konfigurationsdatei laden

import { load } from '@sumor/config'

const config1 = await load(process.cwd(), 'demo')
// lädt demo.yml oder demo.json im Stammverzeichnis

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

Konfigurationsdateien suchen

import { find } from '@sumor/config'

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

Konfigurationsdateien aus anderen Dateien suchen

z. B. .vue, .js-Dateien, die eine gleichnamige Konfigurationsdatei haben

import { findReference } from '@sumor/config'

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