textlint-rule-preset-track
Install
Install with npm:
npm install textlint textlint-rule-preset-track --save-dev
Usage
Via .textlintrc(Recommended)
{
"rules": {
"preset-track": true
}
}Via CLI
textlint --preset track README.md
ルール一覧
- 1文の長さは90文字以下とする
- コンマは1文中に3つまで
- 読点は1文中に3つまで
- 連続できる最大の漢字長は6文字まで
- 全角数字を使用しない
- 漢数字と算用数字を使い分けます
- 日付と曜日が矛盾していないかチェックする
- よくある英語のスペルミスをチェックする
- 「ですます調」、「である調」を統一します
- 文末の句点記号として「。」を使います
- 二重否定は使用しない
- ら抜き言葉を使用しない
- 逆接の接続助詞「が」を連続して使用しない
- 同じ接続詞を連続して使用しない
- 同じ助詞を連続して使用しない
- UTF8-MAC 濁点を使用しない
- TODOマークを残さない
- 無効な制御文字を使用しない
- 括弧やクォーテーションなどの記号のペアの整合性をチェックする
- 全角と半角アルファベットを混在させない
- サ抜き、サ入れ表現の誤用をチェックする
- 感嘆符!！、疑問符?？を使用しない
- 半角カナを使用しない
- 弱い日本語表現を使用しない
- 同一の単語を間違えて連続しているのをチェックする
- よくある日本語の誤用をチェックする
- 不自然なアルファベットを検知する
- 「〜たり〜たりする」をチェックする
- 専門用語のスペルをチェックする
- テクニカルワードをチェックする
- 表記ゆれをチェックする
1文の長さは90文字以下とする
長過ぎる文は読みにくさに繋がるため、適切な単位で文を区切ってください。
"sentence-length": {
max: 90
},
コンマは1文中に3つまで
カンマ（,）の多用は、文が長くなっている可能性があります。
"max-comma": {
max: 3
},
読点は1文中に3つまで
読点（、）の多用は、文が長くなっている可能性があります。
"max-ten": {
max: 3
},
連続できる最大の漢字長は6文字まで
https://github.com/azu/textlint-rule-max-kanji-continuous-len
漢字同士が連続していると読みにくさにつながります。
固有名詞は allow オプションに記述して回避します。
"max-kanji-continuous-len": {
max: 6
},
全角数字を使用しない
https://github.com/azu/textlint-rule-preset-JTF-style https://www.jtf.jp/jp/style_guide/styleguide_top.html
"no-zenkaku-numbers": true,
漢数字と算用数字を使い分けます
https://github.com/azu/textlint-rule-preset-JTF-style https://www.jtf.jp/jp/style_guide/styleguide_top.html
数量を表現し、数を数えられるものは算用数字を使用します。 任意の数に置き換えても通用する語句がこれに該当します。 序数詞（「第～回」「～番目」「～回目」）も算用数字を使います。 慣用的表現、熟語、概数、固有名詞、副詞など、漢数字を使用することが一般的な語句では漢数字を使います。
"arabic-kanji-numbers": true,
日付と曜日が矛盾していないかチェックする
"date-weekday-mismatch": true,
よくある英語のスペルミスをチェックする
https://github.com/io-monad/textlint-rule-common-misspellings
"common-misspellings": true,
「ですます調」、「である調」を統一します
- 見出しは自動
- 本文はですます調
- 箇条書きはである調 文体は見出し、本文、箇条書きの中では統一した表記にします。
"no-mix-dearu-desumasu": {
"preferInHeader": "",
"preferInBody": "ですます",
"preferInList": "である",
"strict": false
},
文末の句点記号として「。」を使います
https://github.com/textlint-ja/textlint-rule-ja-no-mixed-period
文末には「。」を使い文を区切ります。 「。」のつけ忘れのチェックや「:」で文を区切らないようにします。
"ja-no-mixed-period": {
"periodMark": "。",
"forceAppendPeriod": true
},
二重否定は使用しない
"no-double-negative-ja": true,
ら抜き言葉を使用しない
"no-dropping-the-ra": true,
逆接の接続助詞「が」を連続して使用しない
https://github.com/takahashim/textlint-rule-no-doubled-conjunctive-particle-ga
逆接の接続助詞「が」は、特に否定の意味ではなくても安易に使われてしまいがちです。 同一文中に複数回出現していないかどうかをチェックします。
"no-doubled-conjunctive-particle-ga": true,
同じ接続詞を連続して使用しない
https://github.com/takahashim/textlint-rule-no-doubled-conjunction
"no-doubled-conjunction": true,
同じ助詞を連続して使用しない
"no-doubled-joshi": {
"min_interval": 1
},
UTF8-MAC 濁点を使用しない
文章中にUTF8-MAC 濁点は不要です。 ファイルからコピー＆ペーストした文字である場合があります。
"no-nfd": true,
TODOマークを残さない
"no-todo": true,
無効な制御文字を使用しない
https://github.com/textlint-rule/textlint-rule-no-invalid-control-character
"no-invalid-control-character": true,
括弧やクォーテーションなどの記号のペアの整合性をチェックする
https://github.com/textlint-rule/textlint-rule-no-unmatched-pair
"no-unmatched-pair": true,
全角と半角アルファベットを混在させない
https://github.com/textlint-ja/textlint-rule-no-mixed-zenkaku-and-hankaku-alphabet
"no-mixed-zenkaku-and-hankaku-alphabet": {
"prefer": "半角"
},
サ抜き、サ入れ表現の誤用をチェックする
https://github.com/textlint-ja/textlint-rule-no-insert-dropping-sa
"no-insert-dropping-sa": true,
感嘆符!！、疑問符?？を使用しない
https://github.com/azu/textlint-rule-no-exclamation-question-mark
特定の感嘆符または感嘆符を使用する場合は、オプションで許可して利用してください。
"no-exclamation-question-mark": {
// allow to use !
"allowHalfWidthExclamation": false,
// allow to use ！
"allowFullWidthExclamation": true,
// allow to use ?
"allowHalfWidthQuestion": false,
// allow to use ？
"allowFullWidthQuestion": true
},
半角カナを使用しない
"no-hankaku-kana": true,
弱い日本語表現を使用しない
https://github.com/textlint-ja/textlint-rule-ja-no-weak-phrase
〜かもしれない 等の弱い表現を使用しない
"ja-no-weak-phrase": true,
同一の単語を間違えて連続しているのをチェックする
https://github.com/textlint-ja/textlint-rule-ja-no-successive-word
同一の単語(形態素解析したtoken)が連続している場合は誤字の可能性があります。 誤字でない場合は、Issue報告してください。
"ja-no-successive-word": true,
よくある日本語の誤用をチェックする
日本語や技術表現における漢字の誤用などをチェックするルールです。
"ja-no-abusage": true,
不自然なアルファベットを検知する
https://github.com/textlint-ja/textlint-rule-ja-unnatural-alphabet
"ja-unnatural-alphabet": true,
「〜たり〜たりする」をチェックする
https://github.com/textlint-ja/textlint-rule-prefer-tari-tari
"prefer-tari-tari": true,
専門用語のスペルをチェックする
"terminology": true,
テクニカルワードをチェックする
WEB+DB PRESS用語統一ルールやJavaScript関連の用語などを含んだテクニカルワードをチェックするルールです。
"spellcheck-tech-word": true,
表記ゆれをチェックする
表記ゆれをチェックするルールです。
"prh": {
"rulePaths": [
path.join(__dirname, "prh.yml")
]
}
Contribution
-
README.mdを更新する際は、/script/README_template.mdを編集し、npm run docsを実行して自動生成してください（README.mdは直接編集しないでください）。