vue i18n-collect工具开发

项目地址https://github.com/goblin-pitcher/i18n-collector
老项目引入i18n国际化后，需要对项目中所有中文包裹$t('中文')方法，对象不同，包裹的方法也有差异：

1. 在vue的template中，直接对中文包裹$t('中文')
2. 在vue的组件代码中，由于$t是全局引入，因此需包裹成this.$t('中文')
3. 对于纯js部分，需import i18n模块，并对中文包裹i18n.t('中文')
4. 对于带数字的字符串，如【共计${count}条数据】，需转换为$t('共计count条数据', {count: 100})的结构，转换前的代码在不同地方可能有不一样的表示，比如在vue的template中，转换前的词条可能是这样：【共计{{count}}条数据】

问题分析

面对此类问题，首先想到的自然是将代码转换成ast树，对其中的中文字符串进行处理，再转换为代码，但实际会遇到以下几个问题：

1. 一般的parser（如@bable/parser）只能处理js或jsx文件，无法处理vue模板，利用vue-loader将.vue文件转换成.js文件虽然可以配合@bable/parser进行解析，但转换成.js文件后的代码，没有相关的转换器将其反过来转换成.vue代码，这和我们的需求不符
2. 即使有.vue文件的parser（如vue-eslint-parser），但是没有对应的traverse和generator工具，不能将解析的ast反过来转换成代码
3. 即使有.vue文件的parser、traverse、generator配套工具，重新生成的vue代码格式很大概率无法满足eslint校验，需要自动进行格式修正

解决思路

通过对当前问题的分析，目前面临的问题有两个：

1. 需要有.vue文件配套的解析、生成工具
2. 解决转换后代码的eslint格式问题

问题2可以通过在生成处理后的.vue文件时，运行项目中的eslint --fix命令实现，若项目不校验格式，自然不会安装eslint，但若校验格式，则必定会安装eslint，也就是可以执行eslint --fix命令。

当前主要矛盾是问题1，而观察问题1，.vue文件中js文件有配套的转换工具，主要矛盾集中在template上，而目前虽然没有template的生成工具，但可以将其视作html解析，template特性的解析作为html parser的插件完成。

用法

npm i git+https://github.com/goblin-pitcher/i18n-collector.git -D
---------------------------------
npx i18n-collect

参数

参数名	简写	说明	默认值
dir	d	需要进行国际化处理的目录	./
ignoredir	i	需要忽略的文件或者文件夹 如 -i car.js 会忽略掉所有以 car.js结尾的文件	无论传不传此参数，都会忽略掉i18n文件夹
fix	f	运行完collect之后是否自动执行eslint --fix, 默认开启，--fix false即关闭eslint执行	true

配置

新建i18n-collect.config.js文件可传入具体配置，默认配置如下：

const defConfig = {
  // 转换当前目录下的文件
  dir: './',
  // 忽略项
  ignoredir: [],
  // 是否执行eslint --fix
  fix: true,
  // 收集中文词条的文件名
  output: 'zh-CN.js',
  // 文件处理配置
  file: {
    // 模板中包裹中文的函数名，如$t('中文')
    template: { prefix: "$t" },
    // 对于纯js文件的处理
    js: {
      // 若有中文词条需要提取，需要先引入i18n相关包才能包裹，该配置为添加引入文件的配置
      // 默认引入时添加 import {i18n} from '@/utils/i18n.utils'
      addImport: {
        from: "@/utils/i18n.utils",
        data: ["i18n"],
      },
      // 包裹中文词条的方法，如i18n.t('中文')
      prefix: "i18n.t",
    },
    // .vue文件中script包裹中文的方法, 如this.$t('中文')
    // 遇到sparePrefix配置，即i18n.t（'中文'）的字段，也会当作已包裹转换方法的字符串，而不会再用this.$t包裹一次
    vue: { prefix: "this.$t", sparePrefix: 'i18n.t' }
  }
};