i18n extract

i18n-extract

静的分析でローカリゼーションを管理します。

インストール

npm install --save-dev i18n-extract

問題は解決しました

このモジュールは、次のために、 i18n.t('some.key')などの主要な使用法についてコードを静的に分析します。

• 欠落しているキーをレポートします
• 未使用のキーをレポートします。
• 非常に複製されたキーをレポートします。

たとえば、このモジュールは以下と組み合わせてうまく機能します。

• polyglot.js（ marker: 'polyglot.t', ）
• Webpackと彼のローカリゼーションプラグイン：i18n-webpack-plugin（ marker: 'i18n', ）

サポートされているキー

• 静的：

 i18n ( 'key.static' )

• 文字列連結：

 i18n ( 'key.' + 'concat' )

• テンプレート文字列：

 i18n ( `key.template` )

• 動的：

 i18n ( `key. ${ dynamic } ` )

• コメント：

 /* i18n-extract key.comment */ 

API

extractfromcode（code、[options]）

codeを解析して、i18n（ key ）の呼び出しの引数を抽出します。

• code文字列である必要があります。
• 使用するキーを含む配列を返します。

例

 import { extractFromCode } from 'i18n-extract' ;
const keys = extractFromCode ( "const followMe = i18n('b2b.follow');" , {
  marker : 'i18n' ,
} ) ;
// keys = ['b2b.follow']

extractfromfiles（ファイル、[オプション]）

filesを解析して、i18n（ key ）の呼び出しの引数を抽出します。

• files 、文字列または文字列の配列のいずれかです。グローブを使用することもできます。
• ソースコードで使用されるキーを含む配列を返します。

例

 import { extractFromFiles } from 'i18n-extract' ;
const keys = extractFromFiles ( [
  '*.jsx' ,
  '*.js' ,
] , {
  marker : 'i18n' ,
} ) ;

オプション

• marker ：国際化された文字列マーカー関数の名前。デフォルトはi18nです。
• keyLoc ：引数のキーの位置を示す整数。デフォルトは0です。マイナス数、例えば-1は、引数リストの終了に対する位置を示します。
• parser ：使用するパーサーを示し、 typescriptまたはflowすることができます。デフォルトはflowになります。
• babelOptions ：I18Nキーをスキャンする前に、カスタム変換またはプラグインを適用できるBABEL構成オブジェクト。デフォルトは、すべてのバビロンプラグインを有効にした構成になります。

FindMissing（Locale、Keysused）

欠落しているキーを報告します。これらのキーはおそらく翻訳する必要があります。

• locale 、翻訳を含むオブジェクトである必要があります。
• keysUsed配列である必要があります。ソースコードで使用されるキーを含む。 extractFromCodeからextractFromFilesて取得できます。
• レポートを返します。

例

 import { findMissing } from 'i18n-extract' ;
const missing = findMissing ( {
  key1 : 'key 1' ,
} , [ 'key1' , 'key2' ] ) ;

/**
 * missing = [{
 *   type: 'MISSING',
 *   key: 'key2',
 * }];
 */ 

プラグイン

FindUnused（Locale、Keysused）

未使用のキーを報告します。これらのキーはおそらく削除する必要があります。

• locale 、翻訳を含むオブジェクトである必要があります。
• keysUsed配列である必要があります。ソースコードで使用されるキーを含む。 extractFromCodeからextractFromFilesて取得できます。
• レポートを返します。

例

 import { findUnused } from 'i18n-extract' ;
const unused = findUnused ( {
  key1 : 'key 1' ,
  key2 : 'key 2' ,
} , [ 'key1' ] ) ;

/**
 * unused = [{
 *   type: 'UNUSED',
 *   key: 'key2',
 * }];
 */

findduplicated（locale、keysused、options）

複製されたキーを報告します。これらのキーはおそらく相互化されるべきです。デフォルトのthresholdは1で、重複した翻訳を報告します。

• locale 、翻訳を含むオブジェクトである必要があります。
• keysUsed配列である必要があります。ソースコードで使用されるキーを含む。 extractFromCodeからextractFromFilesて取得できます。
• optionsオブジェクトである必要があります。レポートに追加される前に、重複した値の数を変更するためのthresholdプロパティを提供できます。
• レポートを返します。

例

 import { findDuplicated } from 'i18n-extract' ;
const duplicated = findDuplicated ( {
  key1 : 'Key 1' ,
  key2 : 'Key 2' ,
  key3 : 'Key 2' ,
} ) ;

/**
 * unused = [{
 *   type: 'DUPLICATED',
 *   keys: [
 *     'key2',
 *     'key3',
 *   ],
 *   value: 'Key 2',
 * }];
 */

Forbiddynamic（Locale、Keysused）

動的キーを報告します。動的キーを使用することは間違いなく危険です。彼らは壊れるかもしれません。

• locale 、翻訳を含むオブジェクトである必要があります。
• keysUsed配列である必要があります。ソースコードで使用されるキーを含む。 extractFromCodeからextractFromFilesて取得できます。
• レポートを返します。

例

 import { forbidDynamic } from 'i18n-extract' ;
const forbidDynamic = forbidDynamic ( { } , [ 'key.*' ] ) ;

/**
 * forbidDynamic = [{
 *   type: 'FORBID_DYNAMIC',
 *   key: 'key.*',
 * }];
 */

フラットン（オブジェクト）

オブジェクトを平らにします。

• objectオブジェクトである必要があります。

例

 import { flatten } from 'i18n-extract' ;
const flattened = flatten ( {
  key2 : 'Key 2' ,
  key4 : {
    key41 : 'Key 4.1' ,
    key42 : {
      key421 : 'Key 4.2.1' ,
    } ,
  } ,
} ) ;

/**
 * flattened = {
 *   key2: 'Key 2',
 *   'key4.key41': 'Key 4.1',
 *   'key4.key42.key421': 'Key 4.2.1',
 * };
 */

mergemessageswithpo（メッセージ、ポインプ、ポートプット）

messagesに存在するメッセージのみを含む新しいPOファイルを出力します。 poInputにメッセージが既に存在する場合、翻訳を保持します。メッセージが存在しない場合は、新しい空の翻訳を追加します。

• messages配列でなければなりません。
• poInput文字列でなければなりません。
• poOutput文字列でなければなりません。

例

 import { mergeMessagesWithPO } from 'i18n-extract' ;

const messages = [ 'Message 1' , 'Message 2' ] ;
mergeMessagesWithPO ( messages , 'messages.po' , 'messages.output.po' ) ;

/**
 * Will output :
 * > messages.output.po has 812 messages.
 * > We have added 7 messages.
 * > We have removed 3 messages.
 */ 

ライセンス

mit