التكوين

أداة Sumor Cloud.
المزيد من الوثائق

داعم تحميل التكوين يدعم ملفات .yml, .yaml, .json, و .config.js. يمكنه تحميل جميع الملفات في دليل معين.

التثبيت

npm i @sumor/config --save

المتطلبات

نسخة Node.JS

يتطلب إصدار Node.JS 18.x أو أعلى

يتطلب وحدة ES Node.JS

نظرًا لأن هذه الحزمة مكتوبة بوحدة ES، يرجى تغيير الشيفرة التالية في ملف package.json الخاص بك:

{
  "type": "module"
}

الاستخدام

الأساليب الرئيسية

load

import { load } from '@sumor/config'

const config = await load(process.cwd(), 'config')
// سيحمل ملفات config.yml, config.yaml, config.json, config.config.js

• root: string - الدليل الجذري
• name: string - اسم الملف

meta

تحميل جميع الملفات في الدليل

• root: string - الدليل الجذري
• suffix: string - لاحقة الكائن الذي سيتم تحميله إلى التكوين (js سيحمل المسار فقط)

import { meta } from '@sumor/config'

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

/*
هيكل الدليل التوضيحي
- root
  - car.json
  - car.sql
  - ship.js
  - plane.yml
  - truck.config.js
*/

// ستقوم بتحميل جميع ملفات التكوين على النحو التالي
/*
{
  car: {
    name: 'car',
    sql: "..."
  },
  ship: {
    name: 'ship'
    js: '<root>/ship.js'
  },
  plane: {
    name: 'plane'
  },
  truck: {
    name: 'truck'
  }
*/