JSONC - Lingo.dev CLI

JSONCとは何か？

JSONC（JSONコメント付き）はJSONの拡張で、一行コメントと複数行コメントを許可します。人間が読めるアノテーションが役立つ設定ファイルでよく使用されます。

例えば：

{
  "key1": "Hello, world!", // key1に対するコメント
  "key2": "A simple demo app with JSONC features" /* key2に対するコメント */,
  // key3に対するコメント
  "key3": "1.0.0",
  // ネストされた値に対するコメント
  "key6": {
    "key7": "Nested value",
  },
  // このキーはロックされており変更すべきではありません
  "locked_key_1": "This value is locked and should not be changed",
}

Lingo.dev CLIとは何か？

Lingo.dev CLIは、AIでアプリやコンテンツを翻訳するための無料のオープンソースCLIです。従来の翻訳管理ソフトウェアに代わるものとして設計されており、既存のパイプラインと統合できます。

詳細については、概要をご覧ください。

このガイドについて

このガイドでは、Lingo.dev CLIを使用してJSONCファイルを翻訳する方法を説明します。

以下の方法を学びます：

ゼロからプロジェクトを作成する
翻訳パイプラインを設定する
AIで翻訳を生成する

前提条件

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. ソースロケールを設定する

_ソースロケール_は、コンテンツが最初に書かれた元の言語と地域です。ソースロケールを設定するには、i18n.jsonファイル内のlocale.sourceプロパティを設定します：

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

ソースロケールはBCP 47言語タグとして提供する必要があります。

Lingo.dev CLIがサポートするロケールコードの完全なリストについては、サポートされているロケールコードを参照してください。

ステップ 3. ターゲットロケールを設定する

_ターゲットロケール_は、コンテンツを翻訳したい言語と地域です。ターゲットロケールを設定するには、i18n.jsonファイル内のlocale.targetsプロパティを設定します：

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

ステップ 4. ソースコンテンツを作成する

まだ作成していない場合は、翻訳するコンテンツを含む1つ以上のJSONCファイルを作成します。これらのファイルは、パスのどこかにソースロケールを含むパスに配置する必要があります（例：ディレクトリ名としてen/や、ファイル名の一部としてmessages.en.jsoncなど）。

ステップ 5. バケットを作成する

i18n.jsonファイル内のbucketsオブジェクトに"jsonc"オブジェクトを追加します：

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

"jsonc"オブジェクト内で、1つ以上の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）を使用してAIでコンテンツを翻訳します。これらのモデルを使用するには、サポートされているプロバイダーからAPIキーが必要です。

可能な限り迅速に開始するために、毎月10,000トークンの無料使用量を提供する当社独自のホスト型プラットフォームLingo.dev Engineの使用をお勧めします：

Lingo.devアカウントにサインアップする。
次のコマンドを実行します：
```
npx lingo.dev@latest login
```
これによりデフォルトのブラウザが開き、認証を求められます。
画面の指示に従ってください。

ステップ 7. 翻訳を生成する

i18n.jsonファイルを含むディレクトリで、次のコマンドを実行します：

npx lingo.dev@latest run

このコマンドは以下を実行します：

i18n.jsonファイルを読み込みます。
翻訳が必要なファイルを見つけます。
ファイルから翻訳可能なコンテンツを抽出します。
設定されたLLMを使用して抽出されたコンテンツを翻訳します。
翻訳されたコンテンツをファイルシステムに書き込みます。

翻訳が初めて生成されるとき、i18n.lockファイルが作成されます。このファイルは、どのコンテンツが翻訳されたかを追跡し、後続の実行で不要な再翻訳を防ぎます。

例

en/example.jsonc

{
  "key1": "Hello, world!", // This is a comment for key1
  "key2": "A simple demo app with JSONC features" /* This is a comment for key2 */,
  // This is a comment for key3
  "key3": "1.0.0",
  /* This is a block comment for key4 */
  "key4": "[email protected]",
  /*
   This is a comment for key5
  */
  "key5": "🚀",
  // This is a comment for key6
  "key6": {
    // This is a comment for key7
    "key7": "Nested value",
  },
  // This key is locked and should not be changed
  "locked_key_1": "This value is locked and should not be changed",
  // This key is ignored and should be removed from target locales
  "ignored_key_1": "This value is ignored and should not appear in target locales",
}

es/example.jsonc

{
  "key1": "¡Hola, mundo!", // This is a comment for key1
  "key2": "Una aplicación de demostración simple con características JSONC" /* This is a comment for key2 */,
  // This is a comment for key3
  "key3": "1.0.0",
  /* This is a block comment for key4 */
  "key4": "[email protected]",
  /*
   This is a comment for key5
  */
  "key5": "🚀",
  // This is a comment for key6
  "key6": {
    // This is a comment for key7
    "key7": "Valor anidado",
  },
  // This key is locked and should not be changed
  "locked_key_1": "This value is locked and should not be changed",
}

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