textlint-rule-ja-hiraku
v1.4.0
Published
漢字を「ひらく」ためのtextlintルール
Readme
textlint-rule-ja-hiraku
textlint-rule-ja-hiraku は漢字を「ひらく」ためのtextlintルールです。
「ひらく」というのは、漢字の読みや文字から受ける印象を考慮し一部をひらがなで表記することで、読みやすく誤読しにくい文章へと変えることです。 漢字とひらがな、どちらで書くかが統一されるので、表記揺れを減らすことにも繋がります。
例:
丁度良かった。色々話を聞いて頂きたいと思っていた所でした。
↓
ちょうどよかった。いろいろ話を聞いていただきたいと思っていたところでした。インストール
npm install -g textlint-rule-ja-hiraku使い方
.textlintrc.json を利用する場合 (推奨):
{
"rules": {
"ja-hiraku": true
}
}CLIから利用する場合:
textlint --rule ja-hiraku README.md設定
形態素の品詞ごとにチェックするかどうかを切り替え可能です。
デフォルトでは全てチェック対象となっていますが、 ほどんどのケースでは以下のように代名詞・副助詞・副詞・補助動詞・補助形容詞・形式名詞・連体詞・接続詞のチェックだけで十分かもしれません。
{
"rules": {
"ja-hiraku": {
"daimeishi": true, // 代名詞のチェック (default: true)
"fukujoshi": true, // 副助詞のチェック (default: true)
"fukushi": true, // 副詞のチェック (default: true)
"hojodoushi": true, // 補助動詞のチェック (default: true)
"hojokeiyoushi": true, // 補助形容詞のチェック (default: true)
"keishikimeishi": true, // 形式名詞のチェック (default: true)
"other-doushi": false, // その他 (動詞) のチェック (default: true)
"other-jodoushi": false, // その他 (助動詞) のチェック (default: true)
"other-kandoushi": false, // その他 (感動詞) のチェック (default: true)
"other-keiyoushi": false, // その他 (形容詞) のチェック (default: true)
"other-meishi": false, // その他 (名詞) のチェック (default: true)
"rentaishi": true, // 連体詞のチェック (default: true)
"setsuzokushi": true, // 接続詞のチェック (default: true)
},
}
}品詞の値にオブジェクトを指定することで、語ごとにチェックするかどうかを切り替えることもできます。
キーには漢字表記 (surface_form) を使います。
指定されていない語はすべて有効として扱われます。
{
"rules": {
"ja-hiraku": {
"fukushi": {
"更に": false, // 副詞「更に」のチェックを無効化
"余り": false, // 副詞「余り」のチェックを無効化
},
},
}
}pending なエントリの有効化
一部のエントリはデフォルトでは pending 状態となっており、チェック対象外です。
これは、マイナーバージョンアップで辞書を追加しつつ、既存ユーザへの破壊的変更（新たなエラーの発生）をメジャーバージョンアップまで持ち越すための措置です。
先行して使いたい場合は、品詞の値にオブジェクトを指定して個別に有効化してください。
{
"rules": {
"ja-hiraku": {
"hojodoushi": {
"致し": true, // 補助動詞「致し（致す）」のチェックを有効化
},
},
}
}現在 pending 状態のエントリは以下の通りです。
| 品詞 | 漢字 | ひらがな | |---|---|---| | 補助動詞 | 致し | いたし |
開発
ビルド
npm run buildテスト
textlint-tester を利用してテストします。
npm test参考文献
開発するにあたり、以下の書籍やページを参考にさせていただきました。