textlint-rule-ja-no-mixed-period

    2.1.1 • Public • Published

    textlint-rule-ja-no-mixed-period Build Status Gitter

    文末の句点(。)の統一 OR 抜けをチェックするtextlintルール

    OK: これは問題ない文章です。
    NG: これは問題ある文章です
    

    パラグラフの末尾に必ず句点記号を付けていることをチェックするルールです。

    関連ルール

    Install

    Install with npm:

    npm install textlint-rule-ja-no-mixed-period
    

    Usage

    Via .textlintrc(Recommended)

    {
        "rules": {
            "ja-no-mixed-period": true
        }
    }

    Via CLI

    textlint --rule ja-no-mixed-period README.md
    

    Examples

    OK:

    これは問題ないです。
    末尾に感嘆符はある!
    「これはセリフ」
    english only
    - 箇条書きは無視される
    

    NG:

    これは句点がありません
    末尾にスペースがある。           
    絵文字が末尾にある。😆
    

    Options

    • periodMark: string:
      • 文末に使用する句点文字
      • デフォルト: "。"
    • allowPeriodMarks: string[]
      • 句点文字として許可する文字列の配列
      • 例外として許可したい文字列を設定する
      • periodMarkに指定したものは自動的に許可リストに加わる
      • デフォルトは空 []
    • allowEmojiAtEnd: boolean
      • 絵文字を末尾に置くことを許可するかどうか
      • デフォルト: false
    • forceAppendPeriod: boolean
      • 句点で終わって無い場合にperiodMarkを--fix時に追加するかどうか
      • デフォルト: false
    {
        "rules": {
            "ja-no-mixed-period": {
                 // 
                 "periodMark": "",
                 // 
                 "allowPeriodMarks": [],
                 // 
                 "allowEmojiAtEnd": false,
                 // `periodMark`--fix
                 "forceAppendPeriod": false
            }
        }
    }

    例外

    会話文/疑問文

    末尾にがない場合でも、代わりに感嘆符や疑問符、括弧などがある場合は例外として扱います。

    これは問題ない文章ですか!?

    「会話文は括弧で括れば末尾に。がなくても問題ありません」

    箇条書き

    箇条書きの中はチェックせず無視します。

    - これは問題ないです
    - これも問題ないです
    

    箇条書き間のの有無の統一については次のルールを参照してください。

    日本語ではない

    日本語が含まれていないパラグラフは無視します。

    参考情報

    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-ja-no-mixed-period

    DownloadsWeekly Downloads

    3,956

    Version

    2.1.1

    License

    MIT

    Unpacked Size

    35.3 kB

    Total Files

    8

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar