التكوين

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

التثبيت

npm i @sumor/config --save

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

إصدار Node.JS

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

يتطلب إصدار Node.JS ES module

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

{
  "type": "module"
}

الاستخدام

الأساليب

load

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

find

* root: string - الدليل الجذري
* category: string - اسم التصنيف
* ext: string - امتداد الملف المراد تحويله (yml, json)

findReference

* 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": {...}
 *   }
 * */