CLI設定ファイル（Strings）の作成

本コンテンツはPhrase Language AIの機械翻訳により、英語から翻訳されています。

前提条件

APIアクセストークン（読み取り/書き込みスコープ付き）
プロジェクト設定のAPIタブに表示されるStringsプロジェクトID
インデントを含む基本的なYAMLの知識
リポジトリでCIにおいてphrase pushまたはphrase pullを実行する場合のGitの読み取りおよび書き込み権限

ヒント

詳細については、Developer Hubを参照してください。

コンフィギュレーションファイルを自動作成する手順は、次のとおりです。

コマンドラインから、phrase initを入力して.phrase.ymlファイルを作成します。

設定ウィザードがCLIで開始されます。
提供：
- アクセストークン
  
  貼り付けるか、Enterを押して$PHRASE_ACCESS_TOKENを使用できるようにします
- StringsプロジェクトID（例: abcdef1234567890abcdef1234567890）
- ロケールファイル形式（例: json, rails_yaml, ios_strings）
- ローカルパス
  
  プロジェクトコードベース内のロケールファイルへのGlobまたは正確なパス（例: config/locales/*.json）

基本的な.phrase.ymlファイルが現在のディレクトリに作成されます。

ヒント

ウィザードを完全にスキップするにはフラグを指定します。例: phrase init --access_token=$PHRASE_ACCESS_TOKEN --project_id=... --file_format=ios_strings --path='ios/*.strings'。

手動で作成またはコピーした設定ファイルを使用する場合は、次のいずれかの場所に格納します。

CLIクライアントが呼び出される現在の作業ディレクトリ（pwd）。
現在のユーザーのホームディレクトリ（Unix の場合は $HOME、Windows の場合は $HomePath）。
PHRASEAPP_CONFIG環境変数で指定されたパス。
--configフラッグ経由の設定ファイルのパス（例：/some/path/to/phrase.yml）。

CLIオプションの概要

設定ファイルのサンプル。

グローバル設定

キー	種類	必須	項目
`phrase.access_token`	文字列	はい	個人用アクセストークン。
`phrase.project_id`	文字列	はい	Stringsプロジェクト設定に表示される公開プロジェクトID。
`phrase.file_format`	文字列	はい	デフォルトのロケールファイル形式 (API拡張機能)。
`phrase.locale_mapping`	object	いいえ	`<locale_name>` プレースホルダーを使用してファイルパスで使用するために、PhraseロケールIDをカスタム名にマッピングします。これは、Androidのような標準的でない命名規則を持つプラットフォームで便利です。マッピングでロケールが指定されていない場合、デフォルトで標準のPhraseロケール名が使用されます。

プッシュ: 原文

キー	種類	必須	項目
`push.sources[].file`	パス	はい	プッシュするファイルへの相対パス (例: `./path/to/file/<locale_code>.json`)。Supports `<locale_name>`, `<locale_code>`, `<tags>`.
`push.sources[].project_id`	文字列		この特定のファイル原文に対して、グローバルな `プロジェクトID` を上書きします。同じ設定ファイルから複数のPhraseプロジェクトにファイルをプッシュする場合に便利です。

プッシュ: パラメータ

パラメータ	種類	デフォルト	項目
`file_format`	文字列	ヘッダー	この原文のファイル形式を上書きします。
`locale_id`	文字列	—	ロケール名 (例: `en-US`) または公開ロケールID。
`tags`	文字列	—	新しいキーのカンマ区切りのタグ。
`update_translations`	ブール	`false`	ファイルコンテンツで既存の翻訳を更新します。
`update_translation_keys`	ブール	`true`	新しいキーの作成や既存のキーの更新を防ぐには、ここに `false` を渡します。
`update_descriptions`	ブール	`false`	キーの説明を更新します。空欄の説明は既存の説明を上書きします。
`skip_upload_tags`	ブール	`false`	アップロードタグは作成されません。
`skip_unverification`	ブール	`false`	更新された翻訳は未検証になりません。
`file_encoding`	文字列	—	ファイルエンコーディング: `UTF-8`、`UTF-16`、`UTF-16BE`、`UTF-16LE`、または`ISO-8859-1`。
`locale_mapping`	object	—	（Excel/CSVのみ）翻訳を解析するために、ロケールコードを列名にマッピングします（例: `{"en": "C", "de": "D"}`）。これは、ファイルパスに使用される最上位の`locale_mapping`とは異なります。
`autotranslate`	ブール	`false`	アップロードされた言語の翻訳を自動取得します。
`mark_reviewed`	ブール	`false`	インポートされた翻訳をレビュー済としてマークします（高度なレビューワークフローが有効である必要があります）。

プッシュ: ファイル形式オプション

利用可能なすべてのファイル形式オプションは、CLI設定でサポートされています。例については、サンプル設定ファイルを参照してください。

プル: 訳文

キー	種類	必須	項目
`pull.targets[].file`	パス	はい	プルされたロケールファイルの相対パス（例: `./Radio.de/<locale_code>.lproj/Localizable.strings`）。
`pull.targets[].project_id`	文字列		この特定のプル対象について、グローバルな`プロジェクトID`を上書きします。同じ設定ファイルを使用して、複数のPhraseプロジェクトから翻訳をプルすることを有効にします。

プル: パラメータ

パラメータ	種類	デフォルト	項目
`file_format`	文字列	—	`Strings`である必要があります。
`locale_id`	文字列	—	ロケール名 (例: `en-US`) または公開ロケールID。
`tags`	文字列	—	プルするキーをフィルタリングするための、カンマ区切りのタグ。
`include_empty_translations`	ブール	`false`	翻訳がないキーを含めます。
`exclude_empty_zero_forms`	ブール	`false`	空欄の場合、ゼロ形式の複数形を除外します。
`include_translated_keys`	ブール	`true`	すでに翻訳済みのキーを含めます。
`keep_notranslate_tags`	ブール	`false`	出力内の `[NOTRANSLATE]` タグを保持します。
`encoding`	文字列	—	ファイルエンコーディング: `UTF-8`、`UTF-16`、`UTF-16BE`、`UTF-16LE`、または`ISO-8859-1`。
`include_unverified_translations`	ブール	`true`	`false` の場合、未検証の翻訳を除外します。
`use_last_reviewed_version`	ブール	`false`	`true` の場合、最後にレビュー済のバージョンを使用します（高度なレビューワークフローが必要です）。
`fallback_locale_id`	文字列	—	翻訳が見つからない場合に使用するフォールバックロケール。

プル: フォーマットオプション

利用可能なすべてのファイル形式オプションは、CLI設定でサポートされています。例については、サンプル設定ファイルを参照してください。

複数の構成

モノレポの場合、各パッケージに構成ファイルを1つずつ配置して対応するサブフォルダからCLIを実行するか、--config オプションを使用してCIジョブを異なる構成ファイルに向けます。

Git統合機能

GitLab:

.phrase.yml設定ファイルがリポジトリ内にある必要があります。ファイルは、リポジトリからインポート（pull）またはエクスポート（push）するファイルを定義します。
リポジトリには読み取りおよび書き込みアクセスが必要です。
設定ファイルの定義が正しくない場合、エラーが発生する可能性があります。ファイルに少なくとも1つのpushとpull訳文、正しいファイル形式、およびupdate_translationsパラメータの設定があることを確認してください。
API 互換性を確保するには、GitLab 9.5 以降を使用してください。

GitHub:

.phrase.yml設定ファイルがリポジトリ内にある必要があります。ファイルは、リポジトリからインポート（pull）またはエクスポート（push）するファイルを定義します。
リポジトリには読み取りおよび書き込みアクセスが必要です。
設定ファイルの定義が正しくない場合、エラーが発生する可能性があります。ファイルに少なくとも1つのpushとpull訳文、正しいファイル形式、およびupdate_translationsパラメータの設定があることを確認してください。
リポジトリスコープの GitHub アクセストークン (パブリックリポジトリと同期する場合は public_repo)。
GitHub で SSO が有効になっている場合は、アクセストークンも有効にする必要があります。
phrase_translations ブランチは保護できません。
リポジトリ設定で署名付きコミットが不要であることを確認してください。

BitBucket:

.phrase.yml設定ファイルがリポジトリ内にある必要があります。ファイルは、リポジトリからインポート（pull）またはエクスポート（push）するファイルを定義します。
リポジトリには読み取りおよび書き込みアクセスが必要です。
設定ファイルの定義が正しくない場合、エラーが発生する可能性があります。ファイルに少なくとも1つのpushとpull訳文、正しいファイル形式、およびupdate_translationsパラメータの設定があることを確認してください。

phrase.yml.sample
(3 KB)