Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mkpoli/ainconv
A JavaScript package to convert between Ainu writing systems
https://github.com/mkpoli/ainconv
ainu converter javascript typescript
Last synced: 14 days ago
JSON representation
A JavaScript package to convert between Ainu writing systems
- Host: GitHub
- URL: https://github.com/mkpoli/ainconv
- Owner: mkpoli
- License: mit
- Created: 2023-12-17T10:58:13.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-28T06:34:13.000Z (24 days ago)
- Last Synced: 2024-11-28T07:28:14.824Z (24 days ago)
- Topics: ainu, converter, javascript, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/ainconv
- Size: 216 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# ainconv - Ainu language script converter
## Overview
This npm package provides a comprehensive set of functions for converting text between different writing systems of the [Ainu language](https://en.wikipedia.org/wiki/Ainu_language).
Currently, Latin (Romanization), Katakana, Cyrillic and Hangul scripts are supported. We are also planning to convert between different romanization systems and Katakana variants. Currently only the more adopted version of Latin script and lossy Katakana script are supported. The converted string are always in lower case.
### Important Note
Conversion between Latin, Cyrillic and Hangul script are lossless, however, conversion between Katakana and other scripts are lossy. This means that converting from Katakana to other scripts and then back to Katakana may not give the original string and the result may be ambiguous or even incorrect.
This is because the Katakana script used broadly for the Ainu language is intrinsically ambiguous. For example, it does not distinguish between *tow* and *tu* (both *トゥ*), *iw* and *i.u* (both *イウ*), *ay* and *a.i* (both *アイ*), etc. Some alternative Katakana scripts are proposed to solve this problem, but none of them are widely adopted. We are planning to support some of these alternative scripts in the future.
## Installation
Install the package using npm (or bun, yarn, pnpm, etc.)
```bash
npm install ainconv
```
## Usage
### Word Conversion
```javascript
import { convert } from 'ainconv';
console.log(convert('イランカラㇷ゚テ', 'Kana', 'Latn')); // 'irankarapte'
console.log(convert('irankarapte', 'Latn', 'Kana')); // 'イランカラㇷ゚テ'
console.log(convert('иранкараптэ', 'Cyrl', 'Latn')); // 'irankarapte'
console.log(convert('irankarapte', 'Latn', 'Cyrl')); // 'иранкараптэ'
console.log(convert('이란가랍더', 'Hang', 'Latn')); // 'irankarapte'
console.log(convert('irankarapte', 'Latn', 'Hang')); // '이란가랍더'
// or use the alternative api
import {
convertLatnToKana,
convertKanaToCyrl,
// ...
} from 'ainconv';
convertLatnToKana('aynukotan'); // 'アイヌコタン'
convertKanaToCyrl('アイヌコタン'); // аинукотан
```
### Extra Functionality
#### Script Detection
Detect the script of a given string.
```javascript
import { detect } from 'ainconv';
console.log(detect('aynu')); // 'Latn'
console.log(detect('アイヌ')); // 'Kana'
console.log(detect('айну')); // 'Cyrl'
console.log(detect('애누')); // 'Hang'
```
#### Syllable Splitting
```javascript
import { separate } from 'ainconv';
console.log(separate('eyaykosiramsuypa')); // [ 'e', 'yay', 'ko', 'si', 'ram', 'suy', 'pa' ]
```
## Development
We use [bun](https://bun.sh/) as the build tool.
### Build
```bash
bun run build
```
### Test
```bash
bun test
```
## License
[MIT License](LICENSE) (c) 2023 mkpoli
## See also
* [ainconv - crates.io](https://crates.io/crates/ainconv): The Rust implementation of this package
* [Module:ain-kana-conv - ウィクショナリー日本語版](https://ja.wiktionary.org/wiki/%E3%83%A2%E3%82%B8%E3%83%A5%E3%83%BC%E3%83%AB:ain-kana-conv): The original Lua Scribunto module in the Japanese Wiktionary