textlint-rule-max-kanji-continuous-len

    1.1.1 • Public • Published

    textlint-rule-max-kanji-continuous-len Build Status Gitter

    textlint rule that limit max continuous length of kanji(漢字).

    漢字が連続する最大文字数を制限するtextlintルールです。

    Install

    Install with npm:

    npm install textlint-rule-max-kanji-continuous-len
    

    Usage

    Via .textlintrc(Recommended)

    {
        "rules": {
            "max-kanji-continuous-len": true
        }
    }

    Via CLI

    textlint --rule max-kanji-continuous-len README.md
    

    Options

    • max: number
      • default: 5
      • 連続できる漢字の文字数
      • 一二三四五六は6文字なのでエラーとなります。
    • allow: string[]
      • default: []
      • 無視する単語の配列
    {
        "rules": {
            "max-kanji-continuous-len": {
                // 連続できる漢字の文字数
                // Allow max continuous length of kanji
                // If {current} > max(5), report Error.
                max: 5,
                // "倍精度浮動小数点数"という単語は例外として無視します
                allow: ["倍精度浮動小数点数"]
            }
        }
    }

    Further Reading

    デフォルト値である漢字の連続長が6文字以上だとエラーとする根拠は今のところありません。

    漢字連続長はこの印象に影響が無かったことから、漢字連続長を短くすることで「子ども向けの文章」という印象を与えず、先行研究で指摘される読みやすい文章が実現できると示唆された。 -- 日本心理学会第79回大会 漢字含有率と漢字連続長が文章の印象に与える影響

    漢字が連続しすぎない方が、読みやすさに繋がることは既存研究にて実証されています。

    おおまかに4文字と5文字に壁があり、そこにバッファをもたせて6文字以上は、デフォルトではエラーとしています。

    "漢字"の範囲としては日本語における漢字ではなく、CJK統合漢字を含めた漢字を"漢字"として扱っています。

    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

    Install

    npm i textlint-rule-max-kanji-continuous-len

    DownloadsWeekly Downloads

    5,028

    Version

    1.1.1

    License

    MIT

    Last publish

    Collaborators

    • hata6502
    • azu
    • shirayu
    • takahashim
    • textlint-user