0.0.3 • Published 10 months ago

textlint-rule-ja-tojihiraki v0.0.3

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
10 months ago

textlint-rule-ja-tojihiraki

npm version Node.js CI textlint rule

textlint-rule-ja-tojihiraki は漢字の開閉を統一するtextlintルールです。

漢字を「ひらく」というのは、漢字の読みや文字から受ける印象を考慮し一部をひらがなで表記することで、読みやすく誤読しにくい文章へと変えることです。「閉じる」はその逆です。 漢字とひらがな、どちらで書くかが統一されるので、表記揺れを減らすことにも繋がります。

例:

丁度良かった。色々話を聞いて頂きたいと思っていた所でした。
↓
ちょうどよかった。いろいろ話を聞いていただきたいと思っていたところでした。

インストール

npm install -g textlint-rule-ja-tojihiraki

使い方

.textlintrc.json を利用する場合 (推奨):

{
  "rules": {
    "ja-tojihiraki": true
  }
}

CLIから利用する場合:

textlint --rule ja-tojihiraki README.md

設定

閉じるか無視するか、各種例外を設定することができます。

デフォルトでは全てを開くべきとなっています。

{
  "rules": {
    "ja-tojihiraki": {
      "ignore": [ "イタダキ" ], // 無視する値
      "force-close": [ "doushi", "jodoushi", "kandoushi", "meishi", "keiyoushi", "meishi" ], // 閉じるべき値
    },
  }
}
  • "all":全ての品詞を対象
  • 形態素の格
    • "daimeishi" : 代名詞 「貴方」等
    • "fukugoukakujoshi" : 複合格助詞 「を始め」
    • "fukujoshi" : 副助詞 「程」等
    • "fukushi" : 副詞 「余り」等
    • "hojodoushi" : 補助動詞 「上げ」等
    • "hojokeiyoushi" : 補助形容詞 「欲しい」等
    • "keishikimeishi" : 形式名詞 「事」等
    • "doushi : 動詞 「分かる」等
    • "jodoushi" : 助動詞 「御座い」等
    • "kandoushi" : 感動詞 「有難う」等
    • "keiyoushi" : 形容詞 「有難い」等
    • "meishi" : 名詞 「全て」等
    • "rentaishi" : 連体詞 「色んな」等
    • "setsuzokushi" : 接続詞 「或いは」等
  • 各単語(読みのカタカナ)

優先順位は、各単語 > 形態素の格 > "all"で、同じ設定値が複数含まれていたら、ignore > force-close > force-openです。

開発

ビルド

npm run build

テスト

textlint-tester を利用してテストします。

npm test

参考文献

開発するにあたり、以下の書籍やページを参考にさせていただきました。

このTextlintプロジェクトはakiomik氏のtextlint-rule-ja-hirakuをベースとしております。

0.0.3

10 months ago

0.0.2

11 months ago

0.0.1

11 months ago