Intlayer Compiler | i18n के लिए स्वचालित सामग्री निष्कर्षण

Intlayer Compiler क्या है?

Intlayer Compiler एक शक्तिशाली उपकरण है जिसे आपके एप्लिकेशन में अंतरराष्ट्रीयकरण (i18n) की प्रक्रिया को स्वचालित करने के लिए डिज़ाइन किया गया है। यह आपके स्रोत कोड (JSX, TSX, Vue, Svelte) में सामग्री घोषणाओं को स्कैन करता है, उन्हें निकालता है, और आवश्यक शब्दकोश फ़ाइलों को स्वचालित रूप से उत्पन्न करता है। यह आपको अपनी सामग्री को आपके कंपोनेंट्स के साथ सह-स्थित रखने की अनुमति देता है जबकि Intlayer आपके शब्दकोशों के प्रबंधन और समन्वय को संभालता है।

Intlayer Compiler का उपयोग क्यों करें?

• स्वचालन: शब्दकोशों में सामग्री की मैनुअल कॉपी-पेस्टिंग को समाप्त करता है।

• Speed: अनुकूलित कंटेंट निष्कर्षण आपकी बिल्ड प्रक्रिया को तेज़ रखता है।

• Developer Experience: Content declarations को उसी जगह रखें जहां उनका उपयोग किया जाता है, जिससे maintainability में सुधार होता है।

• स्वचालन: सामग्री को शब्दकोशों में मैन्युअल कॉपी-पेस्ट करने की आवश्यकता समाप्त करता है।
• गति: अनुकूलित सामग्री निष्कर्षण सुनिश्चित करता है कि आपका बिल्ड प्रक्रिया तेज़ बनी रहे।
• डेवलपर अनुभव: सामग्री घोषणाओं को वहीं रखें जहां उनका उपयोग होता है, जिससे रखरखाव में सुधार होता है।
• लाइव अपडेट्स: विकास के दौरान त्वरित प्रतिक्रिया के लिए Hot Module Replacement (HMR) का समर्थन करता है।

गहरे तुलना के लिए Compiler vs. Declarative i18n ब्लॉग पोस्ट देखें।

Intlayer Compiler का उपयोग क्यों न करें?

हालांकि कंपाइलर एक उत्कृष्ट "बस काम करता है" अनुभव प्रदान करता है, यह कुछ समझौते भी पेश करता है जिनके बारे में आपको पता होना चाहिए:

• हेयूरिस्टिक अस्पष्टता: कंपाइलर को यह अनुमान लगाना होगा कि उपयोगकर्ता-सामना करने वाली सामग्री बनाम एप्लिकेशन लॉजिक क्या है (उदाहरण के लिए, className="active", स्थिति कोड, उत्पाद ID)। जटिल कोडबेस में, यह गलत सकारात्मक या छूटी हुई स्ट्रिंग्स का कारण बन सकता है जिन्हें मैन्युअल एनोटेशन और अपवादों की आवश्यकता होती है।

• केवल स्थैतिक निष्कर्षण: कंपाइलर-आधारित निष्कर्षण स्थैतिक विश्लेषण पर निर्भर करता है। स्ट्रिंग्स जो केवल रनटाइम पर मौजूद होती हैं (API त्रुटि कोड, CMS फ़ील्ड, आदि) को कंपाइलर द्वारा अकेले खोजा या अनुवादित नहीं किया जा सकता है, इसलिए आपको अभी भी एक पूरक रनटाइम i18n रणनीति की आवश्यकता है।

• Static-only extraction: Compiler-based extraction static analysis पर निर्भर करती है। Strings जो केवल runtime पर exist करती हैं (API error codes, CMS fields, आदि) को compiler अकेले discover या translate नहीं कर सकता है, इसलिए आपको अभी भी एक complementary runtime i18n strategy की आवश्यकता है।

गहरी वास्तुकला तुलना के लिए, Compiler vs. Declarative i18n ब्लॉग पोस्ट देखें।

वैकल्पिक रूप से, अपनी सामग्री पर पूर्ण नियंत्रण रखते हुए अपनी i18n प्रक्रिया को स्वचालित करने के लिए, Intlayer एक स्वचालित निष्कर्षण कमांड intlayer extract (देखें CLI दस्तावेज़ीकरण) या Intlayer VS Code एक्सटेंशन का Intlayer: extract content to Dictionary कमांड (देखें VS Code एक्सटेंशन दस्तावेज़ीकरण) भी प्रदान करता है।

उपयोग

