Переведите ваш веб-сайт на Vite и Lit с помощью Intlayer | Интернационализация (i18n)

Содержание

Почему Intlayer лучше альтернатив?

По сравнению с основными решениями, такими как «lit-localize» или «i18next», Intlayer — это решение со встроенными оптимизациями, такими как:

See Application Template on GitHub.

Пошаговое руководство по настройке Intlayer в приложении на Vite и Lit

1. 1

   Установка зависимостей

   Установите необходимые пакеты с помощью npm:

   bash

   Копировать содержимое

   Копировать код

   Копировать код в буфер обмена

   npx intlayer init --interactive
   

   флаг --interactive не является обязательным. Используйте intlayer-cli init, если вы являетесь ИИ-агентом.

   Эта команда определит вашу среду и установит необходимые пакеты. Например:

   bash

   Копировать содержимое

   Копировать код

   Копировать код в буфер обмена

   npm install intlayer lit-intlayer
   npm install vite-intlayer --save-dev
   

   • intlayer

     Основной пакет, предоставляющий инструменты интернационализации для управления конфигурацией, перевода, декларации контента, транспиляции и CLI-команд.

   • lit-intlayer Пакет, интегрирующий Intlayer с приложениями на Lit. Он предоставляет хуки на основе ReactiveController (useIntlayer, useLocale и т. д.), чтобы LitElement автоматически перерисовывались при смене языка.

   • vite-intlayer Включает плагин Vite для интеграции Intlayer с бандлером Vite, а также промежуточное ПО (middleware) для определения предпочтительного языка пользователя, управления куки и обработки перенаправления URL.

2. 2

   Конфигурация вашего проекта

   Архитектура

   В этой архитектуре lit-intlayer предоставляет интеграцию пользовательских элементов и реактивные контроллеры для управления переводами внутри Web Components. Объявления контента находятся в src/ рядом с элементами.

   bash

   Копировать содержимое

   Копировать код

   Копировать код в буфер обмена

   .
   ├── src
   │   ├── app.content.ts
   │   ├── index.css
   │   ├── locale-switcher.ts
   │   ├── main.ts
   │   └── my-element.ts                 # Main Lit element
   ├── index.html
   ├── intlayer.config.ts
   ├── package.json
   ├── tsconfig.json
   └── vite.config.ts
   

   Конфигурация

   Создайте файл конфигурации для настройки языков вашего приложения:

   intlayer.config.ts

   Копировать содержимое

   Копировать код

   Копировать код в буфер обмена

   import { Locales, type IntlayerConfig } from "intlayer";
   
   const config: IntlayerConfig = {
     internationalization: {
       locales: [
         Locales.ENGLISH,
         Locales.FRENCH,
         Locales.SPANISH,
         // Ваши другие локали
       ],
       defaultLocale: Locales.ENGLISH,
     },
   };
   
   export default config;
   

   Через этот файл конфигурации вы можете настроить локализованные URL, перенаправление middleware, имена куки, местоположение и расширение ваших деклараций контента, отключить логи Intlayer в консоли и многое другое. Полный список доступных параметров см. в документации по конфигурации.

3. 3

   Интеграция Intlayer в конфигурацию Vite

   Добавьте плагин intlayer в вашу конфигурацию.

   vite.config.ts

   Копировать содержимое

   Копировать код

   Копировать код в буфер обмена

   import { defineConfig } from "vite";
   import { intlayer } from "vite-intlayer";
   
   // https://vitejs.dev/config/
   export default defineConfig({
     plugins: [
       intlayer({
         proxy: {
           ignore: (req) => req.url?.startsWith("/api"),
         },
       }),
     ],
   });
   

   Плагин Vite intlayer() используется для интеграции Intlayer с Vite. Он обеспечивает создание файлов декларации контента и отслеживает их изменения в режиме разработки. Он определяет переменные окружения Intlayer внутри приложения Vite. Кроме того, он предоставляет псевдонимы (aliases) для оптимизации производительности.

4. 4

   Инициализация Intlayer в вашей точке входа

   Вызовите installIntlayer() перед регистрацией любых кастомных элементов, чтобы глобальный синглтон локали был готов к моменту подключения первого элемента.

   src/main.ts

   Копировать содержимое

   Копировать код

   Копировать код в буфер обмена

   import { installIntlayer } from "lit-intlayer";
   
   // Должно быть вызвано до того, как любой LitElement будет подключен к DOM.
   installIntlayer();
   
   // Импорт и регистрация ваших кастомных элементов.
   import "./my-element.js";
   

   Если вы также используете декларации контента md() (Markdown), установите также рендерер макдауна:

   src/main.ts

   Копировать содержимое

   Копировать код

   Копировать код в буфер обмена

   import { installIntlayer, installIntlayerMarkdown } from "lit-intlayer";
   
   installIntlayer();
   installIntlayerMarkdown();
   
   import "./my-element.js";
   

