कंटेंट डिक्लेरेशन फ़ाइल अनुवाद भरें

अपने CI में कंटेंट डिक्लेरेशन फ़ाइलों को ऑटोफिल करना आपके विकास वर्कफ़्लो को तेज़ करने का एक तरीका है।

व्यवहार को समझना

fill कमांड में दो मोड शामिल हैं:

• Complete: प्रत्येक locale के लिए सभी missing content को स्वचालित रूप से भरें और वर्तमान फ़ाइल को संपादित करें, या यदि निर्दिष्ट हो तो दूसरी फ़ाइल को संपादित करें। यानी, complete मोड पहले से से अनुवादित मौजूदा content को छोड़ देगा।
• Review: प्रत्येक locale के लिए सभी content को स्वचालित रूप से भरें और एक विशिष्ट फ़ाइल के लिए generate करें, या यदि निर्दिष्ट हो तो दूसरी फ़ाइल के लिए generate करें।

fill कमांड आपकी सभी locale content declaration files को process करेगा। यानी, यह CMS से आपकी remote content को process नहीं करेगा। CMS के पास अपना स्वयं का translations management है। यदि आप @intlayer/sync-json-plugin जैसे plugins का उपयोग करते हैं, तो Intlayer JSON files को locale content declaration files में transform करेगा। यानी, वे fill कमांड द्वारा process किए जाएंगे।

नई generated files में एक filled instruction को dictionary metadata के रूप में शामिल है। यह instruction Intlayer को यह जानने के लिए उपयोग किया जाएगा कि फ़ाइल को autofilled किया गया है या नहीं, और यदि मौजूद है तो इस फ़ाइल को फिर से translate किए जाने से छोड़ दें।

Intlayer autofill के लिए निम्नलिखित instruction पर भी विचार करेगा:

• आपकी .content.{ts|js|json} → fill instruction से
• आपकी configuration file .intlayer.config.ts → dictionary.fill instruction से
• अन्यथा true पर set किया जाएगा

Per-locale content declaration files के लिए, true instruction को ./{{fileName}}.fill.content.json से replace किया जाएगा। यह इसलिए है क्योंकि एक per-locale content declaration file अतिरिक्त localized content प्राप्त नहीं कर सकता है। इसलिए यह मौजूदा फ़ाइल को overwrite न करने के लिए एक नई फ़ाइल generate करेगा।

डिफ़ॉल्ट व्यवहार

डिफ़ॉल्ट रूप से, fill को globally true पर सेट किया गया है, जिसका अर्थ है कि Intlayer automatically सभी content files को fill करेगा और फ़ाइल को स्वयं edit करेगा। इस व्यवहार को कई तरीकों से customize किया जा सकता है:

वैश्विक कॉन्फ़िगरेशन विकल्प

1. fill: true (डिफ़ॉल्ट) - सभी locales को स्वचालित रूप से भरें और वर्तमान फ़ाइल को संपादित करें
2. fill: false - इस सामग्री फ़ाइल के लिए स्वचालित भरण अक्षम करें
3. fill: "./relative/path/to/file" - वर्तमान फ़ाइल को संपादित किए बिना निर्दिष्ट फ़ाइल को बनाएं/अपडेट करें, वर्तमान फ़ाइल के स्थान के आधार पर हल किए गए सापेक्ष पथ की ओर इशारा करके
4. fill: "/absolute/path/to/file" - वर्तमान फ़ाइल को संपादित किए बिना निर्दिष्ट फ़ाइल को बनाएं/अपडेट करें, कॉन्फ़िगरेशन फ़ाइल .intlayer.config.ts में बेस डायरेक्टरी (फ़ील्ड baseDir) के आधार पर हल किए गए सापेक्ष पथ की ओर इशारा करके
5. fill: "C:\absolute\path\to\file" - वर्तमान फ़ाइल को संपादित किए बिना निर्दिष्ट फ़ाइल को बनाएं/अपडेट करें, आपके ऑपरेटिंग सिस्टम के आधार पर हल किए गए निरपेक्ष पथ की ओर इशारा करके
6. fill: { [key in Locales]?: string } - प्रत्येक locale के लिए निर्दिष्ट फ़ाइल को बनाएं/अपडेट करें

v7 व्यवहार परिवर्तन

v7 में, fill कमांड का व्यवहार अपडेट किया गया है:

