extract-character-cli

一个小型文本抽取工具，用于跟踪代码中的字符变量，并替换成相应的调用方法，来实现多语化。抽取完成后需要使用 extract-character-lang-utils 在项目中完成多语部署。

Usage

安装

    npm install extract-character-cli -g

或工程中安装

    npm install extract-character-cli -D

使用

工程根目录增加配置文件extract.config.js

module.exports = {
    "source": "./src", //源码路径，可配置多个单独路径
    //或者
    "source": ["./src", ".utils"], 
    "sourceOutput": "./back",//修改后的代码导出路径，若设置为 "" 则默认修改源码，若配置为 false 则不会导出修改后的代码，只会导出多语文件
    "output": "./lang", // 多语文件导出路径
    "fileName": "lang.json", // 多语文件名称
    "local": "./local"//本地多语文件，会根据字符内容匹配代码中的字符，若本地多语文件中已存在该字符则会直接使用该文件中的id
}

生成多语

    ech --config ./extract.config.js

若工程局部安装则需要先配置 scripts 命令

{
  //package.json
  ...
  "scripts": {
    "ech": "ech --config extract.config.js",
  },
  ...
}
 

然后工程目录中使用 npm 启动命令

npm run ech

回滚

在0.2.0版本中增加了回滚机制主要用于回滚错乱的抽取代码。使用方式和提取过程一样使用extract.config.js配置文件，参数含义相同。

  ech --rollback extract.config.js

回滚会将原替换的echlang调用过程替换为原来的字符，便于重新提取。

Others

构建产物

├── lang 
    ├── lang-local.info # 抽取的多语信息记录，主要记录抽取位置、id以及统计等
    └── lang.json       # 抽取的多语文件，由 id 和 defaultMessage 组成

//lang-local.info
{
  "添加成功": {
    "id": "js.lang.massage.2", 
    "defaultMessage": "添加成功",
    "items": [ //被抽取的文件汇总和关键代码行
      {
        "filePath": "/src/model.js",
        "line": 155
      }
    ]
}
...

//lang.json
{
  "js.lang.massage.1": "添加成功",
  "js.lang.massage.2": "修改成功",
  ...
}

部署使用

详情查看

• extract-character-lang-utils
• DEMO