なぜなぜ、あるある、よくよくなどの繰り返しの言葉を textlint で許可する

allow での指定方法

Posted on 2024年 5月 27日 (月)
Tags textlint

「なぜなぜ分析」や「あるあるだが」という単語が textlint で引っかかる

最近、ブログの校正のために textlint による CI/CD での自動チェックを導入した。 自分の書き方の癖に気づけて良いのだが、「あるあるの事象」「なぜなぜ分析をする」というような単語もデフォルトでは引っかかるようになってしまった。

引っかかるのは、ja-no-successive-word の rule だが、これは ja-technical-writing の中に含まれている。 下記の設定を .textlintrc.json にいれることで、「よくよく考えると」のような表現を許可できる。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

"rules": {
    "preset-ja-technical-writing": {
        "ja-no-successive-word": {
            "allow": [
                "なぜ",
                "よく",
                "ある"
            ]
        },
    }
}

このブログで設定している現段階の設定

色々ハマったところがあったので、参考までにこのブログのケースで適用している設定も載せておく。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

{
    "rules": {
        "no-todo": true,
        "preset-ja-technical-writing": {
            "sentence-length": false,
            "max-kanji-continuous-len": false,
            "max-comma": false,
            "max-ten": false,
            "no-exclamation-question-mark": false,
            "ja-no-weak-phrase": false,
            "ja-no-mixed-period": {
                "periodMark": "。",
                "allowPeriodMarks": [
                    "、",
                    "...",
                    "…",
                    "：",
                    ":"
                ],
                "allowEmojiAtEnd": false,
                "forceAppendPeriod": false
            },
            "ja-no-successive-word": {
                "allow": [
                    "なぜ",
                    "よく",
                    "ある"
                ]
            }
        },
        "spellcheck-tech-word": true
    },
    "filters": {
        "allowlist": {
            "allow": [
                "%",
                ".git",
                ".gitignore",
                "Activity",
                "Disk",
                "git",
                "IO",
                "scheme"
            ]
        }
    }
}

Share

GitHub で編集