Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/i18n-pro/core
A lightweight, simple, flexible, automatic translation tool for JavaScript（适用于 JavaScript 的轻量、简单、灵活、自动翻译的国际化工具）
https://github.com/i18n-pro/core
auto-translation automatic-translation i18n javascript machine-translation react-i18n react-intl solid-i18n svelte-i18n translator vue-i18n
Last synced: 29 days ago
JSON representation
A lightweight, simple, flexible, automatic translation tool for JavaScript（适用于 JavaScript 的轻量、简单、灵活、自动翻译的国际化工具）
- Host: GitHub
- URL: https://github.com/i18n-pro/core
- Owner: i18n-pro
- License: mit
- Created: 2022-06-11T05:45:25.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T15:16:25.000Z (4 months ago)
- Last Synced: 2024-11-06T06:14:04.851Z (about 1 month ago)
- Topics: auto-translation, automatic-translation, i18n, javascript, machine-translation, react-i18n, react-intl, solid-i18n, svelte-i18n, translator, vue-i18n
- Language: TypeScript
- Homepage:
- Size: 2.44 MB
- Stars: 32
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hacking-lists - i18n-pro/core - A lightweight, simple, flexible, automatic translation tool for JavaScript（适用于 JavaScript 的轻量、简单、灵活、自动翻译的国际化工具） (TypeScript)
README
[](https://github.com/i18n-pro/core "github")
English | [简体中文](https://github.com/i18n-pro/core/blob/v2.1.1/README_zh-CN.md)
Lightweight, simple, flexible, automatic translation internationalization tool for JavaScript
[](https://www.npmjs.com/package/i18n-pro "npm")
[](https://www.npmjs.com/package/i18n-pro "npm")
[](https://github.com/i18n-pro/core/stargazers "github-stars")
[](https://github.com/i18n-pro/core/commits/dev "last-commit")
[](https://github.com/i18n-pro/core/issues "github-issues")
[](https://codecov.io/gh/i18n-pro/core "codecov")
Table of Contents
[Vision](#vision)
[Features](#features)
[Live Demo](#live-demo)
[Principle](#principle)
[Help Document](#help-document)
[License](#license)
# Vision
To make internationalization easy and enjoyable 😄💪🏻
# Features
* **lightweight**：[](https://bundlephobia.com/package/i18n-pro "bundlesize")
* **simple**：Low learning cost and easy to use
* **flexible**：Support `Variable Interpolation` , as well as unique type tag and formatting callbacks (numbers, currency, dates, times, plurals)
* **automatic-translation**：One command can automatically extract text and translate it to generate language packs
* **Support incremental translation mode**：Only translate new text and intelligently remove unused text
* **Support multi -translation platform**：Google x、OpenAI、Google、Microsoft、Tencent、Alibaba Cloud、Youdao、Baidu（In addition to Google x, other platforms need to register an account by themselves）
* **Support multiple translation logs**：The output of a variety of types of translation logs, which is convenient for tracking and positioning translation issues
* **keyless**：No need to manually define key, `Translation Text` is key
# Live Demo
* [Open in CodeSandbox](https://codesandbox.io/p/github/i18n-pro/core-demo/main?file=README.md)
* [](https://stackblitz.com/github/i18n-pro/core-demo?file=README.md)
# Principle
>Taking `Translation Text` as key is the key to all the functions of the library. If you have any questions about this, [Please see](https://github.com/i18n-pro/core/blob/v2.1.1/docs/dist/Q&A.md)
The library is mainly composed of two parts
* Command Line Tool
* Function API
**Command Line Tool**：Parse the text that needs to be translated based on specified rules (regular expressions), translate the text to the specified target language through a translation platform, and finally generate language pack files
An example of parsing text using [Matching Rules](https://github.com/i18n-pro/core/blob/v2.1.1/docs/dist/MATCH_RULE.md) is as follows:
```js
/** Normal string */
t('hello world')
t("hello world")
t(`hello world`)
/** Support Variable Interpolation */
t('hello {0}', 'developer friends'),
t('This is {0}, welcome to {1}. If you think {2}, please give {3} your support', ' `i18n-pro` ', 'use', `it's helpful for you`, ' ⭐️ ')
/** Interpolation Variable type tag need to be used with corresponding formatting callbacks */
// Number Type
t('The number of users has reached {n0}', 100000000)
// Currency Type
t('The selling price is {c0}', 14999)
// Date Type
t(`Today's date is {d0}`, new Date())
// Time Type
t('Current time: {t0}', new Date())
// Plural Type
t('I have {p0 apple}, {p1 banana} and {p2 pear}', 5, 4, 3)
```
**Function API**：Connect the international language package into the project, consisting of `initI18n` , `t` , `setI18n` and `withI18n`
* **initI18n**：Used to initialize the fixed configuration, and finally return the objects containing the following 3 APIs
* **t**：It is used for wrapping `Translation Text` to achieve internationalization, and it is also used as a logo of the command line to match `Translation Text` rules
* **setI18n**：Set language and language package
* **withI18n**：It is applicable to the server. Each interface response needs to be internationalized
Therefore, `Command Line Tool` and `Function API` work better together. It is precisely because of this structural design that `i18n-pro` library can be easily integrated into any `JavaScript` project
# Help Document
* [Quick Start](https://github.com/i18n-pro/core/blob/v2.1.1/docs/dist/USAGE.md)
* [Command Line](https://github.com/i18n-pro/core/blob/v2.1.1/docs/dist/COMMAND_LINE.md)
* [API](https://github.com/i18n-pro/core/blob/v2.1.1/docs/dist/API.md)
* [Matching Rules](https://github.com/i18n-pro/core/blob/v2.1.1/docs/dist/MATCH_RULE.md)
* [Translation Log](https://github.com/i18n-pro/core/blob/v2.1.1/docs/dist/OUTPUT_LOG.md)
* [Q&A](https://github.com/i18n-pro/core/blob/v2.1.1/docs/dist/Q&A.md)
* [Contribution Guidelines](https://github.com/i18n-pro/core/blob/dev/docs/dist/CONTRIBUTION_GUIDELINES.md)
* [Changelog](https://github.com/i18n-pro/core/blob/v2.1.1/docs/dist/CHANGELOG.md)
# License
[MIT](./LICENSE)
Copyright (c) 2022-present Eyelly Wu