Tealup Packages Naming Convention

این سند یک فرمول مشخص برای نام‌گذاری پکیج‌های Tealup ارائه می‌دهد تا همه کتابخانه‌ها منظم، مقیاس‌پذیر و قابل پیش‌بینی باشند.

📐 فرمول نام‌گذاری

@tealup/--

اجزای فرمول

• platform: پلتفرم یا فریم‌ورک هدف
  • nextjs | nuxtjs | react | vue | shared
• category: حوزه یا بخش کاربرد
  • ui | kit | chart | auth | form | data | utils
• type (اختیاری): نوع یا نقش پکیج
  • core | client | server | hooks | utils

🧩 مثال‌ها

| نام پکیج | توضیح | | --------------------------- | --------------------------------------- | | @tealup/nextjs-ui-core | کامپوننت‌های پایه UI برای Next.js | | @tealup/nextjs-kit-client | ابزارهای سمت کلاینت در Next.js | | @tealup/nextjs-kit-server | ابزارهای سمت سرور در Next.js | | @tealup/nuxtjs-ui-kit | کیت UI برای Nuxt.js | | @tealup/nuxtjs-chart-core | ماژول چارت برای Nuxt.js | | @tealup/shared-utils | توابع و ابزارهای مشترک بین همه پروژه‌ها |

🚀 مزایا

• قابل پیش‌بینی: با دیدن اسم هر پکیج می‌توان فهمید برای چه پلتفرمی و چه کاربردی است.
• مقیاس‌پذیر: در آینده می‌توان فریم‌ورک‌ها و دسته‌های جدید اضافه کرد بدون نیاز به تغییر در ساختار نام‌گذاری.
• انعطاف‌پذیر: امکان تعریف نقش‌های مختلف مثل core، client، یا server وجود دارد.

📦 نمونه نام‌گذاری برای پکیج‌های فعلی

• @tealup/nextjs-ui-core
• @tealup/nextjs-kit-server
• @tealup/nextjs-kit-client
• @tealup/nuxtjs-kit-client
• @tealup/nuxtjs-chart-core