如何用 vscode 捞出还未国际化的中文词条

耀视安防弱电突击队

做国际化一个很头疼的坑就是，你不知道项目里到底还有哪些中文词条没有国际化处理
纯靠人工去检查不现实，也不靠谱，而且浪费资源
所以还是得通过脚本工具来检查，思路是：

• 先保存好本地代码变更，准备好一个无文件变更的本地环境
  
• 再通过脚本把代码里的非展示性中文移除掉
  
  
  
  • 注释里的中文、console 里的中文，已经国际化处理过的中文
    
  
  
• 再用中文正则在 vscode 的全局搜索里匹配，捞出来的就是未国际化处理的中文词条
  
• 最后需要回退本地的更改，毕竟脚本是直接改动本地文件
  

脚本仅仅是检查用，用完记得回退代码
匹配中文词条的正则

• 单个中文：
  
  
  
  • [\u4E00-\u9FFF]
    
  
  
• 连续中文：
  
  
  
  • [\u4E00-\u9FFF]+
    
  
  
• 掺杂了各种符号、字母的中文句子：
  
  
  
  • [a-zA-Z0-9、：]*[\u4E00-\u9FFF]+[\u4E00-\u9FFF\.\-\*。,，a-zA-Z0-9/()（）:：”“！？、%_【】《》＞~～ ]*
    
  • （这里不建议把 : ： - ' " 这几个特殊符号也列到正则里，因为这些符号比较特殊，有的语法层面也支持，列进来反而会引出新问题，所以宁愿这种场景的句子被截成多断）
    
  
  
• 最好再加上文件的排除：
  
  
  
  • *.css,*.scss,*.less,*.json,*.bat,privacyProtocal.html,userProtocal.html,*.md,webpack**.js,*.txt,*.svg,*.properties,*.npmrc,vve-i18n-cli.config.js,baas,config,*.art,demo_index.html,*.sh,*.xml,*.java
    
  
  

脚本

移除非展示性中文的脚本

