الإعدادات Settings في كوكب Kawkab

الإعدادات Settings هي طريقة منظمة لتخزين القيم والمفاتيح التي تُستخدم عبر المشروع لتخصيص السلوكيات أو تفعيل وتعطيل ميزات معينة. يوفر كوكب Kawkab أداة قوية لإنشاء ملفات إعدادات بسهولة وسرعة.

إنشاء ملف إعدادات

لإنشاء ملف إعدادات جديد في كوكب Kawkab، يمكنك استخدام الأمر التالي:

setting:make <name> [module]

الأجزاء:

• <name>: اسم ملف الإعدادات (على سبيل المثال: auth).
• [module]: اسم الوحدة (Module) التي سيتم إنشاء الإعدادات داخلها. إذا لم يتم تحديد وحدة، يتم إنشاء الملف في الوحدة الافتراضية main.

مثال عملي

لنفترض أنك تريد إنشاء ملف إعدادات باسم auth، قم بتنفيذ الأمر التالي:

npm run kawkab setting:make auth

النتيجة:

ستظهر الرسالة التالية بعد التنفيذ:

🆗 Setting file 'auth' created successfully in module 'main'.

1️⃣  Your setting file is ready! You can now import it like this:
👉 import { setting } from '../settings/auth'

2️⃣  Use the setting like so:
👉 const enable:boolean = setting.enable

ماذا حدث؟

1. تم إنشاء ملف إعدادات جديد باسم auth داخل المجلد الافتراضي للوحدة main.
2. يحتوي الملف على إعدادات جاهزة للاستخدام.
3. يمكنك الآن استيراد الإعدادات واستخدامها في مشروعك.

استخدام الإعدادات

بعد إنشاء ملف الإعدادات، يمكنك استيراده واستخدامه بسهولة في أي مكان في مشروعك.

مثال:

ملف الإعدادات: auth.ts

export const setting = {
    enable: true, // لتفعيل أو تعطيل المصادقة
    loginAttempts: 5, // عدد محاولات تسجيل الدخول المسموح بها
    timeout: 300, // مدة انتهاء الجلسة بالثواني
};

استخدام الإعدادات:

import { setting } from '../settings/auth';
 
// قراءة إعداد معين
const isAuthEnabled = setting.enable;
console.log(`Authentication Enabled: ${isAuthEnabled}`);
 
// استخدام إعداد آخر
if (setting.enable) {
    console.log(`Maximum Login Attempts: ${setting.loginAttempts}`);
    console.log(`Session Timeout: ${setting.timeout} seconds`);
}

تخصيص الوحدة (Module)

إذا كنت تريد إنشاء ملف إعدادات ضمن وحدة مخصصة بدلاً من الوحدة الافتراضية main، يمكنك تحديد اسم الوحدة أثناء التنفيذ.

مثال:

npm run kawkab setting:make database app

النتيجة:

• سيتم إنشاء ملف إعدادات باسم database داخل وحدة app.
• الرسالة الناتجة:

🆗 Setting file 'database' created successfully in module 'app'.

1️⃣  Your setting file is ready! You can now import it like this:
👉 import { setting } from '../app/settings/database'

2️⃣  Use the setting like so:
👉 const maxConnections:number = setting.maxConnections

فوائد استخدام الإعدادات

1. تنظيم القيم الأساسية: فصل الإعدادات عن الكود الأساسي لتسهيل إدارتها.
2. قابلية التخصيص: يمكن تعديل الإعدادات بسهولة لتغيير سلوك التطبيق دون الحاجة إلى تعديل الكود.
3. إعادة الاستخدام: إعدادات موحدة يمكن استخدامها في أكثر من مكان.
4. سهولة الصيانة: تعديلات أقل عند تحديث الإعدادات مقارنة بالتعديلات داخل الكود.

نصائح عملية

• استخدام أسماء وصفية للإعدادات: تأكد من أن أسماء الإعدادات تعبر عن وظيفتها.
• تنظيم الإعدادات حسب الوحدة: إذا كنت تعمل على مشروع كبير، يفضل تقسيم الإعدادات إلى وحدات لتسهيل إدارتها.
• تحديث الإعدادات بسهولة: استخدم ملفات الإعدادات لتجنب تكرار القيم أو الحاجة إلى تعديل الكود الأساسي عند تغيير الإعدادات.

بهذا، يمكنك إدارة إعدادات مشروعك في كوكب Kawkab بسهولة وفعالية باستخدام أداة Settings.