textlint-rule-period-in-list-itemというtextlintのルールを書きました。

箇条書きの文末に。がついてたりついてなかったりするのを統一するためのルールです。 本文中の句点（。）の統一するルールは別途あります。

デフォルトの挙動

デフォルトは句点を付けないように統一します。 以前アンケートを取ってみたところ、箇条書きの文末に句点はつけない人のほうが多そうではありました。

(もちろんオプションで変更できます)

OK:

- 項目1
- 項目2
- [textlint](https://github.com/textlint/textlint "textlint")

NG:

- 項目1。
- 項目2.

という感じになります。

Install

npmを使ってインストールできます。

npm install textlint-rule-period-in-list-item

Usage

textlint 使い方などで検索してください。

Via .textlintrc(Recommended)

{
    "rules": {
        "period-in-list-item": true
    }
}

オプション

オプションは色々ありますが、句点をつけないひとはあんまり変更する必要がないはずです。 句点を付ける人は、periodMarkに利用する記号を指定してください。

例えば、periodMark: "。"とすれば、箇条書きの文末に。を付けることをチェックします。

文末に。を必須にした場合でも - 「OK」 は許可したいという場合は、allowPeriodMarksで設定できます。(!や?といった文末に来る可能性が高いものはデフォルトで入っていますが)

{
    // prefer to use period mark.
    // "" (default is no period)
    // You can select period mark like "." from "periodMarks".
    "periodMark": "",
    // Built-in recognized period mark list
    // if the period of the text is not `periodMark` and it is a string in the `periodMarks`,
    "periodMarks": [".", "。", "．"],
    // Ignore only link tag
    // - [text](link)
    // It is not needed period mark
    "ignoreLinkEnd": true,
    // allow exception period mark list at end of the list item
    // Ignore this period mark
    "allowPeriodMarks": [],
    // Allow emoji at end of the list item
    "allowEmoji": false,
    // If not exist `periodMark` at end of the list item
    // Automatically, append `periodMark` when does textlint --fix
    "forceAppendPeriod": false
}

句点をつけるように自動修正

このルールはtextlint --fixの自動修正にも対応しています。 句点を取り除く方は常に--fixで修正されますが、句点を付ける方はforceAppendPeriod:trueの時のみ有効です。 (エディタなどで保存ごとに--fixしたいという場合に問題になるため)

次の設定では、.が--fixをした時に自動で追加されます。

{
    "rules": {
        "period-in-list-item": {
           "periodMark": ".",
           "forceAppendPeriod": true
        }
    }
}

Before

- item

After

textlint --fixした結果

- item.

おわりに

箇条書きにおける句点の表記を統一するtextlintルールでした。 何か問題を見つけた場合次のリポジトリのIssueへ報告してください。

またGitterのtextlint-jaのチャットでも問題ないです。

Gitter

箇条書きに句点を付けるか付けないかの明確な根拠は探した感じよく分かりませんでした。 日本語だけじゃなくて英語でも人によっても違う感じだったので、何か興味深い資料があればおしらせください。