• fill: true - वर्तमान फ़ाइल को सभी locales के लिए भरी गई सामग्री के साथ फिर से लिखता है
• fill: "path/to/file" - निर्दिष्ट फ़ाइल को भरता है बिना वर्तमान फ़ाइल को संशोधित किए
• fill: false - auto-fill को पूरी तरह अक्षम करता है

जब किसी दूसरी फ़ाइल में लिखने के लिए path विकल्प का उपयोग करते हैं, तो fill तंत्र सामग्री घोषणा फ़ाइलों के बीच एक master-slave संबंध के माध्यम से काम करता है। मुख्य (master) फ़ाइल सत्य का स्रोत है, और जब इसे अपडेट किया जाता है, तो Intlayer स्वचालित रूप से उन परिवर्तनों को path द्वारा निर्दिष्ट व्युत्पन्न (भरी गई) घोषणा फ़ाइलों पर लागू करता है।

प्रति-लोकेल कस्टमाइज़ेशन

आप एक ऑब्जेक्ट का उपयोग करके प्रत्येक लोकेल के लिए व्यवहार को कस्टमाइज़ कर सकते हैं:

const config: IntlayerConfig = {
  content: {
    internationalization: {
      locales: [Locales.ENGLISH, Locales.FRENCH, Locales.POLISH],
      defaultLocale: Locales.ENGLISH,
      requiredLocales: [Locales.ENGLISH], // अनुशंसित है Property 'pl' is missing in type '{ en: string; xxx } on your t function if से बचने के लिए
    },
  },
  dictionary: {
    fill: {
      en: true, // अंग्रेजी के लिए वर्तमान फ़ाइल को भरें और संपादित करें
      fr: "./translations/fr.json", // फ्रेंच के लिए अलग फ़ाइल बनाएं
      es: false, // स्पैनिश के लिए fill को अक्षम करें
    },
  },
};

यह आपको एक ही प्रोजेक्ट के भीतर विभिन्न लोकेल के लिए विभिन्न fill व्यवहार रखने की अनुमति देता है।

import { Locales, type Dictionary } from "intlayer";

const exampleContent = {
  key: "example",
  locale: Locales.ENGLISH,
  fill: "./example.content.json",
  content: {
    contentExample: "यह सामग्री का एक उदाहरण है",
  },
} satisfies Dictionary;

export default exampleContent;

यहाँ fill instruction का उपयोग करने वाली एक per-locale content declaration file है।

फिर, जब आप निम्नलिखित आदेश चलाते हैं:

npx intlayer fill --file 'src/components/example/example.content.ts'

Intlayer स्वचालित रूप से src/components/example/example.content.json पर derived declaration file जेनरेट करेगा, मुख्य फ़ाइल में पहले से घोषित नहीं किए गए सभी लोकेल को भरते हुए।

{
  "key": "example",
  "content": {
    "contentExample": {
      "nodeType": "translation",
      "translation": {
        "fr": "Ceci est un exemple de contenu",
        "es": "Este es un ejemplo de contenido",
      },
    },
  },
}

इसके बाद, दोनों declaration files को एक एकल dictionary में मर्ज किया जाएगा, जिसे मानक useIntlayer("example") hook (react) / composable (vue) का उपयोग करके एक्सेस किया जा सकता है।

Global Configuration

आप intlayer.config.ts फ़ाइल में global auto fill configuration को कॉन्फ़िगर कर सकते हैं।

import { type IntlayerConfig, Locales } from "intlayer";

const config: IntlayerConfig = {
  internationalization: {
    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
    defaultLocale: Locales.ENGLISH,
    requiredLocales: [Locales.ENGLISH, Locales.FRENCH],
  },
  dictionary: {
    // सभी dictionaries के लिए लापता translations को auto-generate करें
    fill: "./{{fileName}}Filled.content.ts",
    //
    // fill: "/messages/{{locale}}/{{key}}/{{fileName}}.content.json",
    //
    // fill: true, // सभी dictionaries के लिए लापता translations को auto-generate करें जैसे "./{{fileName}}.content.json" का उपयोग करना
    //
    // fill: {
    //   en: "./{{fileName}}.en.content.json",
    //   fr: "./{{fileName}}.fr.content.json",
    //   es: "./{{fileName}}.es.content.json",
    // },
  },
};

export default config;