The quickest way to wire the compiler in is the interactive setup: run npx intlayer init --interactive and select Compiler. On Vite there is nothing to configure — the compiler is plugged in directly through the intlayerCompiler() plugin. On Next.js the command scaffolds the babel.config.js shown below. The non-interactive intlayer init leaves the compiler setup untouched.

npm install vite-intlayer

import { defineConfig } from "vite";
import { intlayer } from "vite-intlayer";

export default defineConfig({
  plugins: [
    intlayer({
      proxy: {
        ignore: (req) => req.url?.startsWith("/api"),
      },
    }),
  ],
});

# Vue के लिए
npm install @intlayer/vue-compiler

# Svelte के लिए
npm install @intlayer/svelte-compiler

npm install @intlayer/babel

const {
  intlayerExtractBabelPlugin,
  intlayerOptimizeBabelPlugin,
  getExtractPluginOptions,
  getOptimizePluginOptions,
} = require("@intlayer/babel");

module.exports = {
  presets: ["next/babel"],
  plugins: [
    // Extract content from components into dictionaries
    [intlayerExtractBabelPlugin, getExtractPluginOptions()],
    // Optimize imports by replacing useIntlayer with direct dictionary imports
    [intlayerOptimizeBabelPlugin, getOptimizePluginOptions()],
  ],
};

कस्टम कॉन्फ़िगरेशन

कंपाइलर व्यवहार को अनुकूलित करने के लिए, आप अपने प्रोजेक्ट के रूट में intlayer.config.ts फ़ाइल को अपडेट कर सकते हैं।

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

const config: IntlayerConfig = {
  compiler: {
    /**
     * इंगित करता है कि क्या कंपाइलर सक्षम होना चाहिए।
     * विकास के दौरान कंपाइलर को छोड़ने और स्टार्टअप समय को तेज करने के लिए 'build-only' पर सेट करें।
     */
    enabled: true,

    /**
     * आउटपुट फ़ाइल पथ को परिभाषित करता है। `outputDir` को प्रतिस्थापित करता है।
     *
     * - `./` पथ घटक निर्देशिका के सापेक्ष हल किए जाते हैं।
     * - `/` पथ प्रोजेक्ट रूट (`baseDir`) के सापेक्ष हल किए जाते हैं।
     *
     * - पथ में `{{locale}}` चर डालने से भाषा द्वारा अलग किए गए शब्दकोश निर्माण सक्षम हो जाएंगे।
     *
     * उदाहरण:
     * ```ts
     * {
     *   // घटक के बगल में बहुभाषी .content.ts फ़ाइलें बनाएँ
     *   output: ({ fileName, extension }) => `./${fileName}${extension}`,
     *
     *   // output: './{{fileName}}{{extension}}', // स्ट्रिंग टेम्प्लेट का उपयोग करके समकक्ष
     * }
     * ```
     *
     * ```ts
     * {
     *   // प्रोजेक्ट रूट पर भाषा द्वारा केंद्रीकृत JSON फ़ाइलें बनाएँ
     *   output: ({ key, locale }) => `/locales/${locale}/${key}.content.json`,
     *
     *   // output: '/locales/{{locale}}/{{key}}.content.json', // स्ट्रिंग टेम्प्लेट का उपयोग करके समकक्ष
     * }
     * ```
     *
     * चर सूची:
     *   - `fileName`: फ़ाइल का नाम।
     *   - `key`: सामग्री की कुंजी।
     *   - `locale`: सामग्री का स्थानीय मान (लोकल)।
     *   - `extension`: फ़ाइल एक्सटेंशन।
     *   - `componentFileName`: घटक फ़ाइल का नाम।
     *   - `componentExtension`: घटक फ़ाइल एक्सटेंशन।
     *   - `format`: शब्दकोश प्रारूप।
     *   - `componentFormat`: घटक शब्दकोश प्रारूप।
     *   - `componentDirPath`: घटक निर्देशिका पथ।
     */
    output: ({ fileName, extension }) => `./${fileName}${extension}`,

    /**
     * इंगित करता है कि क्या घटकों को रूपांतरित होने के बाद सहेजा जाना चाहिए।
     * इस तरह, कंपाइलर को ऐप को रूपांतरित करने के लिए केवल एक बार चलाया जा सकता है, और फिर इसे हटाया जा सकता है।
     */
    saveComponents: false,

    /**
     * उत्पन्न फ़ाइल में केवल सामग्री डालें। i18next या ICU MessageFormat JSON आउटपुट प्रति लोकल के लिए उपयोगी।
     *
     * - `output: ({ locale, key }) => `./locale/${locale}/${key}.json`,`
     */
    noMetadata: false,

    /**
     * शब्दकोश कुंजी उपसर्ग
     */
    dictionaryKeyPrefix: "", // निकाली गई शब्दकोश कुंजियों के लिए वैकल्पिक उपसर्ग जोड़ें
  },
};

