日本語のタイピングゲームの入力判定のためのライブラリです。
sya, sha, sixyaのように複数あるローマ字入力にも対応しています。

タイピングゲーム
プログラム

これを使ってください。

<script src="https://cdn.jsdelivr.net/npm/@mogamoga1024/typing-jp@latest/dist/cdn/typing-jp.js"></script>

npm i @mogamoga1024/typing-jp

import { TypingText } from "@mogamoga1024/typing-jp";

サンプルのプログラムを読んだ方が深く理解できると思いますが、ざっくりと説明します。

引数はひらがな、カタカナ、英語、数字などの変換せずに入力できる文字である必要があります。

const typingText = new TypingText("わたしは「こんにちは」といった。");

キーの入力情報はinputKeyメソッドを利用して更新します。

typingText.inputKey(keyboardEvent.key);
// 戻り値は
// "unmatch"    入力ミス
// "incomplete" 入力OKだが文章は未完成
// "complete"   入力OKで文章も完成した

残りのローマ字はremainingRomanプロパティで分かります。

console.log(typingText.remainingRoman); // watasiha[konnnitiha]toitta.

プロパティ一覧

// テキスト（ひらがな）
console.log(typingText.text); // わたしは「こんにちは」といった。

// 完成したテキスト（ひらがな）
console.log(typingText.completedText); // わたし

// 残りのテキスト（ひらがな）
console.log(typingText.remainingText); // は「こんにちは」といった。

// ローマ字
console.log(typingText.roman); // watasiha[konnnitiha]toitta.

// 完成したローマ字
console.log(typingText.completedRoman); // watasih

// 残りのローマ字
console.log(typingText.remainingRoman); // a[konnnitiha]toitta.

ShiftやF11のようなキーとして判定したくない入力はTypingText.isValidInputKeyメソッドで弾けます。
静的メソッドであることに注意してください。

if (TypingText.isValidInputKey(keyboardEvent.key) === false) {
    return;
}

この眠くなるようなリファレンスを読むよりもサンプルのプログラムを読んだ方が速く理解できると思います。

• TypingText(text[, ignoreSpace, priority])
• static isValidInputKey(key)
• inputKey(key[, isCapsLock])
• undo()
• text
• completedText
• remainingText
• roman
• completedRoman
• remainingRoman

コンストラクタ

• textが空と見なされた場合、EmptyTextErrorが投げられます。
• textがローマ字で表現できない場合、CharCreationErrorが投げられます。
• 第2引数がobjectの場合、priorityと解釈されます。

こういうことです。

console.log((new TypingText("じしん")).roman); // zisinn

const priority = {
    "じ": ["j"],
    "し": ["c"],
    "ん": ["x"],
};

console.log((new TypingText("じしん", priority)).roman); // jicixn

priorityのkeyはchar_factory.js内のswitchのcase句で定義されている文字列である必要があります。 詳しくはchar_factory.jsを参照してください。

ローマ字として有効な入力かどうかを判定します。
静的メソッドであることに注意してください。

具体例をあげると「Shift」「Ctrl」などの入力はfalse、「a」「7」などの入力はtrueを返します。

ローマ字として有効な入力の場合はtrue、それ以外はfalse

タイピング対象のテキストにkeyを反映させた後、その結果を返します。

以下のいずれかの文字列

"complete"が返された状態で更にinputKeyメソッドを呼び出すとNoRemainingInputErrorが投げられます。

大雑把に説明すると、

isCapsLockがtrueの場合
「あいうえお(aiueo)」というテキストに「AIUEO」と入力しても問題ないと見なします。
isCapsLockがfalseの場合
「あいうえお(aiueo)」というテキストに「AIUEO」と入力した場合、ローマ字として不適と見なします。(実際のキーボードの挙動に合わせている。)

意味わかんねーよ。的な方はfalse(デフォルト値)にしておけば何ら問題ありません。

入力されたkeyをひとつ取り消します。
未入力状態でundoした場合は何も起こりません。

なし

undefined

テキストを返すプロパティです。
カタカナはひらがなに、全角英数字は半角英数字に変換されています。

完成している箇所のテキストを返すプロパティです。
カタカナはひらがなに、全角英数字は半角英数字に変換されています。

未完成の箇所のテキストを返すプロパティです。
カタカナはひらがなに、全角英数字は半角英数字に変換されています。

ローマ字を返すプロパティです。

完成している箇所のローマ字を返すプロパティです。

未完成の箇所のローマ字を返すプロパティです。

https://github.com/mogamoga1024/Typing

MIT or WTFPL or くいなちゃんライセンス