आप content files में fill field का उपयोग करके प्रति dictionary को fine-tune कर सकते हैं। Intlayer पहले per dictionary configuration पर विचार करेगा और फिर global configuration पर fallback करेगा।

ऑटोफिल की गई फ़ाइल प्रारूप

सिफारिश की गई स्वरूप ऑटोफिल की गई घोषणा फ़ाइलों के लिए JSON है, जो स्वरूपण प्रतिबंधों से बचने में मदद करता है। हालांकि, Intlayer .ts, .js, .mjs, .cjs, और अन्य स्वरूपों का भी समर्थन करता है।

const exampleContent = {
  key: "example",
  autoFill: "./example.filled.content.ts",
  content: {
    // आपकी सामग्री
  },
};

यह फ़ाइल इस स्थान पर उत्पन्न करेगा:

src/components/example/example.filled.content.ts

.js, .ts, और समान फ़ाइलों का निर्माण इस प्रकार काम करता है:

• यदि फ़ाइल पहले से मौजूद है, तो Intlayer इसे AST (Abstract Syntax Tree) का उपयोग करके पार्स करेगा ताकि प्रत्येक फ़ील्ड का पता लगाया जा सके और कोई भी गायब अनुवाद डाला जा सके।
• यदि फ़ाइल मौजूद नहीं है, तो Intlayer इसे डिफ़ॉल्ट सामग्री घोषणा फ़ाइल टेम्पलेट का उपयोग करके उत्पन्न करेगा।

पूर्ण पथ (Absolute Paths)

autoFill फ़ील्ड पूर्ण पथों का भी समर्थन करता है।

const exampleContent = {
  key: "example",
  autoFill: "/messages/example.content.json",
  content: {
    // आपकी सामग्री
  },
};

यह फ़ाइल इस स्थान पर उत्पन्न करेगा:

/messages/example.content.json

प्रति-स्थानीय सामग्री घोषणा फ़ाइलों का स्वचालित निर्माण (Autogenerate Per-Locale Content Declaration Files)

autoFill फ़ील्ड प्रति-स्थानीय सामग्री घोषणा फ़ाइलों के निर्माण का भी समर्थन करता है।

const exampleContent = {
  key: "example",
  autoFill: {
    fr: "./example.fr.content.json",
    es: "./example.es.content.json",
  },
  content: {
    // आपकी सामग्री
  },
};

यह दो अलग-अलग फ़ाइलें उत्पन्न करेगा:

• src/components/example/example.fr.content.json
• src/components/example/example.es.content.json

इस मामले में, यदि ऑब्जेक्ट में सभी स्थानीय भाषाएँ शामिल नहीं हैं, तो Intlayer बाकी स्थानीय भाषाओं की फ़ाइलें उत्पन्न करने से बचता है।

विशिष्ट स्थानीय ऑटोफिल को फ़िल्टर करें (Filter Specific Locale Autofill)

autoFill फ़ील्ड के लिए एक ऑब्जेक्ट का उपयोग करने से आप फ़िल्टर लागू कर सकते हैं और केवल विशिष्ट स्थानीय फ़ाइलें उत्पन्न कर सकते हैं।

const exampleContent = {
  key: "example",
  autoFill: {
    fr: "./example.fr.content.json",
  },
  content: {
    // आपकी सामग्री
  },
};

यह केवल फ्रेंच अनुवाद फ़ाइल उत्पन्न करेगा।

पथ चर (Path Variables)

आप उत्पन्न फ़ाइलों के लिए लक्षित पथों को गतिशील रूप से हल करने के लिए autoFill पथ के अंदर वेरिएबल्स का उपयोग कर सकते हैं।

उपलब्ध वेरिएबल्स:

• {{locale}} – स्थानीय कोड (जैसे fr, es)
• {{fileName}} – फ़ाइल नाम (जैसे index)
• {{key}} – शब्दकोश कुंजी (जैसे example)

const exampleContent = {
  key: "example",
  autoFill: "/messages/{{locale}}/{{key}}.content.json",
  content: {
    // आपकी सामग्री
  },
};

यह उत्पन्न करेगा:

• /messages/fr/example.content.json
• /messages/es/example.content.json

const exampleContent = {
  key: "example",
  autoFill: "./{{fileName}}.content.json",
  content: {
    // आपकी सामग्री
  },
};

यह उत्पन्न करेगा:

• ./index.content.json
• ./index.content.json