5. 5

   Декларация вашего контента

   Создавайте и управляйте декларациями контента для хранения переводов:

   src/app.content.ts

   Копировать содержимое

   Копировать код

   Копировать код в буфер обмена

   import { t, type Dictionary } from "intlayer";
   
   const appContent = {
     key: "app",
     content: {
       title: "Vite + Lit",
   
       viteLogo: t({
         en: "Vite logo",
         fr: "Logo Vite",
         es: "Logo Vite",
       }),
       litLogo: t({
         en: "Lit logo",
         fr: "Logo Lit",
         es: "Logo Lit",
       }),
   
       count: t({
         en: "count is {{count}}",
         fr: "le compte est {{count}}",
         es: "el recuento es {{count}}",
       }),
   
       readTheDocs: t({
         en: "Click on the Vite and Lit logos to learn more",
         fr: "Cliqueз sur les logos Vite et Lit pour en savoir plus",
         es: "Haga clic en los logotipos de Vite y Lit para obtener más información",
       }),
     },
   } satisfies Dictionary;
   
   export default appContent;
   

   Декларации контента могут быть определены в любом месте вашего приложения, если они включены в директорию contentDir (по умолчанию ./src) и соответствуют расширению файлов декларации контента (по умолчанию .content.{json,ts,tsx,js,jsx,mjs,cjs,md,mdx,yaml,yml}).

   Подробнее см. в документации по декларации контента.

6. 6

   Использование Intlayer в вашем LitElement

   Используйте useIntlayer внутри LitElement. Он возвращает прокси ReactiveController, который автоматически вызывает перерисовку при изменении активного языка - никакой дополнительной настройки не требуется.

   src/my-element.ts

   Копировать содержимое

   Копировать код

   Копировать код в буфер обмена

   import { LitElement, html } from "lit";
   import { customElement, property } from "lit/decorators.js";
   import { useIntlayer } from "lit-intlayer";
   
   @customElement("my-element")
   export class MyElement extends LitElement {
     @property({ type: Number })
     count = 0;
   
     // useIntlayer регистрирует себя как ReactiveController.
     // Элемент перерисовывается автоматически при смене языка.
     private content = useIntlayer(this, "app");
   
     override render() {
       const { content } = this;
   
       return html`
         <h1>${content.title}</h1>
   
         <img src="/vite.svg" alt=${content.viteLogo.value} />
         <img src="/lit.svg" alt=${content.litLogo.value} />
   
         <button @click=${() => this.count++}>
           ${content.count({ count: this.count })}
         </button>
   
         <p>${content.readTheDocs}</p>
       `;
     }
   }
   

   Если вам нужна переведенная строка в нативном HTML-атрибуте (например, alt, aria-label, title), вызовите .value на конечном узле:

   typescript

   Копировать содержимое

   Копировать код

   Копировать код в буфер обмена

   html`<img alt=${content.viteLogo.value} />`;
   html`<img alt=${content.viteLogo.toString()} />`;
   html`<img alt=${String(content.viteLogo)} />`;
   

7. 7

   Изменение языка вашего контента

   Необязательно

   Чтобы изменить язык контента, используйте метод setLocale, предоставляемый контроллером useLocale.

   src/locale-switcher.ts

   Копировать содержимое

   Копировать код

   Копировать код в буфер обмена

   import { LitElement, html } from "lit";
   import { customElement } from "lit/decorators.js";
   import { getLocaleName } from "intlayer";
   import { useLocale } from "lit-intlayer";
   
   @customElement("locale-switcher")
   export class LocaleSwitcher extends LitElement {
     private locale = useLocale(this);
   
     private _onChange(e: Event) {
       const select = e.target as HTMLSelectElement;
       this.locale.setLocale(select.value as any);
     }
   
     override render() {
       return html`
         <select @change=${this._onChange}>
           ${this.locale.availableLocales.map(
             (loc) => html`
               <option value=${loc} ?selected=${loc === this.locale.locale}>
                 ${getLocaleName(loc)}
               </option>
             `
           )}
         </select>
       `;
     }
   }
   

