@yi-xu-0100/conventional-commit-types-i18n/README.md

conventional-commit-types internationalization version.

# ⚡️ conventional-commit-types-i18n

**[`conventional-commit-types`](https://www.npmjs.com/package/conventional-commit-types) internationalization version.**

Release in [NPM](https://www.npmjs.com/package/@yi-xu-0100/conventional-commit-types-i18n) and [GPR](https://github.com/yi-Xu-0100/conventional-commit-types-i18n/packages/628736).

[![sync2gitee(list)](<https://github.com/yi-Xu-0100/hub-mirror/workflows/sync2gitee(list)/badge.svg>)](https://github.com/yi-Xu-0100/hub-mirror)
[![Build](https://github.com/yi-Xu-0100/conventional-commit-types-i18n/workflows/build/badge.svg)](https://github.com/yi-Xu-0100/conventional-commit-types-i18n/actions?query=workflow%3Abuild)
[![Release](https://github.com/yi-Xu-0100/conventional-commit-types-i18n/workflows/release/badge.svg)](https://github.com/yi-Xu-0100/conventional-commit-types-i18n/actions?query=workflow%3Arelease)
[![code coverage](https://img.shields.io/codecov/c/github/yi-Xu-0100/conventional-commit-types-i18n)](https://app.codecov.io/gh/yi-Xu-0100/conventional-commit-types-i18n)

[![npm download](https://img.shields.io/npm/dt/@yi-xu-0100/conventional-commit-types-i18n)](https://www.npmjs.com/package/@yi-xu-0100/conventional-commit-types-i18n)
[![Github last commit](https://img.shields.io/github/last-commit/yi-Xu-0100/repo-list-generator)](https://github.com/yi-Xu-0100/repo-list-generator)
[![Github latest release](https://img.shields.io/github/v/release/yi-Xu-0100/repo-list-generator)](https://github.com/yi-Xu-0100/repo-list-generator/releases)
[![Github license](https://img.shields.io/github/license/yi-Xu-0100/repo-list-generator)](./LICENSE)

[![views](https://raw.githubusercontent.com/yi-Xu-0100/traffic2badge/traffic/traffic-conventional-commit-types-i18n/views.svg)](https://github.com/yi-Xu-0100/traffic2badge/tree/traffic#-conventional-commit-types-i18n)
[![views per week](https://raw.githubusercontent.com/yi-Xu-0100/traffic2badge/traffic/traffic-conventional-commit-types-i18n/views_per_week.svg)](https://github.com/yi-Xu-0100/traffic2badge/tree/traffic#-conventional-commit-types-i18n)
[![clones](https://raw.githubusercontent.com/yi-Xu-0100/traffic2badge/traffic/traffic-conventional-commit-types-i18n/clones.svg)](https://github.com/yi-Xu-0100/traffic2badge/tree/traffic#-conventional-commit-types-i18n)
[![clones per week](https://raw.githubusercontent.com/yi-Xu-0100/traffic2badge/traffic/traffic-conventional-commit-types-i18n/clones_per_week.svg)](https://github.com/yi-Xu-0100/traffic2badge/tree/traffic#-conventional-commit-types-i18n)

## 🚀 Usage

### ⚡ Installation

```bash
npm i @yi-xu-0100/conventional-commit-types-i18n
```

### 🎨 Example

```js
const { getTypes } = require('@yi-xu-0100/conventional-commit-types-i18n');
const conventionalCommitsTypes = getTypes('en');
console.log(conventionalCommitsTypes.types['feat'].title); // Features
```

## ✅ Support

Available locales are as same as [the available display languages of `Visual Studio Code`](https://code.visualstudio.com/docs/getstarted/locales).

|      Language       | Locale files |                Contributors                |
| :-----------------: | :----------: | :----------------------------------------: |
|       English       |  [en.json]   |        [conventional-commit-types]         |
| Simplified Chinese  | [zh-cn.json] | [yi_Xu], [conventional-commit-types-zh-cn] |
| Traditional Chinese | [zh-tw.json] |             [Google Translate]             |
|       French        |  [fr.json]   |             [Google Translate]             |
|       German        |  [de.json]   |             [Google Translate]             |
|       Italian       |  [it.json]   |             [Fabio Di Stasio]              |
|       Spanish       |  [es.json]   |             [Google Translate]             |
|      Japanese       |  [ja.json]   |             [Google Translate]             |
|       Korean        |  [ko.json]   |             [Google Translate]             |
|       Russian       |  [ru.json]   |             [Google Translate]             |
|      Bulgarian      |  [bg.json]   |             [Google Translate]             |
|      Hungarian      |  [hu.json]   |             [Google Translate]             |
| Portuguese (Brazil) | [pt-br.json] |             [Google Translate]             |
|       Turkish       |  [tr.json]   |             [Google Translate]             |

[en.json]: https://github.com/yi-Xu-0100/conventional-commit-types-i18n/blob/main/locale/en.json
[conventional-commit-types]: https://github.com/commitizen/conventional-commit-types
[conventional-commit-types-zh-cn]: https://github.com/FieldTech/conventional-commit-types-zh-cn
[yi_xu]: https://github.com/yi-Xu-0100
[fabio di stasio]: https://github.com/Fabio286
[google translate]: https://translate.google.com/
[zh-cn.json]: https://github.com/yi-Xu-0100/conventional-commit-types-i18n/blob/main/locale/zh-cn.json
[zh-tw.json]: https://github.com/yi-Xu-0100/conventional-commit-types-i18n/blob/main/locale/zh-tw.json
[fr.json]: https://github.com/yi-Xu-0100/conventional-commit-types-i18n/blob/main/locale/fr.json
[de.json]: https://github.com/yi-Xu-0100/conventional-commit-types-i18n/blob/main/locale/de.json
[it.json]: https://github.com/yi-Xu-0100/conventional-commit-types-i18n/blob/main/locale/it.json
[es.json]: https://github.com/yi-Xu-0100/conventional-commit-types-i18n/blob/main/locale/es.json
[ja.json]: https://github.com/yi-Xu-0100/conventional-commit-types-i18n/blob/main/locale/ja.json
[ko.json]: https://github.com/yi-Xu-0100/conventional-commit-types-i18n/blob/main/locale/ko.json
[ru.json]: https://github.com/yi-Xu-0100/conventional-commit-types-i18n/blob/main/locale/ru.json
[bg.json]: https://github.com/yi-Xu-0100/conventional-commit-types-i18n/blob/main/locale/bg.json
[hu.json]: https://github.com/yi-Xu-0100/conventional-commit-types-i18n/blob/main/locale/hu.json
[pt-br.json]: https://github.com/yi-Xu-0100/conventional-commit-types-i18n/blob/main/locale/pt-br.json
[tr.json]: https://github.com/yi-Xu-0100/conventional-commit-types-i18n/blob/main/locale/tr.json

## 📄 License

- [MIT](https://github.com/yi-Xu-0100/conventional-commit-types-i18n/blob/main/LICENSE)

## 🎉 Thanks

- [vscode-conventional-commits](https://github.com/vivaxy/vscode-conventional-commits).
- [conventional-commit-types](https://github.com/commitizen/conventional-commit-types) for the English localization.
- [conventional-commit-types-zh-cn](https://github.com/FieldTech/conventional-commit-types-zh-cn) for the Simplified Chinese localization.
- [Fabio Di Stasio](https://github.com/Fabio286) for the Italian localization.