i18n extract

i18n-extract

إدارة التوطين مع التحليل الثابت.

تثبيت

npm install --save-dev i18n-extract

تم حل المشكلة

تحلل هذه الوحدة الكود بشكل ثابت للاستخدامات الرئيسية ، مثل i18n.t('some.key') ، من أجل:

• الإبلاغ عن مفاتيح مفقودة
• الإبلاغ عن مفاتيح غير مستخدمة.
• مفاتيح الإبلاغ التي يتم تكرارها للغاية.

على سبيل المثال ، تعمل هذه الوحدة بشكل جيد مع:

• polyglot.js ( marker: 'polyglot.t', )
• Webpack و Plugin الخاص به: I18N-Webpack-Plugin ( marker: 'i18n', )

مفاتيح مدعومة

• ثابت:

 i18n ( 'key.static' )

• سلسلة سلسلة:

 i18n ( 'key.' + 'concat' )

• سلسلة القالب:

 i18n ( `key.template` )

• متحرك:

 i18n ( `key. ${ dynamic } ` )

• تعليق:

 /* i18n-extract key.comment */ 

API

extractfromcode (رمز ، [خيارات])

تحليل 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 : enum تشير إلى أن المحلل الذي يجب استخدامه ، يمكن أن يكون typescript أو flow . الافتراضات flow .
• babelOptions : كائن تكوين بابل للسماح بتطبيق التحولات المخصصة أو المكونات الإضافية قبل المسح الضوئي لمفاتيح I18N. الإعدادات الافتراضية لتكوين مع جميع الإضافات بابل ممكّنة.

FindMissing (لغة ، Keysused)

الإبلاغ عن المفاتيح المفقودة. من المحتمل أن تترجم تلك المفاتيح.

• يجب أن يكون locale كائنًا يحتوي على الترجمات.
• يجب أن تكون keysUsed صفيف. يحتوي على المفاتيح المستخدمة في رمز المصدر. يمكن استرداده باستخدام extractFromFiles extractFromCode .
• إرجاع تقرير.

مثال

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

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

الإضافات

FindUnused (لغة ، Keysused)

الإبلاغ عن المفتاح غير المستخدم. من المحتمل أن تتم إزالة تلك المفاتيح.

• يجب أن يكون locale كائنًا يحتوي على الترجمات.
• يجب أن تكون keysUsed صفيف. يحتوي على المفاتيح المستخدمة في رمز المصدر. يمكن استرداده باستخدام extractFromFiles extractFromCode .
• إرجاع تقرير.

مثال

 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 صفيف. يحتوي على المفاتيح المستخدمة في رمز المصدر. يمكن استرداده باستخدام extractFromFiles extractFromCode .
• يجب أن تكون 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',
 * }];
 */

Flidbiddynamic (لغة ، Keysused)

الإبلاغ عن أي مفتاح ديناميكي. يمكن القول أنه أكثر خطورة في استخدام المفتاح الديناميكي. قد يكسرون.

• يجب أن يكون locale كائنًا يحتوي على الترجمات.
• يجب أن تكون keysUsed صفيف. يحتوي على المفاتيح المستخدمة في رمز المصدر. يمكن استرداده باستخدام extractFromFiles extractFromCode .
• إرجاع تقرير.

مثال

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

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

Flatten (كائن)

تسطح الكائن.

• يجب أن يكون 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 (الرسائل ، poinput ، pooutput)

إخراج ملف PO جديد مع الرسائل الموجودة في messages فقط. إذا كانت رسالة موجودة بالفعل في 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.
 */ 

رخصة

معهد ماساتشوستس للتكنولوجيا