Intlayer CLI

パッケージのインストール

必要なパッケージをnpmを使用してインストールします:

npm install intlayer-cli

もしintlayerパッケージが既にインストールされている場合、cliは自動的にインストールされます。このステップはスキップできます。

intlayer-cliパッケージ

intlayer-cliパッケージは、あなたのインテレーション宣言を辞書に変換することを目的としています。

このパッケージは、src/**/*.content.{ts|js|mjs|cjs|json}などのすべてのintlayerファイルを変換します。Intlayer宣言ファイルの宣言方法はこちらを参照してください。

intlayer辞書を解釈するために、react-intlayerやnext-intlayerなどのインタプリタを使用できます。

設定ファイルのサポート

Intlayerは複数の設定ファイルフォーマットを受け入れます:

• intlayer.config.ts
• intlayer.config.js
• intlayer.config.json
• intlayer.config.cjs
• intlayer.config.mjs
• .intlayerrc

利用可能なロケールや他のパラメータの設定方法については、こちらの設定ドキュメントを参照してください。

intlayerコマンドの実行

辞書のビルド

辞書をビルドするには、次のコマンドを実行できます:

npx intlayer build

またはウォッチモードで

npx intlayer build --watch

このコマンドは、デフォルトで./src/**/*.content.{ts|js|mjs|cjs|json|tsx|jsx}として宣言コンテンツファイルを見つけ、.intlayerディレクトリに辞書をビルドします。

辞書のプッシュ

npx intlayer dictionary push

もしインテレーションエディタがインストールされている場合、辞書をエディタにプッシュすることもできます。このコマンドを使用することで、辞書を編集者に利用可能にし、チームと辞書を共有し、アプリケーションのコードを編集せずにコンテンツを編集できます。

引数:

• -d, --dictionaries: プルする辞書のID。指定しない場合、すべての辞書がプッシュされます。 > 例: npx intlayer dictionary push -d my-dictionary-id my-other-dictionary-id
• -r, --deleteLocaleDictionary: 辞書がプッシュされた後にロケールディレクトリを削除するかどうかの質問をスキップし、削除します。デフォルトでは、辞書がローカルに定義されている場合、遠隔辞書の内容が上書きされます。 > 例: npx intlayer dictionary push -r
• -k, --keepLocaleDictionary: 辞書がプッシュされた後にロケールディレクトリを削除するかどうかの質問をスキップし、保持します。デフォルトでは、辞書がローカルに定義されている場合、遠隔辞書の内容が上書きされます。 > 例: npx intlayer dictionary push -k

遠隔辞書をプル

npx intlayer dictionary pull

もしインテレーションエディタがインストールされている場合、エディタから辞書をプルすることもできます。これにより、アプリケーションの需要に応じて辞書の内容を上書きできます。

引数:

• -d, --dictionaries: プルする辞書のID。指定しない場合、すべての辞書がプルされます。 > 例: npx intlayer dictionary pull -d my-dictionary-id my-other-dictionary-id
• --newDictionariesPath: 新しい辞書を保存するディレクトリのパス。指定しない場合、新しい辞書はプロジェクトの./intlayer-dictionariesディレクトリに保存されます。辞書コンテンツ内にfilePathフィールドが指定されている場合、辞書はこの引数を考慮せず、指定されたfilePathディレクトリに保存されます。

例:

npx intlayer dictionary pull --newDictionariesPath ./my-dictionaries-dir/

辞書の監査

npx intlayer audit

このコマンドは、見つかった欠落翻訳、構造的矛盾、または型の不一致などの潜在的な問題に対してコンテンツ宣言ファイルを分析します。問題が見つかった場合、intlayer auditは辞書を一貫性があり完全に保つための更新を提案または適用します。

引数:

• -f, --files [files...]
  監査する特定のコンテンツ宣言ファイルのリスト。指定しない場合、発見されたすべての*.content.{ts,js,mjs,cjs,tsx,jsx,json}ファイルが監査されます。

• --exclude [excludedGlobs...]
  監査から除外するためのグロブパターン（例: --exclude "src/test/**"）。

• -m, --model [model]
  監査に使用するChatGPTモデル（例: gpt-3.5-turbo）。

• -p, --custom-prompt [prompt]
  監査指示のカスタムプロンプトを提供します。

• -l, --async-limit [asyncLimit]
  同時に処理する最大ファイル数。

• -k, --open-ai-api-key [openAiApiKey]
  OAuth2認証を回避するために独自のOpenAI APIキーを提供します。

例:

npx intlayer audit --exclude "tests/**" --model gpt-3.5-turbo

このコマンドは、tests/**の下のファイルを無視し、発見されたコンテンツ宣言ファイルを監査するためにgpt-3.5-turboモデルを使用します。問題が見つかった場合（欠落翻訳など）、元のファイル構造を保持しながら、その場で修正されます。

package.jsonでintlayerコマンドを使用する

"scripts": {  "intlayer:build": "npx intlayer build",  "intlayer:watch": "npx intlayer build --watch",  "intlayer:push": "npx intlayer dictionary push",  "intlayer:pull": "npx intlayer dictionary pull",  "intlayer:audit": "npx intlayer audit"}