textlint-rule-no-duplicated-bunmatsu-hyougen

    0.1.0 • Public • Published

    textlint-rule-no-duplicated-bunmatsu-hyougen

    Status: かなり実験的なtextlintルールです

    同じ文末表現が連続しているのを見つけるtextlintルール

    一つのパラグラフ内で、同じ文末表現が連続していると読みにくく感じるのを見つけるルールです。 パラグラフ内での連続性を見るので、パラグラフをまたいでの連続はカウントしません。

    文末表現とは、 助詞名詞*?(動詞|名詞)語尾?記号(。)のような文の末尾の塊を示しています。

    Aは問題を示しています。

    この文では "を示しています。" を文末表現として認識しています。

    次のような文では、"は問題です"という文末表現が連続しています。 どちらがメインの文であるかがわかりにくいので、まとめてもよいかもしれません。

    Aは問題です。 Bは問題です。

    つぎのような、文章は、"ためです。"という文末表現が連続しています。 "ためです。"と繰り返しある場合、そのパラグラフでのメインとなる主張がわかりにくくなります。

    NaNは暗黙的な型変換の中でももっとも避けたい値となります。
    理由として、先ほど紹介したようにNaNは何と演算しても結果がNaNとなってしまうためです。
    これにより、計算していた値がどこでNaNとなったのかが分かりにくく、デバッグが難しくなるためです。

    しかし、同じ文末表現が連続した方がリズムがよい場合もあります。

    そのため、only オプションを使い、チェックする文末表現を制限して利用することを推奨します。

    Install

    Install with npm:

    npm install textlint-rule-no-duplicated-bunmatsu-hyougen
    

    Usage

    Via .textlintrc(Recommended)

    {
        "rules": {
            "no-duplicated-bunmatsu-hyougen": true
        }
    }

    Via CLI

    textlint --rule no-duplicated-bunmatsu-hyougen README.md
    

    Options

    • only: string[]
      • デフォルトなし : 設定することを推奨
      • regexp-string-matcherを使った正規表現ライクな文字列指定も可能
    {
        "rules": {
            "no-duplicated-bunmatsu-hyougen": {
                // "があります。" と "~ためです。"という文末表現の連続しているのをチェックする
                // 他の文末表現の連続は無視される
                only: ["があります。", "/.*ためです。/"]
            }
        }
    }

    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-no-duplicated-bunmatsu-hyougen

    DownloadsWeekly Downloads

    1

    Version

    0.1.0

    License

    MIT

    Unpacked Size

    25.4 kB

    Total Files

    6

    Last publish

    Collaborators

    • azu