feat: update readme

README-zh.md

@@ -2,17 +2,31 @@
 
 帮助你处理 i18n 的工具，可以提取代码的翻译项，可以导入导出到 excel 文件，可以生成 json 翻译资源。
 
-全局参数：
-
 - `--dry-run` 演习运行，用来效验和发现错误，如下。
   - 翻译同 key 不同翻译
   - 翻译 key 父子冲突
+- 工具会匹配代码格式为`i18nTranslate(langKey, langText, langTextOptions)`
+
+```javascript
+import React from 'react';
+import i18n from 'i18next';
+
+function i18nTranslate(key: string, text: string, option: {}) {
+  // your code
+  // ...
+  return i18n.t(key);
+}
+
+export default function BatchSendPage() {
+  return <div>{i18nTranslate('common.name', '我的名字{name}', { name: 'xiaohong' })}</div>;
+}
+```
 
 # 支持的命令
 
 ## 命令`code2excel`
 
-从代码中筛选出翻译项，然后输入到 excel 文件中。
+从代码中筛选出翻译项，然后输入到 excel 文件中（多次导出到 excel，新增项会追加到最后）。
 
 ### 参数
 
@@ -51,3 +65,5 @@
 -el, --excel-lang-column-index <number>  翻译内容对应列序号（从 1 开始）
 -jp, --json-path <path>                  json 文件路径
 ```
+
+# 常见问题

README.md

@@ -3,10 +3,25 @@
 Help you deal with I18N internationalization, extraction from code based on Babel, import and export excel, generate translation JSON file.
 
 - dry-run option, run command without saving the changes to the file system.
-- Extract from code, matching paradigm `i18nTranslate(langKey, langText, langOptions)`.
 - Error message
   - Different text from key.
   - Father son conflict.
+- Extract from code, matching paradigm `i18nTranslate(langKey, langText, langTextOptions)`
+
+```javascript
+import React from 'react';
+import i18n from 'i18next';
+
+function i18nTranslate(key: string, text: string, option: {}) {
+  // your code
+  // ...
+  return i18n.t(key);
+}
+
+export default function BatchSendPage() {
+  return <div>{i18nTranslate('common.name', '我的名字{name}', { name: 'xiaohong' })}</div>;
+}
+```
 
 # All commands
 

src/code.js

@@ -63,6 +63,8 @@ class CodeServiceFactory {
 
     const shortFile = file.replace(this.config.codeFolderPath, '');
 
+    term(`=> Code: file ${shortFile}\n`);
+
     const ast = babelParse(fileContent, {
       sourceType: 'module',
       plugins: ['jsx', 'typescript', 'classProperties', 'decorators-legacy'],
@@ -76,6 +78,16 @@ class CodeServiceFactory {
           let rawKey = args[0].value;
           let text;
 
+          if (!args[1]) {
+            this.errorTranslations.push({
+              rawKey,
+              text,
+              file,
+              shortFile,
+              error: '没有找到翻译默认值'
+            });
+            return;
+          }
           if (args[1].type !== 'StringLiteral') {
             text = babelGenerator(args[1]).code;
           } else {

test/demo/a.js

@@ -0,0 +1,3 @@
+const a1 = i18nTranslate('common.name1');
+const a2 = i18nTranslate('common.name2', '我的名字{name}');
+const a3 = i18nTranslate('common.name3', '我的名字{name}', { name: 'xiaohong' });

test/demo/b.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+
+function b() {
+  return <div>{i18nTranslate('common.name4', '我的名字{name}', { name: 'xiaohong' })}</div>;
+}
+
+export default b;

test/lang/zh.json

@@ -0,0 +1,7 @@
+{
+  "common": {
+    "name2": "我的名字{name}",
+    "name3": "我的名字{name}",
+    "name4": "我的名字{name}"
+  }
+}