Skip to content

Commit

Permalink
🏷️chore: 更新readme和package
Browse files Browse the repository at this point in the history
  • Loading branch information
asnipera committed Oct 13, 2022
1 parent d81a500 commit 692f9a5
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 14 deletions.
30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# vue-i18n-auto-generate

vue 项目国际化全流程解决方案: 一个命令行工具,对代码里的中文文案一键完成提取、替换、翻译、导入、导出等,告别手动操作
### 一键完成整个项目中文文案的提取、替换、翻译、导入、导出

## 功能

Expand All @@ -16,6 +16,12 @@ npm install -g vue-i18n-auto-generate

## 使用

```js
viag init
// cli为`viag`提供了一个简单好记的别名`i18n`
i18n init
```

### 示例

1. 在项目根目录(example/projectAfter)使用 `viag init` 命令初始化,生成配置文件(默认是 .vics 目录)
Expand All @@ -33,8 +39,6 @@ npm install -g vue-i18n-auto-generate

## 命令

### `viag init` or `i18n init`

```js
"bin": {
"viag": "src/index.js",
Expand All @@ -55,17 +59,17 @@ npm install -g vue-i18n-auto-generate

// 语言目录名,注意连线和下划线
srcLang: 'zh-CN',
distLangs: ['en'],
distLangs: ['en-US'],
langMap: {
'en_US': 'en',
'en-US': 'en',
'en': 'en',
en_US: 'en_US',
'en-US': 'en-US',
en: 'en',
},

// 百度翻译
baiduAppid: '',
baiduKey: '',

keyPrefix: '', // 如果设置了keyPrefix, 则生成的key为: `${keyPrefix}${index}`;否则通过百度翻译生成key
// https://api.fanyi.baidu.com/doc/21, 通用翻译API接入文档
baiduAppAPI: 'https://fanyi-api.baidu.com/api/trans/vip/translate',
baiduAppid: '20200602000482988',
baiduKey: 'CF5_meZdDAOtDzVkn2Nv',
// I18N import 语句,请按照自己项目情况配置
importI18N: "import I18N from '@/i18n';",
// import 语句后缀,用于判断是否已经引入过
Expand All @@ -76,7 +80,7 @@ npm install -g vue-i18n-auto-generate
ignoreFile: [],

// 导出未翻译的文案,Excel 列的配置
exportColConfig: ['export_path', '业务线', 'business_key', '描述(字典值)', '语料类型', '最长字符', '首字母大写', '语料说明图', 'translatable', 'formatted', 'zh_CN'],
exportColConfig: ['export_path', '业务线', 'business_key', '描述(字典值)', '语料类型', '最长字符', '首字母大写', '语料说明图', 'translatable', 'formatted', 'zh_CN','en_US',],
// 导出未翻译的文案,业务线、key、文案在 Excel 中列的索引
exportColIndexMap: {
businessLine: 1,
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "vue-i18n-auto-generate",
"version": "1.1.0",
"version": "1.2.0",
"packageManager": "[email protected]",
"description": "vue 项目国际化全流程解决方案: 一个命令行工具,对代码里的中文文案一键完成提取、替换、翻译、导入、导出等,告别手动操作",
"keywords": [
Expand Down

0 comments on commit 692f9a5

Please sign in to comment.