i18n-json-compiler 一个为TypeScript编写的国际化方案

Zack 发布于2019-08-22 14:04 / 1275人阅读

摘要：在写一个的过程中难免会遇到要做国际化的时候也就是需要根据不同的地区展示不同的文案对于简单的文本直接用一个或者或者一个变量就能搞定但是有时候需要在一句话中加入变量就比较麻烦或者说比较恶心了比如这样的情况有个人喜欢了你应运而生其作用是将模板

在写一个APP的过程中, 难免会遇到要做国际化的时候. 也就是需要根据不同的地区, 展示不同的文案. 对于简单的文本, 直接用一个xml或者json或者一个变量就能搞定, 但是有时候需要在一句话中加入变量, 就比较麻烦或者说比较恶心了. 比如这样的情况:

</>复制代码 
cn: 有xx个人喜欢了你.
en: xx People liked you.

i18n-json-compiler应运而生, 其作用是将json模板编译成TypeScript(或者JavaScript)函数或者字符串.

比如对以下json:

</>复制代码 
[
  { "cn": "你好", "en": "Hello" },
  { "cn": "{n}个好友", "en": "{n} friends" },
]

可以直接编译出ts文件, 内容大致如下:

</>复制代码 
export const cn = {
  Hello: "你好",
  n_friends: (n: any) => n + "个好友",
}
export const en = {
  Hello: "Hello",
  n_friends: (n: any) => n + " friends",
}

在代码中直接调用相应的属性或函数即可.

安装

</>复制代码 
yarn add i18n-json-compiler
# 或者使用npm/cnpm
npm i -S i18n-json-compiler

使用

在命令行中, 执行./node_modules/.bin/i18n, 参数如下:

</>复制代码 
i18n [options] - Parse i18n json files to typescript files.
Options:
  -i, --input-files  The json files to parse                 [string] [required]
  -o, --output-dir   The directory to emit output            [string] [required]
  -h, --help         Show help                                         [boolean]
  -v, --version      Show version number                               [boolean]
  --default-lang                                        [string] [default: "cn"]

JSON文档的格式

i18n命令接受参数-i指定输入文件列表(glob), 比如./strings/*.json, 文件格式为json, 内容为一个数组. 每个数组元素为一组需要编译的字符串. key为语言, value为值. 值中被{}包起来的地方会被转换为函数参数, 其格式为{name:type:default}, 其中:

name是必需的, 可以是字符串或数字

type为数据类型, 可以是int, double, string, boolean, any, 默认为any, 即接受任意参数

default为参数默认值

比如:

</>复制代码 
[
  {
    "cn": "{n:int:1}个人喜欢了你",
    "en": "{n}people liked you"
  }
]

得出的结果为:

</>复制代码 
const n_people_liked_you = (n: int = 1) => n + "个人喜欢了你"

输出格式

i18n接受参数-o指定输出目录, 输入目录中, 包括一个index.ts文件, 以及若干语言文件夹, 其中index.ts为所用到的文件, 其导出一个变量strings, 结构如下:

</>复制代码 
export interface I18n {
  // 设置语言
  set(lang: string, defaultLang?: L): void;
  // 获取语言下的字符串对象
  get(lang: string, defaultLang?: L): T;
  // 当前语言
  lang: L;
  // 当前语言的字符串结构
  value: T;
}

例子

参考https://github.com/acrazing/i..., 其中input为输入目录, output为输出目录. 在代码中, 只需要:

</>复制代码 
import { strings } from "./output/index.ts"
console.log(strings.value.world.$0_people_liked_you(1))

TODO

编译成js

不同语言参数位置不同

指定名称key

更多内容, 请稳步 https://github.com/acrazing/i...

云服务器 GPU云服务器用高级语言编写的程序为导出数据编写一个方法简单编写一个html 怎样编写一个小程序

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/92828.html

前端每周清单第 41 期 : Node 与 Rust、OpenCV 的火花，网络安全二三事

摘要：的网站仍然使用有漏洞库上周发布了开源社区安全现状报告，发现随着开源社区的日渐活跃，开源代码中包含的安全漏洞以及影响的范围也在不断扩大。与应用安全是流行的服务端框架，本文即是介绍如何使用以及其他的框架来增强应用的安全性。 showImg(https://segmentfault.com/img/remote/1460000012181337?w=1240&h=826); 前端每周清单专注...

syoya 2019-08-21 17:48 评论0 收藏0
Webpack附录

摘要：附录查看所有文档页面全栈开发，获取更多信息。常用用于修改行为定义环境变量，在区分环境中有介绍。开启功能，在开启中有介绍。借鉴的思想大幅度提升构建速度，在使用中有介绍。集成到项目中，在检查代码中有介绍。 Webpack附录查看所有文档页面：全栈开发，获取更多信息。原文链接：webpack原理，原文广告模态框遮挡，阅读体验不好，所以整理成本文，方便查找。常用 Loaders 加载文件 ...

dack 2019-08-26 11:55 评论0 收藏0
React项目国际化(antd)多语言开发

摘要：本国际化方案仅针对技术栈，且不会涉及服务端国际化内容。引入多语言环境的数据虽然我只用到了文本翻译的功能，以为就不需要加载这些数据，但后来发现这是必须的步骤。前言最近新接了一个项目，从0开始做，需要做多语言的国际化，今天搞了一下，基本达到了想要的效果，在这里简单分享下： showImg(https://segmentfault.com/img/bVbuiJB); 背景国际化方案国际...

tracymac7 2019-08-02 15:21 评论0 收藏0
React项目国际化(antd)多语言开发

摘要：本国际化方案仅针对技术栈，且不会涉及服务端国际化内容。引入多语言环境的数据虽然我只用到了文本翻译的功能，以为就不需要加载这些数据，但后来发现这是必须的步骤。前言最近新接了一个项目，从0开始做，需要做多语言的国际化，今天搞了一下，基本达到了想要的效果，在这里简单分享下： showImg(https://segmentfault.com/img/bVbuiJB); 背景国际化方案国际...

wushuiyong 2019-08-23 18:17 评论0 收藏0