8. 8

   Рендеринг Markdown и HTML контента

   Необязательно

   Intlayer поддерживает декларации контента md() и html(). В Lit скомпилированный результат вставляется как необработанный HTML через директиву unsafeHTML.

   Рендеринг скомпилированного HTML в вашем элементе:

   src/my-element.ts

   Копировать содержимое

   Копировать код

   Копировать код в буфер обмена

   import { LitElement, html } from "lit";
   import { customElement } from "lit/decorators.js";
   import { unsafeHTML } from "lit/directives/unsafe-html.js";
   import { useIntlayer } from "lit-intlayer";
   import { compileMarkdown } from "lit-intlayer/markdown";
   
   @customElement("my-element")
   export class MyElement extends LitElement {
     private content = useIntlayer(this, "app");
   
     override render() {
       return html`
         <div class="edit-note">
           ${unsafeHTML(compileMarkdown(String(this.content.editNote)))}
         </div>
       `;
     }
   }
   

   TIP

   String(content.editNote) вызывает toString() на IntlayerNode, который возвращает необработанную строку Markdown. Передайте ее в compileMarkdown, чтобы получить HTML-строку, а затем отрендерите ее с помощью директивы unsafeHTML от Lit.

9. 9

   Добавление локализованной маршрутизации

   Необязательно

   Чтобы создать уникальные маршруты для каждого языка (полезно для SEO), вы можете использовать клиентский роутер вместе с помощниками Intlayer localeMap / localeFlatMap и плагином Vite intlayerProxy для определения языка на стороне сервера.

   Сначала добавьте intlayerProxy в конфигурацию Vite:

   Обратите внимание, что для использования intlayerProxy в продакшене вам нужно переместить vite-intlayer из devDependencies в dependencies.

   Начиная с Intlayer v9, intlayerProxy() встроен непосредственно в плагин intlayer() и включен по умолчанию через опцию routing.enableProxy (true по умолчанию). Регистрация его отдельно, как показано ниже, теперь является опциональной — она сохранена для обратной совместимости и для конфигураций, которым нужно контролировать порядок плагинов. Установите routing.enableProxy: false для отключения. См. заметки о выпуске v9.

   vite.config.ts

   Копировать содержимое

   Копировать код

   Копировать код в буфер обмена

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

10. 10

    Изменение URL при смене языка

    Необязательно

    Чтобы обновлять URL браузера при смене языка, используйте useRewriteURL вместе с переключателем языка:

    src/locale-switcher.ts

    Копировать содержимое

    Копировать код

    Копировать код в буфер обмена

    import { LitElement, html } from "lit";
    import { customElement } from "lit/decorators.js";
    import { getLocaleName, getLocalizedUrl } from "intlayer";
    import { useLocale, useRewriteURL } from "lit-intlayer";
    
    @customElement("locale-switcher")
    export class LocaleSwitcher extends LitElement {
      private locale = useLocale(this);
    
      // Автоматически перезаписывает текущий URL при смене языка.
      private _rewriteURL = useRewriteURL(this);
    
      private _onChange(e: Event) {
        const select = e.target as HTMLSelectElement;
        this.locale.setLocale(select.value as any);
      }
    
      override render() {
        return html`
          <select @change=${this._onChange}>
            ${this.locale.availableLocales.map(
              (loc) => html`
                <option value=${loc} ?selected=${loc === this.locale.locale}>
                  ${getLocaleName(loc)}
                </option>
              `
            )}
          </select>
        `;
      }
    }
    

11. 11

    Переключение атрибутов языка и направления текста в HTML

    Необязательно

    Обновляйте атрибуты lang и dir тега <html> в соответствии с текущим языком для обеспечения доступности и SEO.

    src/my-element.ts

    Копировать содержимое

    Копировать код

    Копировать код в буфер обмена

    import { LitElement, html } from "lit";
    import { customElement } from "lit/decorators.js";
    import { getHTMLTextDir } from "intlayer";
    import { useLocale } from "lit-intlayer";
    
    @customElement("my-element")
    export class MyElement extends LitElement {
      private locale = useLocale(this, {
        onLocaleChange: (loc) => {
          document.documentElement.lang = loc;
          document.documentElement.dir = getHTMLTextDir(loc);
        },
      });
    
      override render() {
        return html`<!-- ваш контент -->`;
      }
    }
    

12. 12

    Извлечение контента из ваших компонентов

    Необязательно

    Если у вас есть существующая кодовая база, преобразование тысяч файлов может занять много времени.

    Чтобы облегчить этот процесс, Intlayer предлагает компилятор / экстрактор для преобразования ваших компонентов и извлечения контента.

    Чтобы настроить его, вы можете добавить раздел compiler в файл intlayer.config.ts:

    intlayer.config.ts

    Копировать содержимое

    Копировать код

    Копировать код в буфер обмена

    import { type IntlayerConfig } from "intlayer";
    
    const config: IntlayerConfig = {
      // ... Остальная часть вашей конфигурации
      compiler: {
        /**
         * Указывает, должен ли быть включен компилятор.
         */
        enabled: true,
    
        /**
         * Определяет путь к выходным файлам
         */
        output: ({ fileName, extension }) => `./${fileName}${extension}`,
    
        /**
         * Указывает, должны ли компоненты сохраняться после преобразования.
         * Таким образом, компилятор можно запустить только один раз для преобразования приложения, а затем удалить.
         */
        saveComponents: false,
    
        /**
         * Префикс ключа словаря
         */
        dictionaryKeyPrefix: "",
      },
    };
    
    export default config;
    