1. // index.js
3. #!/usr/bin/env node
5. /**
6. * 用来移除掉指定项目里的以下几类场景的中文：
7. * - 注释里的中文
8. * - 被国际化全局函数包裹的中文 $t
9. *
10. * 这样子方便借助 vs code 的全局正则搜索中文功能，来快速 review 未国际化的中文
11. * 正则： [\u4E00-\u9FA5]+
12. */
14. "use strict";
15. const program = require("commander");
16. const { loadConfig } = require("../configuration");
17. const core = require("./core");
18. const vfs = require("vinyl-fs");
19. const map = require("map-stream");
20. const path = require("path");
21. const fs = require("fs");
23. function commaSeparatedList(value, split = ",") {
24.   return value.split(split).filter((item) => item);
25. }
27. program
28.   .version(require("../../package.json").version)
29.   .option("--cwd <path>", "工作目录")
30.   .option("--root-dir <path>", "国际文本所在的根目录")
31.   .option(
32.     "--config <path>",
33.     "配置文件的路径，没有配置，默认路径是在${cwd}/vve-i18n-cli.config.js"
34.   )
35.   .option("--no-config", "是否取配置文件")
36.   .option(
37.     "--i18n-file-rules <items>",
38.     "匹配含有国际化文本的文件规则",
39.     commaSeparatedList
40.   )
41.   .option(
42.     "--ignore-i18n-file-rules <items>",
43.     "不匹配含有国际化文本的文件规则",
44.     commaSeparatedList
45.   )
46.   .parse(process.argv);
48. const config = {
49.   // 工作目录
50.   cwd: ".",
51.   // 根目录，国际文本所在的根目录
52.   rootDir: "src",
53.   // 配置文件的路径，没有配置，默认路径是在${cwd}/vve-i18n-cli.config.js
54.   config: undefined,
55.   // 是否取配置文件
56.   noConfig: false,
57.   // 匹配含有国际化文本的文件规则
58.   i18nFileRules: ["**/*.+(vue|js|html|htm)"],
59.   // 不匹配含有国际化文本的文件规则
60.   ignoreI18nFileRules: ["**/node_modules/**"],
61. };
63. Object.assign(config, program);
65. const CONFIG_JS_FILENAME = "vve-i18n-cli.config.js";
67. let absoluteCwd = path.resolve(config.cwd);
69. // 优先判断是否需要读取文件
70. if (!config.noConfig) {
71.   let configFilePath = path.join(absoluteCwd, CONFIG_JS_FILENAME);
72.   if (config.config) {
73.     configFilePath = path.resolve(config.config);
74.   }
75.   if (fs.existsSync(configFilePath)) {
76.     const conf = loadConfig(configFilePath);
77.     if (conf && conf.options && conf.options.zhCheck) {
78.       Object.assign(config, conf.options.zhCheck, program);
79.     }
80.   }
81. }
83. // 制定配置文件后，cwd在配置文件中定义，则cwd就需要重新获取
84. if (!program.cwd) {
85.   absoluteCwd = path.resolve(config.cwd);
86. }
88. const absoluteRootDir = path.resolve(absoluteCwd, config.rootDir);
90. function run() {
91.   console.log("================================>start");
92.   vfs
93.     .src(
94.       config.i18nFileRules.map((item) => path.resolve(absoluteRootDir, item)),
95.       {
96.         ignore: config.ignoreI18nFileRules.map((item) =>
97.           path.resolve(absoluteRootDir, item)
98.         ),
99.         dot: false,
100.       }
101.     )
102.     .pipe(
103.       map((file, cb) => {
104.         console.log("开始解析 =========================>", file.path);
105.         const extname = path.extname(file.path);
106.         let fileContent = file.contents.toString();
107.         let newFileContent = fileContent;
108.         if (extname.toLowerCase() === ".vue") {
109.           newFileContent = core.removeUnusedZhInVue(fileContent);
110.         } else if (extname.toLowerCase() === ".js") {
111.           newFileContent = core.removeUnusedZhInJs(fileContent);
112.         } else if ([".html", ".htm"].includes(extname.toLowerCase())) {
113.           newFileContent = core.removeUnusedZhInHtml(fileContent);
114.         }
115.         if (newFileContent !== fileContent) {
116.           console.log("发现无用的中文，正在移除中...");
117.           fs.writeFileSync(file.path, newFileContent);
118.         }
119.         console.log("解析结束 =========================>", file.path);
120.         cb();
121.       })
122.     )
123.     .on("end", () => {
124.       console.log("================================>end");
125.     });
126. }
128. run();

复制代码

