Package Exports

@fefeime/cli
@fefeime/cli/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@fefeime/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

介绍

这是一个支持自动将中文替换成 i18n 国际化标记的命令行工具

功能 🎉

支持.mjs.cjs.js.ts.jsx.tsx.vue 后缀文件提取中文
支持 vue2.0，vue3.0，react 提取中文
支持通过/*i18n-ignore*/注释，忽略中文提取
支持将提取的中文以 key-value 形式存入*.json 语言包里
支持 prettier 格式化代码
支持将翻译结果导出成 excel
支持读取 excel 文件并转换成语言包
自定义语言包 key 的层级嵌套
自定义语言包的 key
自定义 i18n 工具的调用对象
自定义 i18n 工具的方法名
自定义 i18n 第三方包的导入
自定义忽略提取的方法

安装

npm i @fefeime/cli -g

使用

在项目根目录执行下面命令

fm

指令参数

参数	类型	默认值	描述
-i, --input	String	'src'	指定待提取的文件目录。
-o, --output	String	''	输出转换后文件路径。没有值时表示完成提取后自动覆盖原始文件。当有值时，会输出到指定目录
-c, --config-file	String	''	指定命令行配置文件的所在路径（可以自定义更多功能）
--localePath	String	'./locales/zh.json'	指定提取的中文语言包所存放的路径。
-v,--verbose	Boolean	false	控制台打印更多调试信息
-h,--help	Boolean	false	查看指令用法
--skip-extract	Boolean	false	跳过 i18n 转换阶段。
--locales	Array	['en']	根据中文语言包自动翻译成其他语言。用法例子 --locales en zh-CHT
--incremental	Boolean	false	开启后。支持将文件中提取到中文键值对，追加到原有的中文语言包。
--exportExcel	Boolean	false	开启后。导出所有翻译内容到 excel。默认导出到当前目录下的 locales.xlsx
--excelPath	String	'./locales.xlsx'	指定导出的 excel 路径。
--apiExcelUrl	String	''	指定读取远程 excel 文件地址。

子命令

子命令	描述
init	在项目里初始化一个命令行配置
loadExcel	根据导入翻译文件的 excel 内容，生成语言包
loadApiExcel	根据导入远程翻译文件的 excel 内容，生成语言包

命令行配置

如果有更多的定制需求，可以在项目根目录执行fm init，创建i18n.config.js文件，按自身需求修改完配置后，再执行fm -c i18n.config.js。（注意：配置文件里参数的优先级比指令参数高）

// 以下为i18n.config.js默认的完整配置，所有属性均为可选，可以根据自身需要修改
const { resolve } = require("path");
function getAbsolutePath(...paths) {
  const ret = resolve(...paths);
  return ret;
}
const config = {
  caller: "",
  functionName: "ts",
  customizeKey: function getCustomizeKey(key) {
    return key;
  },
  importDeclaration: 'import { ts } from "@/language/translate"',
};

const tsConfig = {
  // input: 'src/pages/TTkolOperate', 此处暂时手写具体文件夹路径
  // translate方法主要参数
  input: getAbsolutePath(__dirname, "../../src/pages"),
  output: getAbsolutePath(__dirname, "lang/sourceCode"),
  exclude: ["**/node_modules/**/*"],
  // translate方法主要参数 ---------end
  rules: {
    js: config,
    jsx: config,
    ts: config,
    tsx: config,
  },
  prettier: {
    trailingComma: "es5",
    tabWidth: 2,
    useTabs: true,
    semi: false,
    bracketSpacing: true,
    jsxBracketSameLine: false,
    singleQuote: true,
    endOfLine: "auto",
    eslintIntegration: true,
    printWidth: 100,
  },
  skipExtract: false,
  localePath: getAbsolutePath(__dirname, "lang/zh.json"),
  exportExcel: true,
  // 导出excel存放的路径
  outputExcelPath: getAbsolutePath(__dirname, "lang/testExcel.xlsx"),
  // 导出文件的格式，默认是json
  localeFileType: "json",
  // 是否增量添加语言, false则全部替换
  incremental: false,
  // 导出需要转成json的excel源数据 -- 本地资源
  // excelPath: '/Users/perfectyang/Desktop/需要翻译.xlsx',
  excelPath: "/Users/perfectyang/Desktop/test.xlsx",
  // 导出需要转成json的excel源数据 -- 远程资源excel地址
  apiExcelUrl:
    "http://dms-upload-dev-sg.oss-ap-southeast-1.aliyuncs.com/uploadfile/20230331/8f42a054-1dd1-45f5-b580-4c85fabddbb1.xlsx",
  // 根据excel文件生成的json文件, 指定导出的路径
  excelJsonOutPutPath: getAbsolutePath(__dirname, "../../src/language/locales"),
  locales: ["en"],
};

module.exports = tsConfig;

跳过转换阶段，仅将中文语言包翻译成其他语言(例如英语、中文繁体等)

fm --skip-extract --locales en zh-CHT

进行 i18n 转换，并将提取到的 key-value 提取到中文语言包

fm

使用自定义配置进行 i18n 转换

fm -c ./i18n.config.js

指定需要自动翻译的语言(例如日语)，并指定项目里中文语言包的位置(相对于命令的执行位置)。命令执行时会自动根据中文语言包，将日语翻译出来并存入到ja.json文件中

fm --localePath ./locales/zh-CN.json  --locales ja

指定需要转换的文件目录，并增量提取中文。例如项目的 src 目录有 A、B、C 三个文件夹，里面分别有 A,B,C 三个文件，其中 A、B 已经替换过 i18n，此时执行命令，会将 C 文件的中文进行 i18n 替换，并将新提取到的中文追加到原有的中文语言包里

fm --incremental -i ./src/C

导入 excel

excel 的表头格式['字典key', 'zh']

# 方式1，根据指令参数
fm loadExcel --excelPath ./demo.xlsx --localePath ./locales/zh-CN.json
# 方式2，根据本地配置
fm loadExcel -c ./i18n.config.js
# 方式3，根据远程excel地址，拉取生成多语言配置
fm loadApiExcel -c ./i18n.config.js

导出 excel

# 方式1，根据指令参数
fm --skip-extract --skip-translate --exportExcel --excelPath ./demo.xlsx
# 方式2，根据本地配置
fm --skip-extract --skip-translate  -c ./i18n.config.js

转换效果示例

react 转换示例

转换前

import { useState } from "react";

/*i18n-ignore*/
const b = "被忽略提取的文案";

function Example() {
  const [msg, setMsg] = useState("你好");

  return (
    <div>
      <p title="标题">{msg + "呵呵"}</p>
      <button onClick={() => setMsg(msg + "啊")}>点击</button>
    </div>
  );
}

export default Example;

转换后

import { ts } from "@/language/translate";
import { useState } from "react";

/*i18n-ignore*/
const b = "被忽略提取的文案";

function Example() {
  const [msg, setMsg] = useState(ts("你好"));
  return (
    <div>
      <p title={ts("标题")}>{msg + ts("呵呵")}</p>
      <button onClick={() => setMsg(msg + ts("啊"))}>{ts("点击")}</button>
    </div>
  );
}
export default Example;