JSONC - Lingo.dev CLI

Что такое JSONC?

JSONC (JSON с комментариями) — это расширение JSON, которое позволяет использовать однострочные и многострочные комментарии. Оно часто используется в конфигурационных файлах, где полезны читаемые аннотации.

Например:

{
  "key1": "Привет, мир!", // Это комментарий для key1
  "key2": "Простое демонстрационное приложение с функциями JSONC" /* Это комментарий для key2 */,
  // Это комментарий для key3
  "key3": "1.0.0",
  // Это комментарий для вложенных значений
  "key6": {
    "key7": "Вложенное значение",
  },
  // Этот ключ заблокирован и не должен изменяться
  "locked_key_1": "Это значение заблокировано и не должно изменяться",
}

Что такое Lingo.dev CLI?

Lingo.dev CLI — это бесплатный инструмент с открытым исходным кодом для перевода приложений и контента с помощью ИИ. Он разработан для замены традиционного программного обеспечения для управления переводами, интегрируясь с существующими конвейерами.

Чтобы узнать больше, см. Обзор.

О данном руководстве

Это руководство объясняет, как переводить файлы JSONC с помощью Lingo.dev CLI.

Вы узнаете, как:

Создать проект с нуля
Настроить конвейер перевода
Генерировать переводы с помощью ИИ

Предварительные требования

Для использования Lingo.dev CLI убедитесь, что установлена версия Node.js v18+:

❯ node -v
v22.17.0

Шаг 1. Настройка проекта

В каталоге вашего проекта создайте файл i18n.json:

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {}
}

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

Чтобы узнать больше о доступных свойствах, см. i18n.json.

Шаг 2. Настройте исходную локаль

Исходная локаль — это оригинальный язык и регион, на которых был написан ваш контент. Чтобы настроить исходную локаль, установите свойство locale.source в файле i18n.json:

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {}
}

Исходная локаль должна быть указана в виде языкового тега BCP 47.

Для полного списка кодов локалей, поддерживаемых Lingo.dev CLI, смотрите Поддерживаемые коды локалей.

Шаг 3. Настройте целевые локали

Целевые локали — это языки и регионы, на которые вы хотите перевести ваш контент. Чтобы настроить целевые локали, установите свойство locale.targets в файле i18n.json:

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {}
}

Шаг 4. Создайте исходный контент

Если вы еще этого не сделали, создайте один или несколько файлов JSONC, содержащих контент для перевода. Эти файлы должны находиться в пути, который включает исходную локаль (например, в имени директории, как en/, или в имени файла, как messages.en.jsonc).

Шаг 5. Создайте bucket

В файле i18n.json добавьте объект "jsonc" в объект buckets:

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {
    "jsonc": {}
  }
}

В объекте "jsonc" определите массив с одним или несколькими шаблонами include:
```
{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {
    "jsonc": {
      "include": ["./[locale]/example.jsonc"]
    }
  }
}
```
Эти шаблоны определяют, какие файлы нужно перевести.

Сами шаблоны:
- должны содержать [locale] как заполнитель для настроенной локали
- могут указывать на пути к файлам (например, "[locale]/config.jsonc")
- могут использовать звездочки в качестве подстановочных символов (например, "[locale]/*.jsonc")
Рекурсивные шаблоны (например, **/*.jsonc) не поддерживаются.

Шаг 6. Настройка LLM

Lingo.dev CLI использует большие языковые модели (LLM) для перевода контента с помощью ИИ. Чтобы использовать одну из этих моделей, вам нужен API-ключ от поддерживаемого провайдера.

Чтобы начать как можно быстрее, мы рекомендуем использовать Lingo.dev Engine — нашу собственную платформу, которая предоставляет 10 000 токенов бесплатного ежемесячного использования:

Зарегистрируйтесь в Lingo.dev.
Выполните следующую команду:
```
npx lingo.dev@latest login
```
Эта команда откроет ваш браузер по умолчанию и запросит аутентификацию.
Следуйте инструкциям.

Шаг 7. Генерация переводов

В каталоге, содержащем файл i18n.json, выполните следующую команду:

npx lingo.dev@latest run

Эта команда:

Считывает файл i18n.json.
Находит файлы, которые нужно перевести.
Извлекает переводимый контент из файлов.
Использует настроенный LLM для перевода извлеченного контента.
Записывает переведенный контент обратно в файловую систему.

При первом создании переводов создается файл i18n.lock. Этот файл отслеживает, какой контент был переведен, предотвращая ненужные повторные переводы при последующих запусках.

Пример

en/example.jsonc

{
  "key1": "Привет, мир!", // Это комментарий для key1
  "key2": "Простое демонстрационное приложение с функциями JSONC" /* Это комментарий для key2 */,
  // Это комментарий для key3
  "key3": "1.0.0",
  /* Это блочный комментарий для key4 */
  "key4": "[email protected]",
  /*
   Это комментарий для key5
  */
  "key5": "🚀",
  // Это комментарий для key6
  "key6": {
    // Это комментарий для key7
    "key7": "Вложенное значение",
  },
  // Этот ключ заблокирован и не должен изменяться
  "locked_key_1": "Это значение заблокировано и не должно изменяться",
  // Этот ключ игнорируется и должен быть удален из целевых локалей
  "ignored_key_1": "Это значение игнорируется и не должно появляться в целевых локалях",
}

es/example.jsonc

{
  "key1": "¡Hola, mundo!", // Это комментарий для key1
  "key2": "Простое демонстрационное приложение с функциями JSONC" /* Это комментарий для key2 */,
  // Это комментарий для key3
  "key3": "1.0.0",
  /* Это блочный комментарий для key4 */
  "key4": "[email protected]",
  /*
   Это комментарий для key5
  */
  "key5": "🚀",
  // Это комментарий для key6
  "key6": {
    // Это комментарий для key7
    "key7": "Вложенное значение",
  },
  // Этот ключ заблокирован и не должен изменяться
  "locked_key_1": "Это значение заблокировано и не должно изменяться",
}

i18n.json

{
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {
    "jsonc": {
      "include": ["./[locale]/example.jsonc"]
    }
  },
  "$schema": "https://lingo.dev/schema/i18n.json"
}

i18n.lock

version: 1
checksums:
  455da9346f4e772000927cd2ff5bb898:
    title: 0468579ef2fbc83c9d520c2f2f1c5059
    description: 6f4922f45568161a8cdf4ad2299f6d23
    version: 54a9e730e88fb16291b852274d433923
    support_email: 10627fcc465897af0f5e1bba042685f9
    emoji: b328c432cee108a87a92f05258b6a651
    author/name: febee8e9ab40b2fe5106d72675228d00
    contributors/0/name: e80d4063a32adaad7b0a82b0bcc10551
    contributors/1/name: b2bca2fa3c890618e56d07473f26ead3
    messages/0: d1c3a9f35e377554a4ccaa467ca26614
    messages/1: 0468579ef2fbc83c9d520c2f2f1c5059
    config/theme/primary: 7535a3779d6934ea8ecf18f5cb5b93fd
    mixed_array/0: 001b5b003d96c133534f5907abffdf77
    mixed_array/3/nested_message: 5f0782dfc5993e99890c0475bc295a30