export default config;

कंपाइलर कॉन्फ़िगरेशन संदर्भ

निम्नलिखित गुणों को आपकी intlayer.config.ts फ़ाइल के compiler ब्लॉक में कॉन्फ़िगर किया जा सकता है:

• enabled:

  • प्रकार: boolean | 'build-only'
  • डिफ़ॉल्ट: true
  • विवरण: इंगित करता है कि क्या कंपाइलर सक्षम होना चाहिए।

• dictionaryKeyPrefix:

  • प्रकार: string
  • डिफ़ॉल्ट: ''
  • विवरण: निकाली गई शब्दकोश कुंजियों के लिए उपसर्ग।

• transformPattern:

  • प्रकार: string | string[]
  • डिफ़ॉल्ट: ['**/*.{js,ts,mjs,cjs,jsx,tsx,vue,svelte}', '!**/node_modules/**']
  • विवरण: (पुराना (Deprecated): इसके बजाय build.traversePattern का उपयोग करें) ऑप्टिमाइज़ करने के लिए कोड को पार करने के पैटर्न।

• excludePattern:

  • प्रकार: string | string[]
  • डिफ़ॉल्ट: ['**/node_modules/**']
  • विवरण: (पुराना (Deprecated): इसके बजाय build.traversePattern का उपयोग करें) ऑप्टिमाइज़ेशन से बाहर रखने के पैटर्न।

• output:

  • प्रकार: FilePathPattern
  • डिफ़ॉल्ट: ({ key }) => 'compiler/${key}.content.json'
  • विवरण: आउटपुट फ़ाइल पथ को परिभाषित करता है। outputDir को प्रतिस्थापित करता है। {{locale}}, {{key}}, {{fileName}}, {{extension}}, {{format}}, {{dirPath}}, {{componentFileName}}, {{componentExtension}}, और {{componentFormat}} जैसे गतिशील चरों को संभालता है। इसे 'my/{{var}}/path' प्रारूप का उपयोग करके एक स्ट्रिंग के रूप में, या एक फ़ंक्शन के रूप में सेट किया जा सकता है।
  • नोट: ./**/* पथ घटक के सापेक्ष हल किए जाते हैं। /**/* पथ Intlayer baseDir के सापेक्ष हल किए जाते हैं।
  • नोट: यदि पथ में लोकेल (locale) परिभाषित है, तो शब्दकोश लोकेल द्वारा उत्पन्न किए जाएंगे।
  • उदाहरण: output: ({ locale, key }) => 'compiler/${locale}/${key}.json'

• noMetadata:

  • प्रकार: boolean
  • डिफ़ॉल्ट: false
  • विवरण: इंगित करता है कि फ़ाइल में मेटाडेटा सहेजा जाना चाहिए या नहीं। यदि सही है, तो कंपाइलर शब्दकोशों (कुंजी, सामग्री रैपर) के मेटाडेटा को नहीं बचाएगा। प्रति-लोकल i18next या ICU MessageFormat JSON आउटपुट के लिए उपयोगी।
  • नोट: loadJSON प्लगइन के साथ उपयोग किए जाने पर उपयोगी।
  • उदाहरण: यदि सही है: json { "key": "value" } यदि गलत है: json { "key": "value", "content": { "key": "value" } }

• saveComponents:

  • प्रकार: boolean
  • डिफ़ॉल्ट: false
  • विवरण: इंगित करता है कि क्या घटकों को रूपांतरित होने के बाद सहेजा जाना चाहिए।

लापता अनुवाद भरें

Intlayer अनुवादों को भरने में आपकी सहायता के लिए एक CLI टूल प्रदान करता है। आप अपने कोड से लापता अनुवादों का परीक्षण करने और उन्हें भरने के लिए intlayer कमांड का उपयोग कर सकते हैं।

npx intlayer test         # परीक्षण करें कि क्या कोई अनुवाद लापता है

npx intlayer fill         # लापता अनुवाद भरें

निष्कर्षण

Intlayer आपके कोड से सामग्री निकालने के लिए एक CLI टूल प्रदान करता है। आप अपने कोड से सामग्री निकालने के लिए intlayer extract कमांड का उपयोग कर सकते हैं।

npx intlayer extract

अधिक विवरण के लिए, CLI दस्तावेज़ देखें।