1. // core.js
3. // 包含中文
4. const zhReg = new RegExp("[\\u4E00-\\u9FFF]+", "");
6. // 处理 vue 文件
7. function removeUnusedZhInVue(fileContent) {
8.   return removeUnusedZh(fileContent);
9. }
10. exports.removeUnusedZhInVue = removeUnusedZhInVue;
12. // 处理 js 文件
13. function removeUnusedZhInJs(fileContent) {
14.   return removeUnusedZh(fileContent);
15. }
16. exports.removeUnusedZhInJs = removeUnusedZhInJs;
18. // 处理 html 文件
19. // 处理 js 文件
20. function removeUnusedZhInHtml(fileContent) {
21.   return removeUnusedZh(fileContent);
22. }
23. exports.removeUnusedZhInHtml = removeUnusedZhInHtml;
25. function removeUnusedZh(fileContent) {
26.   const hasAnnotation = {
27.     "/*": false,
28.     "
29.   if (hasAnnotation["", "g");
30.     fileContent = fileContent.replace(reg, function (match, key, index) {
31.       let newKey = key;
32.       while (newKey.match(zhReg)) {
33.         newKey = newKey.replace(zhReg, "");
34.       }
35.       return match.replace(key, newKey);
36.     });
37.   }
38.   return fileContent;
39. }

复制代码

1. // configuration.js
2. const buildDebug = require("debug");
3. const path = require("path");
5. const debug = buildDebug("files:configuration");
7. function loadConfig(filepath) {
8.   try {
9.     const conf = readConfig(filepath);
10.     return conf;
11.   } catch (e) {
12.     debug("error", e);
13.     return null;
14.   }
15. }
17. function readConfig(filepath) {
18.   let options;
19.   try {
20.     const configModule = require(filepath);
21.     options =
22.       configModule && configModule.__esModule
23.         ? configModule.default || undefined
24.         : configModule;
25.   } catch (err) {
26.     throw err;
27.   } finally {
28.   }
29.   return {
30.     filepath,
31.     dirname: path.dirname(filepath),
32.     options,
33.   };
34. }
36. module.exports = {
37.   loadConfig,
38.   readConfig,
39. };

复制代码

1. {
2.   "dependencies": {
3.     "commander": "^3.0.2",
4.     "debug": "^4.1.1",
5.     "jsonfile": "^5.0.0",
6.     "lodash.uniq": "^4.5.0",
7.     "map-stream": "0.0.7",
8.     "pinyin-pro": "^3.11.0",
9.     "translation.js": "^0.7.9",
10.     "vinyl-fs": "^3.0.3",
11.     "xlsx": "^0.18.5"
12.   },
13.   "devDependencies": {
14.     "chai": "^4.2.0",
15.     "mocha": "^6.2.1",
16.     "nyc": "^14.1.1",
17.     "shelljs": "^0.8.3",
18.     "standard-version": "^7.0.0"
19.   },
20.   "version": "3.2.3"
21. }

复制代码

1. // vve-i18n-cli.config.js
2. module.exports = {
3.   // 工作目录
4.   cwd: ".",
5.   // 根目录，国际文本所在的根目录
6.   rootDir: "demo",
7.   // 默认所有模块，如果有传module参数，就只处理某个模块
8.   // '**/module-**/**/index.js'
9.   moduleIndexRules: ["*/pro.properties"],
10.   // 匹配含有国际化文本的文件规则
11.   i18nFileRules: ["**/*.+(vue|js)"],
12.   // 国际化文本的正则表达式，正则中第一个捕获对象当做国际化文本
13.   i18nTextRules: [/(?:[\$.])t\(['"](.+?)['"]/g],
14.   // 模块的国际化的json文件需要被保留下的key，即使这些组件在项目中没有被引用
15.   // key可以是一个字符串，正则，或者是函数
16.   keepKeyRules: [
17.     /^G\/+/, // G/开头的会被保留
18.   ],
19.   ignoreKeyRules: [/^el/],
20.   // 生成的国际化资源包的输出目录
21.   outDir: "i18n",
22.   // 生成的国际化的语言
23.   i18nLanguages: [
24.     "zh", // 中文
25.     "en", // 英文
26.   ],
27.   // 是否翻译
28.   translate: false,
29.   // 翻译的基础语言，默认是用中文翻译
30.   translateFromLang: "zh",
31.   // 是否强制翻译，即已翻译修改的内容，也重新用翻译生成
32.   forceTranslate: false,
33.   // 翻译的语言
34.   translateLanguage: ["zh", "en"],
35.   // 模块下${outDir}/index.js文件不存在才拷贝index.js
36.   copyIndex: true,
37.   // 是否强制拷贝最新index.js
38.   forceCopyIndex: false,
39.   // 国际化文本包裹相关
40.   zhWrap: {
41.     cwd: ".",
42.     // 根目录，国际文本所在的根目录
43.     rootDir: ".",
44.     i18nFileRules: [
45.       "!(node_modules|config)/**/*.+(vue)",
46.       // "base/components/login.vue",
47.       "base/common/js/httpHandle.js",
48.     ],
49.     ignorePreReg: [
50.       /t\s*\(\s*$/,
51.       /tl\s*\(\s*$/,
52.       /console\.(?:log|error|warn|info|debug)\s*\(\s*$/,
53.       new RegExp("//.+"),
54.     ],
55.     // js相关文件需要引入的国际化文件
56.     i18nImportForJs: "import i18n from '@inap_base/i18n/core'",
57.     // js相关文件需要使用国际化方法
58.     jsI18nFuncName: "i18n.t",
59.     // vue相关文件需要使用的国际化方法
60.     vueI18nFuncName: "$t",
61.   },
62. };

复制代码

硬替换脚本

具体查看 zh-i18n.zip

来源:https://www.cnblogs.com/dasusu/p/17945999
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！