langs-tool

Features

• excel 转 json/typescript/自定义模板
  • 支持一行有多个字段 KEY()
  • 支持冗余字段删除(templateExcel)
  • 支持未翻译字段占位(missingMode=placeholder)
  • 支持多个文件批量转化
  • 支持字段覆盖
  • 可自动查找 ID 列和语言行([[ID]])
  • 支持一个语言一个文件 或 一个语言一个模块(ID 第一层 KEY)一个文件
• 多语言 json 转 excel

命令行方式

1. 安装 npm i langs-tool
2. 使用

# 查看帮助文档
npx langs-tool -h

# 转化xlsx 为json文件
npx langs-tool -f ./dist/lang-base-*.xlsx ./dist/lang-v2-*.xlsx --output ./dist  --fileType xml

# 转xlsx 为xml文件 fileType=xml
npx langs-tool -f ./dist/lang-base-*.xlsx ./dist/lang-v2-*.xlsx --output ./dist --fileType xml

# 转xlsx 为ts文件 fileType=ts
npx langs-tool -f ./dist/lang-base-*.xlsx ./dist/lang-v2-*.xlsx --output ./dist --templateExcel ./dist/template.xlsx --fileType ts --missingMode placeholder

excel 格式说明

• ID 列(idCol)： 表示 ID 所在的列
  • ID 列中数据为空时，表示该行不需要翻译
  • ID 列支持多对一
    • 表格的一行数据对应多个 ID
    • 通过换行符分隔
    • {IGNORE} 表示忽略该行
    • {CONTINUE} 表示该行合并到上一行 ID 中
  • ID 列重复时，以后面的 ID 列数据为准
  • ID 值规范
    • namePath 标识
    • 用.标识对象
    • 用[n]标识数组
• 语言行(langNameRow)：表示语言简称所在的行
  • 语言行有效语言定义
    • 从 ID 列往后一列，同时非空的单元格
    • 有效语言简称不能包含'[' 或 ']'
  • 语言行中所有有效语言，都将翻译为一种语言
• ID 列和语言行交叉的 Cell 为定位锚点(anchorCellPos)
  • 可手动指定
  • 也可自动查找表格单元格内容为[[ID]]的单元格
• 有效数据，同时满足以下条件
  • 有效语言所在列
  • 起始行 为语言行下一行
  • 所在行对应的 ID 有值

1. 多行 ID 示例

// 下面内容表示，前两行内容为FieldName1的值，忽略第三行，第四行内容为FieldName2的值
FieldName1
{CONTINUE}
{IGNORE}
FieldName2

2. ID 示例 ID:

Feedback.title
Feedback.info.foo
Feedback.info.boo
Feedback.questions[0].title
Feedback.questions[1].content

对应的 json 数据

{
  "Feedback": {
    "title": "",
    "info": {
      "foo": "",
      "boo": ""
    },
    "questions": [
      {
        "title": ""
      },
      {
        "content": ""
      }
    ]
  }
}

excel 转 多语言包

• 支持多 excel 转化
• 支持只转化模板 excel 中的字段(template)
• 支持转化文件模板 customTemplatePath

const path = require('path')
const {
  convertExcelToFile,
  convertExcelToLangsInfoModel,
} = require('langs-tool')
convertExcelToFile(
  ['./excel/v1-complete.xlsx', './excel/v2-id.xlsx', './excel/v2-hi.xlsx'],
  {
    fileType: 'ts',
    template: './excel/template.xlsx',
    customTemplatePath: './tpl.txt',
    fileType: 'custom-module',
    output: './dist-lang',
    missingMode: 'placeholder',
    missingValue: '[TODO:LACK_FIELD]',
  }
)

// excel转语言包
const langsModel = convertExcelToLangsInfoModel(
  ['./excel/v1-complete.xlsx', './excel/v2-id.xlsx', './excel/v2-hi.xlsx'],
  {
    sheetIdx: [0, 1, 2], // 支持数组，默认为0
    template: './excel/template.xlsx',
  }
)
// 获取某个语言的对象
const langInfoModel = langsModel.getLangInfoModel('en')
langInfoModel.fieldList.forEach((item) => {
  console.log(item.name, item.value) // 遍历所有字段
})
// 获取打平的json字符串
console.log(langInfoModel.getPlainMapJsonString(2))

// 获取嵌套的多语言对象
console.log(langInfoModel.toLangObj())

模板定义 tpl.txt

langInfo: {{=it.langName}}
moduleName: {{=it.moduleName}}
langObject: {{=it.moduleJsonString}}

语言包转 excel

待翻译 en 语言转 excel

const { convertToExcel } = require('langs-tool')
convertToExcel(
  {
    moduleName: {
      title: 'title',
      list: ['sd', 'sdf'],
      obj: {
        key1: 'sdf',
      },
    },
    module2: {
      title: 'sdf',
    },
  },
  {
    output: './lang.xlsx',
    langNameListToTranslate: ['hi'],
  }
)

json 文件转多语言模块对象

const path = require('path')
const { createLangModuleMapByFileGlob } = require('langs-tool')
createLangModuleMapByFileGlob(path.join(__dirname, './local/**/*.json'), {
  convertToLangJson: (strContent) => JSON.parse(strContent),
  basePath: path.join(__dirname, './local'),
})

现有语言包抽取未翻译部分，生成 excel

const { convertSubtractLangsToExcels } = require('langs-tool')
convertSubtractLangsToExcels(
  {
    en: {
      moduleName: {
        title: 'title',
        list: ['sd', 'sdf'],
        obj: {
          key1: 'sdf',
        },
      },
      module2: {
        title: 'sdf',
      },
    },
    hi: {
      moduleName: { title: '[TODO]' },
    },
  },
  'en', //模板语言
  {
    output: './dist.trans/', //相对于
    placeholderPrefix: '[TODO]',
  }
)

现有语言包转基础 excel

const {
  convertMultiLangsToExcel,
  createLangModuleMapByFileGlob,
} = require('langs-tool')
// 读取现有json
const fileContentMap = createLangModuleMapByFileGlob('./local/**/*.json', {
  convertToLangJson: (strContent) => JSON.parse(strContent),
  basePath: path.join(__dirname, './local'),
}) // A/en.json,B/SubB/en.json
// const fileContentMap={
//     en:{
//         moduleName:{
//             title:'title 1',
//             list:['sd','sdf'],
//             obj:{
//                 key1:'sdf'
//             }
//         },
//         module2:{
//             title:'sdf'
//         }
//     },
//     id:{
//         ...
//     },
//     hi:{
//         ...
//     }
// }
convertMultiLangsToExcel(fileContentMap, {
  output: './lang-base.xlsx',
})

现有语言包转中间产物

import { convertLangInfoToList } from 'langs-tool'
// langObj为{moduleName:{xxx:'xxx'}} 结构，将被打平
const fieldList = convertLangInfoToList(langObj)
fieldList.forEach((item) => {
  console.log(item.name, item.value)
})