(Опционально) Sitemap и robots.txt (генерация на сборке)

Intlayer предоставляет generateSitemap и getMultilingualUrls - утилиты, которые формируют многоязычные sitemap.xml и robots.txt для краулеров и позволяют автоматически записать их в public/. Обычно запускают небольшой Node-скрипт до Vite (например, npm-хуки predev / prebuild).

Sitemap

Генератор sitemap учитывает локали и добавляет нужные метаданные.

Поддерживается пространство имён xhtml:link (hreflang). Вместо плоского списка URL Intlayer связывает все языковые версии страницы в обе стороны (например /about, /fr/about или /about?lang=fr в зависимости от режима маршрутизации).

Robots.txt

Используйте getMultilingualUrls, чтобы правила Disallow покрывали все локализованные варианты путей.

1. Файл generate-seo.mjs в корне проекта

import fs from "fs";
import path from "path";
import { fileURLToPath } from "url";
import { generateSitemap, getMultilingualUrls } from "intlayer";

const __dirname = path.dirname(fileURLToPath(import.meta.url));

const SITE_URL = (process.env.SITE_URL || "http://localhost:5173").replace(
  /\/$/,
  ""
);

const pathList = [
  { path: "/", changefreq: "daily", priority: 1.0 },
  { path: "/about", changefreq: "monthly", priority: 0.7 },
];

const sitemapXml = generateSitemap(pathList, { siteUrl: SITE_URL });
fs.writeFileSync(path.join(__dirname, "public", "sitemap.xml"), sitemapXml);

const getAllMultilingualUrls = (urls) =>
  urls.flatMap((url) => Object.values(getMultilingualUrls(url)));

const disallowedPaths = getAllMultilingualUrls(["/admin", "/private"]);

const robotsTxt = [
  "User-agent: *",
  "Allow: /",
  ...disallowedPaths.map((path) => `Disallow: ${path}`),
  "",
  `Sitemap: ${SITE_URL}/sitemap.xml`,
].join("\n");

fs.writeFileSync(path.join(__dirname, "public", "robots.txt"), robotsTxt);

console.log("SEO files generated successfully.");

Пакет intlayer должен быть установлен. Для продакшена задайте SITE_URL в окружении (например в CI).

Для Node ESM предпочтительно generate-seo.mjs. Для generate-seo.js укажите "type": "module" в package.json или включите ESM иначе.

2. Запуск скрипта до Vite

{
  "scripts": {
    "dev": "vite",
    "prebuild": "node generate-seo.mjs",
    "build": "vite build",
    "preview": "vite preview"
  }
}

Подстройте команды для pnpm или yarn. Скрипт можно вызывать из CI или другого шага.

Настройка TypeScript

Убедитесь, что ваша конфигурация TypeScript включает автогенерируемые типы.

{
  "compilerOptions": {
    // ...
    "experimentalDecorators": true,
    "useDefineForClassFields": false,
  },
  "include": ["src", ".intlayer/**/*.ts"],
}

experimentalDecorators и useDefineForClassFields: false требуются Lit для поддержки декораторов.

Конфигурация Git

Рекомендуется игнорировать файлы, генерируемые Intlayer. Это позволит избежать их фиксации в вашем Git-репозитории.

Для этого вы можете добавить следующие инструкции в файл .gitignore:

# Игнорировать файлы, генерируемые Intlayer
.intlayer

Расширение для VS Code

Чтобы улучшить процесс разработки с Intlayer, вы можете установить официальное расширение Intlayer для VS Code.

Установить из VS Code Marketplace

Это расширение предоставляет:

• Автодополнение ключей перевода.
• Обнаружение ошибок в реальном времени для отсутствующих переводов.
• Встроенные превью переведенного контента.
• Быстрые действия для легкого создания и обновления переводов.

Подробнее о том, как использовать расширение, см. в документации расширения Intlayer для VS Code.

Идти дальше

Чтобы пойти дальше, вы можете внедрить визуальный редактор или вынести ваш контент во внешнюю систему с помощью CMS.

Часто задаваемые вопросы