textlint-rule-ja-indent-paragraph

日本語の段落字下げをチェックするtextlintルールです。

Install

npm install @k1low/textlint-rule-ja-indent-paragraph

Usage

Via .textlintrc:

{
    "rules": {
        "@k1low/ja-indent-paragraph": true
    }
}

Options

{
    "rules": {
        "@k1low/ja-indent-paragraph": {
            "indentChar": "　",
            "indentSize": 1,
            "allowedStartChars": ["「", "『", "【", "〈", "《", "（", "(", "\"", "'", "―", "…"],
            "ignoreNodeTypes": ["BlockQuote", "Link", "Code", "Header", "ListItem"],
            "checkEachLine": false
        }
    }
}

indentChar

字下げに使用する文字を指定します。

• Type: string
• Default: "　" (全角スペース)

indentSize

字下げ文字の数を指定します。

• Type: number
• Default: 1

allowedStartChars

字下げなしで開始できる文字のリストを指定します。 これらの文字で始まる段落は、字下げがなくてもエラーになりません。

• Type: string[]
• Default: ["「", "『", "【", "〈", "《", "（", "(", "\"", "'", "―", "…"]

ignoreNodeTypes

無視するノードタイプを指定します。 これらのノード内の段落はチェックされません。

• Type: string[]
• Default: ["BlockQuote", "Link", "Code", "Header", "ListItem"]

checkEachLine

段落内の各行をチェックするかどうかを指定します。 true にすると、GFMスタイルの改行（段落内での改行）にも対応し、各行の先頭に字下げがあるかチェックします。

• Type: boolean
• Default: false

Example

Input

これは字下げのない段落です。

　これは正しく字下げされた段落です。

「これは括弧で始まる段落です。」

Output

1:1  error  段落の先頭に字下げ（1文字の全角スペース）がありません。  @k1low/ja-indent-paragraph

Fixable

このルールは --fix オプションで自動修正できます。

textlint --fix README.md

License

MIT