Skip to content

koozaki/romaji-conv

Repository files navigation

romaji-conv

Convert romaji into kana

About

  • ローマ字・ひらがな・カタカナをひらがな・カタカナに変換します。
  • 訓令式、ヘボン式など幅広い記法に対応しています。
  • シンプルな完全ディクショナリ型設計のため誰でも簡単に改善ができます。
  • Browser, Node.js, CLI で動作する軽量 JavaScript ライブラリです。
  • 不具合報告はこちらからお願いします。

Usage

Browser

Load the romaji-conv.js (jsDelivr)
<script src="https://cdn.jsdelivr.net/npm/@koozaki/[email protected]/dist/romaji-conv.js"></script>
1. Method pattern
<script>
  console.log(romajiConv('hogehoge').toHiragana()); // ほげほげ

  // ローマ字 → ひらがな・カタカナ
  var romaji = romajiConv('anoinutyauchautocyauntyau');
  console.log(romaji.toHiragana()); // あのいぬちゃうちゃうとちゃうんちゃう
  console.log(romaji.toKatakana()); // アノイヌチャウチャウトチャウンチャウ

  // ひらがな → カタカナ
  var hiragana = romajiConv('あのいぬちゃうちゃうとちゃうんちゃう');
  console.log(hiragana.toKatakana()); // アノイヌチャウチャウトチャウンチャウ

  // カタカナ → ひらがな
  var katakana = romajiConv('アノイヌチャウチャウトチャウンチャウ');
  console.log(katakana.toHiragana()); // あのいぬちゃうちゃうとちゃうんちゃう
</script>
2. Function pattern
<script>
  var toHiragana = romajiConv.toHiragana;
  var toKatakana = romajiConv.toKatakana;

  // ローマ字 → ひらがな・カタカナ
  console.log(toHiragana('hogehoge')); // ほげほげ
  console.log(toKatakana('hogehoge')); // ホゲホゲ

  // ひらがな → カタカナ
  console.log(toKatakana('ほげほげ')); // ホゲホゲ

  // カタカナ → ひらがな
  console.log(toHiragana('ホゲホゲ')); // ほげほげ
</script>

Node.js

Install package
npm install @koozaki/romaji-conv

or

yarn add @koozaki/romaji-conv
1. Method pattern
const romajiConv = require('@koozaki/romaji-conv');

console.log(romajiConv('hogehoge').toHiragana()); // ほげほげ

// ローマ字 → ひらがな・カタカナ
const romaji = romajiConv('anoinutyauchautocyauntyau');
console.log(romaji.toHiragana()); // あのいぬちゃうちゃうとちゃうんちゃう
console.log(romaji.toKatakana()); // アノイヌチャウチャウトチャウンチャウ

// ひらがな → カタカナ
const hiragana = romajiConv('あのいぬちゃうちゃうとちゃうんちゃう');
console.log(hiragana.toKatakana()); // アノイヌチャウチャウトチャウンチャウ

// カタカナ → ひらがな
const katakana = romajiConv('アノイヌチャウチャウトチャウンチャウ');
console.log(katakana.toHiragana()); // あのいぬちゃうちゃうとちゃうんちゃう
2. Function pattern
const { toHiragana, toKatakana } = require('@koozaki/romaji-conv');

// ローマ字 → ひらがな・カタカナ
console.log(toHiragana('hogehoge')); // ほげほげ
console.log(toKatakana('hogehoge')); // ホゲホゲ

// ひらがな → カタカナ
console.log(toKatakana('ほげほげ')); // ホゲホゲ

// カタカナ → ひらがな
console.log(toHiragana('ホゲホゲ')); // ほげほげ

CLI

# ローマ字 → ひらがな・カタカナ
./bin/romaji-conv.js anoinutyauchautocyauntyau # あのいぬちゃうちゃうとちゃうんちゃう
./bin/romaji-conv.js anoinutyauchautocyauntyau --katakana # アノイヌチャウチャウトチャウンチャウ

# ひらがな → カタカナ
./bin/romaji-conv.js あのいぬちゃうちゃうとちゃうんちゃう --katakana # アノイヌチャウチャウトチャウンチャウ

# カタカナ → ひらがな
./bin/romaji-conv.js アノイヌチャウチャウトチャウンチャウ # あのいぬちゃうちゃうとちゃうんちゃう