Konfiguration

Ein Sumor Cloud Tool. Weitere Dokumentation

Der Config Loader unterstützt .yml, .yaml, .json und .config.js Dateien. Er kann alle Dateien in einem Verzeichnis laden.

Installation

npm i @sumor/config --save

Voraussetzungen

Node.JS-Version

Erfordert Node.JS-Version 18.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

laden

import { load } from '@sumor/config'

const config = await load(process.cwd(), 'config')
// wird config.yml, config.yaml, config.json, config.config.js laden

• root: string - Stammverzeichnis
• name: string - Dateiname

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'])

/*
Demonstrationsverzeichnisstruktur
- root
  - car.json
  - car.sql
  - ship.js
  - plane.yml
  - truck.config.js
*/

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