Intlayer Compiler | Автоматизоване витягування контенту для i18n

Що таке Intlayer Compiler?

Intlayer Compiler - це потужний інструмент, розроблений для автоматизації процесу інтернаціоналізації (i18n) у ваших додатках. Він сканує ваш вихідний код (JSX, TSX, Vue, Svelte) на наявність декларацій контенту, витягує їх і автоматично генерує необхідні файли словників. Це дозволяє зберігати контент поруч із компонентами, тоді як Intlayer займається керуванням та синхронізацією ваших словників.

Чому використовувати Intlayer Compiler?

• Автоматизація: Усуває необхідність ручного копіювання вмісту в словники.

• Speed: Оптимізована екстракція контенту, що забезпечує швидкість вашого процесу збірки.

• Автоматизація: Усуває ручне копіювання та вставляння контенту у словники.
• Швидкість: Оптимізоване витягування контенту забезпечує швидкість процесу збірки.
• Досвід розробника: Тримайте декларації контенту там, де вони використовуються, що покращує підтримуваність.

• Оновлення в реальному часі: Підтримує Hot Module Replacement (HMR) для миттєвого зворотного зв'язку під час розробки.

• Live Updates: Підтримує Hot Module Replacement (HMR) для миттєвого зворотного зв'язку під час розробки.

Див. статтю в блозі Compiler vs. Declarative i18n для глибшого порівняння.

Чому не використовувати Intlayer Compiler?

Хоча компілятор пропонує чудовий досвід «just works», він також вносить певні компроміси, про які варто знати:

• Евристична неоднозначність: Компілятор має вгадувати, що є контентом для користувача, а що - логікою додатка (наприклад, className="active", коди статусів, ID продуктів). У складних кодових базах це може призводити до хибних спрацьовувань або пропущених рядків, що вимагатиме ручних анотацій та винятків.

• Тільки статична екстракція: Екстракція на основі компілятора покладається на статичний аналіз. Рядки, які існують лише під час виконання (коди помилок API, поля CMS тощо), не можуть бути виявлені або перекладені лише компілятором, тому вам усе одно знадобиться додаткова стратегія i18n під час виконання.

• Лише статична екстракція: Екстракція на основі компілятора спирається на статичний аналіз. Рядки, які існують лише під час виконання (коди помилок API, поля CMS тощо), не можуть бути виявлені або перекладені компілятором самостійно, тому вам все ще потрібна додаткова стратегія runtime i18n.

Для глибшого архітектурного порівняння див. статтю в блозі Compiler vs. Declarative i18n.

Як альтернативу, щоб автоматизувати ваш процес i18n і зберегти повний контроль над контентом, Intlayer також пропонує команду автоматичної екстракції intlayer extract (див. документацію CLI), або команду Intlayer: extract content to Dictionary з розширення Intlayer для VS Code (див. документацію розширення 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: [
    // Витягує контент з компонентів у словники
    [intlayerExtractBabelPlugin, getExtractPluginOptions()],
    // Оптимізує імпорти, замінюючи useIntlayer на прямі імпорти словників
    [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,

    /**
     * Вставляє лише контент у згенерований файл. Корисно для виводу JSON для i18next або ICU MessageFormat для кожної локалі.
     *
     * - `output: ({ locale, key }) => `./locale/${locale}/${key}.json`,`
     */
    noMetadata: false,

    /**
     * Префікс ключа словника
     */
    dictionaryKeyPrefix: "", // Додає необов'язковий префікс для витягнутих ключів словника
  },
};

export default config;

Довідник з конфігурації компілятора

Наступні властивості можна налаштувати в блоці compiler вашого файлу intlayer.config.ts:

• enabled:

  • Тип: boolean | 'build-only'
  • Типово: true
  • Опис: Вказує, чи має бути увімкнено компілятор.

• dictionaryKeyPrefix:

  • Тип: string
  • Типово: ''
  • Опис: Префікс для витягнутих ключів словника.

• transformPattern:

  • Тип: string | string[]
  • Типово: ['**/*.{js,ts,mjs,cjs,jsx,tsx,vue,svelte}', '!**/node_modules/**']
  • Опис: (Застаріло: використовуйте build.traversePattern) Шаблони для обходу коду для оптимізації.

• excludePattern:

  • Тип: string | string[]
  • Типово: ['**/node_modules/**']
  • Опис: (Застаріло: використовуйте build.traversePattern) Шаблони для виключення з оптимізації.

• output:

  • Тип: FilePathPattern
  • Типово: ({ key }) => 'compiler/${key}.content.json'
  • Опис: Визначає шлях до вихідних файлів. Замінює outputDir. Обробляє динамічні змінні, такі як {{locale}}, {{key}}, {{fileName}}, {{extension}}, {{format}}, {{dirPath}}, {{componentFileName}}, {{componentExtension}} та {{componentFormat}}. Можна встановити як рядок у форматі 'my/{{var}}/path' або як функцію.
  • Примітка: Шляхи ./**/* розв'язуються відносно компонента. Шляхи /**/* розв'язуються відносно baseDir Intlayer.
  • Примітка: Якщо локаль визначена в шляху, словники будуть генеруватися для кожної локалі.
  • Приклад: output: ({ locale, key }) => 'compiler/${locale}/${key}.json'

• noMetadata:

  • Тип: boolean
  • Типово: false
  • Опис: Вказує, чи мають метадані зберігатися у файлі. Якщо true, компілятор не зберігатиме метадані словників (ключ, оболонка вмісту). Корисно для виводу JSON для i18next або ICU MessageFormat для кожної локалі.
  • Примітка: Корисно при використанні з плагіном loadJSON.
  • Приклад: Якщо true: json { "key": "value" } Якщо false: 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