ملحق Prettier

يقوم prettier-plugin-intlayer بوضع مفاتيح ترجماتك بترتيب ثابت في كل مرة يقوم فيها Prettier بتنسيق ملف. تظل الفروقات (diffs) صغيرة، وتصبح تعارضات الدمج أقل تكرارًا، ويسهل اكتشاف أي لغة مفقودة.

// قبل
t({ en: "Hello", ru: "Привет", fr: "Bonjour", "en-GB": "Hello", ar: "مرحبا" });

// بعد
t({ en: "Hello", ar: "مرحبا", "en-GB": "Hello", fr: "Bonjour", ru: "Привет" });

التثبيت

npm install --save-dev prettier prettier-plugin-intlayer

يتطلب Prettier الإصدار 3 أو أحدث.

إذا كان مشروعك يستخدم Prettier بالفعل، فإن الأمر intlayer init prettier يقوم بتثبيت الملحق وإضافته إلى ملف التكوين نيابةً عنك.

الاستخدام

أضف الملحق إلى ملف تكوين Prettier:

{
  "plugins": ["prettier-plugin-intlayer"]
}

لتطبيقه فقط على ملفات تعريف المحتوى الخاصة بك، استخدم التجاوز (override):

{
  "overrides": [
    {
      "files": "*.content.{ts,tsx,js,jsx,mjs,cjs,json}",
      "options": {
        "plugins": ["prettier-plugin-intlayer"],
        "intlayerSortContentKeys": true
      }
    }
  ]
}

ما الذي يتم ترتيبه

t(): اللغات

تأتي اللغات المثبتة أولاً (en افتراضيًا). وتتبعها بقية اللغات حسب الترتيب الأبجدي.

t({
  en: "Invitation not found",
  ar: "الدعوة غير موجودة",
  de: "Einladung nicht gefunden",
  "en-GB": "Invitation not found",
  fr: "Invitation introuvable",
  "he-IL": "ההזمנה לא נמצאה",
});

plural(): ترتيب CLDR

تنتقل الفئات من أصغر كمية إلى القيمة الاحتياطية (fallback): zero، one، two، few، many، other.

plural({
  one: "{{count}} вакансия",
  few: "{{count}} вакансии",
  many: "{{count}} вакансий",
  other: "{{count}} вакансий",
});

enu(): حدود تصاعدية

يتم فرز الشروط حسب رقمها، ثم حسب المعامل (<1، <=1، 1، >=1، >1). يوضع fallback في النهاية.

enu({
  "<-1": "Less than minus one car",
  "0": "No cars",
  "2": "Two cars",
  ">=3": "Many cars",
  fallback: "Some cars",
});

في وقت التشغيل، يسري أول شرط مطابق. يطبق الملحق الترتيب الجديد فقط عندما تؤول كل كمية إلى نفس المحتوى. عندما يحدد الترتيب النتيجة، يترك الكائن كما كُتب تمامًا. على سبيل المثال، في { '<1': …, '<=-2.3': … } يلتقط المفتاح '<1' كل رقم سالب.

select(): أبجديًا

يتم ترتيب الحالات أبجديًا ويوضع fallback في النهاية.

select({
  draft: "This post is a draft",
  published: "This post is live",
  scheduled: "This post is scheduled",
  fallback: "Unknown status",
});

بدون مفتاح fallback أو other، يتم استخدام الحالة الأخيرة كقيمة احتياطية. تظل تلك الحالة في النهاية ويتم ترتيب الحالات التي تسبقها فقط.

ملفات .content.json

يتم ترتيب الشكل التسلسلي بنفس الطريقة: { "nodeType": "translation", "translation": { … } }، بالإضافة إلى عقد plural و enumeration و select.

مفاتيح المحتوى (اختياري)

باستخدام intlayerSortContentKeys: true، يقوم الملحق أيضًا بفرز مفاتيح content في القاموس أبجديًا في كل مستويات التداخل. ينطبق هذا فقط في ملفات *.content.*.

export default {
  key: "app",
  content: {
    description: t({ en: "…", fr: "…" }),
    footer: {
      copyright: "© Intlayer",
      links: [{ href: "/doc", label: t({ en: "Docs", fr: "Docs" }) }],
    },
    title: t({ en: "Hello", fr: "Bonjour" }),
  },
} satisfies Dictionary;

يستمر الترتيب عبر كل دالة مساعدة (t، plural، enu، select، cond، gender، md، insert، nest، file…) للوصول إلى الكائنات داخلها. يحتفظ مخطط المفاتيح الخاص بكل مساعد بترتيبه. لا يُعاد ترتيب المفاتيح الممررة إلى cond() و gender() أبدًا لأن آخر مفتاح يعمل كقيمة احتياطية. تظل الحقول المجاورة لـ content (key، title، locale…) كما هي.

الخيارات

ما يترك دون تغيير

• الكائنات التي تحتوي على spread (...base)، أو مفتاح محسوب ([key])، أو دالة، أو مفتاح مكرر.
• خرائط plural() بمفتاح لا يمثل فئة CLDR.
• خرائط enu() التي قد يؤدي تغيير ترتيبها إلى تغيير المحتوى المحلول.
• استدعاءات أي دالة أخرى مسماة كدالة مساعدة ولكن تم تمرير وسيط ليس كائنًا إليها.

تتحرك التعليقات مع المفتاح الذي تنتمي إليه.

المحللات المدعومة (Parsers)

babel و babel-flow و babel-ts و typescript و flow و acorn و espree و meriyah و json و json5 و jsonc. يتم أيضًا تنسيق كتل <script> في ملفات Vue و Svelte و Astro باستخدام هذه المحللات.

قيد معروف. يشغل Prettier ملحقًا واحدًا فقط لكل محلل. إذا استبدل ملحق آخر محللات JavaScript/TypeScript أيضًا (على سبيل المثال prettier-plugin-tailwindcss)، فسيتم تطبيق آخر ملحق مدرج فقط على تلك الملفات. حدد نطاق prettier-plugin-intlayer لملفات *.content.* باستخدام override لتجنب التعارض.