MyDocs

# textlintの設定を見直した

最終的な .textlintrc は以下の通り。

{
  "filters": {
    "allowlist": {
      "allow": [
        "\"{ register } で指定."
      ]
    }
  },
  "rules": {
    "textlint-rule-preset-ja-spacing": {
      "ja-space-between-half-and-full-width": {
        "space": "always"
      },
      "ja-space-around-code": {
        "before": true,
        "after": true
      }
    },
    "textlint-rule-preset-ja-technical-writing": {
      "sentence-length": {
        "max": 90
      },
      "ja-no-mixed-period": {
        "periodMark": "."
      },
      "no-exclamation-question-mark": false
    }
  }
}

上から見ていく。

filters

textlint-filter-rule-allowlist のインストールが必要。

  "filters": {
    "allowlist": {
      "allow": [
        "\"{ register } で指定."
      ]
    }
  },

allow のリストに error を無視する文字列や文章を入れることで、対象を無視する。

rules

今回は下記 2 つのプリセットをインストールした。

textlint-rule-preset-ja-spacing

半角文字と全角文字の間にスペースを入れるか指定できる。 デフォルトは never ( スペースを入れない )

インラインコードの前後にスペースを入れるか指定できる。 デフォルトは false ( スペースを入れない )

textlint-rule-preset-ja-technical-writing

1 文の長さ。 デフォルトは 100 。

文末の句点のチェック。

?!?! を許可しない。