これはなに
個人的textlint設定メモ。 いろいろなところで環境を作るときにいちいち調べなおすのが面倒になったため、メモを残しておく。
結論
npm install -g --save-dev textlint- 下記のtextlintルールをすべて入れる2
npm install -g --save-dev textlint-rule-preset-ja-technical-writing textlint-rule-no-mixed-zenkaku-and-hankaku-alphabet textlint-rule-prefer-tari-tari @textlint-ja/textlint-rule-no-insert-dropping-sa textlint-rule-ja-no-orthographic-variants textlint-rule-preset-ja-spacing textlint-rule-ja-no-inappropriate-words @textlint-ja/textlint-rule-no-dropping-i @textlint-ja/textlint-rule-no-insert-re textlint-rule-no-doubled-conjunction textlint-rule-ja-hiragana-keishikimeishi textlint-rule-ja-hiragana-fukushi textlint-rule-ja-hiragana-hojodoushi @textlint-ja/textlint-rule-no-synonyms sudachi-synonyms-dictionary textlint-rule-no-todo textlint-rule-no-hoso-kinshi-yogo- 「まさしく」と「ただしく」の誤認識対策のため、
fukushi.ymlをコピーしてローカルに配置し、「まさしく」の項をコメントアウトする .textlintrcを作る。fukushi.ymlへのパスは前項で作成したものを指すようにする。
{
"filters": {},
"rules": {
"preset-ja-technical-writing": true,
"no-mixed-zenkaku-and-hankaku-alphabet": true,
"prefer-tari-tari": true,
"@textlint-ja/textlint-rule-no-insert-dropping-sa": true,
"ja-no-orthographic-variants": true,
"preset-ja-spacing": true,
"ja-no-inappropriate-words": true,
"@textlint-ja/textlint-rule-no-dropping-i": true,
"@textlint-ja/textlint-rule-no-insert-re": true,
"no-doubled-conjunction": true,
"ja-hiragana-keishikimeishi": true,
"ja-hiragana-fukushi": {
"rulePath": "./fukushi.yml"
},
"ja-hiragana-hojodoushi": true,
"@textlint-ja/no-synonyms": true,
"no-todo": true,
"no-hoso-kinshi-yogo": true
}
}- 動作を確認する
入れているtextlint ruleの紹介
個人的に日本語文書の執筆に必要を思ったものを入れている。 ほとんどは技術文書向けだが、一部メールのドラフト用に入れているものもある。
textlint-rule-preset-ja-technical-writing
技術文書向けのtextlintルールプリセット。 複数のルールが1つになっている。 詳細はリンク先のREADMEを参照のこと。 厳しめの内容だが、とりあえず入れておいていいと思っている。
textlint-rule-no-mixed-zenkaku-and-hankaku-alphabet
全角アルファベットをチェックするtextlintルール。 全角アルファベットを使う機会は全くないため入れている。
textlint-rule-prefer-tari-tari
「～たり」をきちんと2回連続で使っているかチェックするtextlintルール。 正しい日本語を使う手助けをしてくれる。
textlint-rule-no-insert-dropping-sa
さ抜き、さ入れ言葉をチェックするtextlintルール。 違反することは全くといっていいほどないが、念のため入れている。
textlint-rule-ja-no-orthographic-variants
表記ゆれをチェックするtextlintルール。 ひらがな/漢字の表記ゆれや略語の表記ゆれをチェックしてくれる。便利。
textlint-rule-preset-ja-spacing
スペース関連のtextlintルール。 複数のルールが定義されているため、詳細はリンク先のREADMEを参照のこと。 たとえば、半角文字と全角文字の間にスペースを入れていないか確認できる（筆者は入れない派だが、入れる派のチェックもできる）。
textlint-rule-ja-no-inappropriate-words
不適切表現をチェックするtextlintルール。 引っ掛かることはないが、安心を得るために入れている。
textlint-rule-no-dropping-i
い抜き言葉をチェックするtextlintルール。 い抜き言葉を文書では使いたくないスタンスなので。 大変助かっている。
textlint-rule-no-insert-re
れ足す言葉をチェックするtextlintルール。 違反することは全くといっていいほどないが、念のため入れている。
textlint-rule-no-doubled-conjunction
同じ接続詞が連続していないかチェックするtextlintルール。 まれに油断して「しかし」を連続して使ってしまうことがあるため入れている。 とくに長い文章を短くしたときに引っ掛かりやすい。
textlint-rule-ja-hiragana-keishikimeishi
ひらがなのほうが読みやすい形式名詞を自動修正してくれるtextlintルール。 「～するほう」とか「～するとき」とかを検出/修正してくれる。
textlint-rule-ja-hiragana-fukushi
ひらがなのほうが読みやすい副詞を自動修正してくれるtextlintルール。 ただし、「まさしく」は「ただしく」にも引っかかってしまうことが多いため、その部分だけ個人的に無効化している。
textlint-rule-ja-hiragana-hojodoushi
ひらがなのほうが読みやすい補助動詞を自動修正してくれるtextlintルール。 技術文書で引っ掛かることはないが、メールだと引っ掛かりやすい。
@textlint-ja/textlint-rule-no-synonyms
同義語の表記ゆれをチェックしてくれるtextlintルール。 最後に伸ばし棒を入れたり入れなかったりが揺れやすいため助かっている。
textlint-rule-no-todo
TODOがないかチェックしてくれるtextlintルール。
公開する文書にTODOはないはずなので入れている。
textlint-rule-no-hoso-kinshi-yogo
放送禁止用語をチェックするtextlintルール。 引っ掛かることはないが、安心を得るために入れている。