التهيئة

أداة Sumor Cloud.
المزيد من التوثيق يدعم محمل التكوين ملفات yaml و json. يمكنه تحميل جميع الملفات في دليل ما. وتحويل الملف تلقائياً إلى التنسيق المحدد.

التثبيت

npm i @sumor/config --save

المتطلبات الأساسية

إصدار Node.JS

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

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

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

{
  "type": "module"
}

الاستخدام

طرق الدخول

load

import { load } from '@sumor/config'

• root: string - الدليل الجذري
• name: string - اسم الملف
• ext: string - امتداد الملف للتحويل (yml، json)

find

import { find } from '@sumor/config'

• root: string - الدليل الجذري
• category: string - اسم الفئة
• ext: string - امتداد الملف للتحويل (yml، json)

findReference

import { findReference } from '@sumor/config'

• root: string - الدليل الجذري
• references: array - امتدادات الملفات المرجعية (vue، js)
• ext: string - امتداد الملف للتحويل (yml، json)

تحميل ملف التكوين

import { load } from '@sumor/config'

const config1 = await load(process.cwd(), 'demo')
// سيتم تحميل demo.yml أو demo.json في الدليل الجذري

const config2 = await load(process.cwd(), 'demo', 'yaml')
// سيتم تحميل demo.yml أو demo.json في الدليل الجذري، وتحويله إلى ملف بتنسيق yaml

العثور على ملفات التكوين

import { find } from '@sumor/config'

const config = await find(process.cwd(), 'entity')
// سيتم تحميل جميع ملفات *.entity.yml أو *.entity.json في الدليل الجذري
/*
 * مثال:
 *   car.entity.yml, bike.entity.json
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */

العثور على ملفات التكوين من ملفات أخرى

مثل ملفات .vue، .js، لديها نفس اسم ملف التكوين

import { findReference } from '@sumor/config'

const config = await findReference(process.cwd(), ['vue', 'js'])
// سيتم تحميل جميع ملفات *.entity.yml أو *.entity.json التي تحمل نفس الاسم مع *.vue أو *.js في الدليل الجذري
/*
 * مثال:
 *   car.entity.yml, bike.entity.json
 *   car.vue, bike.js
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */