(Translated by https://www.hiragana.jp/)
GitHub - textlint-ja/textlint-rule-ja-unnatural-alphabet: 不自然なアルファベットを検知するtextlintルール
Skip to content

不自然ふしぜんなアルファベットを検知けんちするtextlintルール

License

Notifications You must be signed in to change notification settings

textlint-ja/textlint-rule-ja-unnatural-alphabet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

textlint-rule-ja-unnatural-alphabet Actions Status: test

不自然ふしぜんなアルファベットを検知けんちするtextlintルール。

IMEの入力にゅうりょくミスによるtypoをつけるルールです。

{日本語にほんご}{アルファベット}{日本語にほんご}のように不自然ふしぜんかたちでアルファベットが登場とうじょうした場合ばあいをチェックしていないかをチェックしています。

Example

OK:

リリース
aiueo
This is pen.

NG:

リイr−ス
対応たいおうでkない

Install

Install with npm:

npm install textlint-rule-ja-unnatural-alphabet

Usage

Via .textlintrc(Recommended)

{
    "rules": {
        "ja-unnatural-alphabet": true
    }
}

Via CLI

textlint --rule ja-unnatural-alphabet README.md

Options

  • allow: string[]
    • 無視むしするアルファベットや単語たんご配列はいれつ
    • デフォルト: ["a", "i", "u", "e", "o", "n", "/[A-Z]/"]
    • デフォルトでは母音ぼいんとn、大文字おおもじのAからZを例外れいがいとしてのぞいている
    • "/正規せいき表現ひょうげん/" のようなRegExp-like Stringもサポートしています
{
    // 無視むしするアルファベット
    // れい) ["r"]
    // デフォルトでは母音ぼいんとn、大文字おおもじのアルファベットを除外じょがい
    // 単独たんどく大文字おおもじのアルファベットは入力にゅうりょくミスでは発生はっせいしにくため
    "allow": [
        "a", "i", "u", "e", "o", "n",
        "/[A-Z]/"
    ],
    // ビルトインの典型てんけいれい除外じょがいするかどうか
    // れい) C言語げんご
    "allowCommonCase": true
}

allow: string[]

allowオプションには、エラーとしたくない文字もじれつまたはRegExp-like String指定していできます。 RegExp-like String//かこんだ正規せいき表現ひょうげんライクな文字もじれつです。詳細しょうさいつぎ参照さんしょうしてください。

たとえば、アンドロイドnを購入こうにゅうするという文章ぶんしょう{日本語にほんご}{アルファベット}{日本語にほんご}のルールに該当がいとうするためエラーとなりますが、allowオプションではエラーを無視むしするように設定せっていできます。

{
    // 無視むしする設定せってい追加ついか
    "allow": [
        "アンドロイドn"
    ]
}

同様どうようRegExp-like String使つかうことで、allowオプションに正規せいき表現ひょうげんのような指定してい可能かのうです。

⚠️ RegExp-like String文字もじれつ正規せいき表現ひょうげんリテラルをくため、\dのような特殊とくしゅ文字もじ"\\d"とエスケープする必要ひつようがあります。

つぎ設定せっていアンドロイド{アルファベット}問題もんだいないとしてエラーにしません。

{
    "allow": [
        // RegExp-like String は `/` と `/` でかこ
        "/アンドロイド[a-zA-Z]/"
    ]
}

参考さんこう文献ぶんけん

(3) 不自然ふしぜんなアルファベット

  • 1文字もじのみのアルファベットが日本語にほんごちゅうあらわれた場合ばあい検出けんしゅつ対象たいしょうとする
  • 大文字おおもじは、略記りゃっきごうなどを意識いしきしてれている可能かのうせいがある
  • このミスでは母音ぼいん(aiueo)は発生はっせいしないのでのぞ
  • nおおくの場合ばあいには、となるためのぞ

CiNii 論文ろんぶん -  日本語にほんご文章ぶんしょう校正こうせいツール"Chanterelle" : 入力にゅうりょくミスおよ表記ひょうきらぎについてより

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm i -d && npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu