config

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

التثبيت

npm i @sumor/config --save

المتطلبات

إصدار Node.JS

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

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

نظرًا لكون هذه الحزمة مكتوبة بوحدة ES ، يرجى تغيير الكود التالي في ملف الـ 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": {...}
 *   }
 * */