typos を使って typo を見つける¶

typos とは¶

typosはスペルミスを検出するためのツール。オプションでスペルミスを修正することもできる。Rust で記述されており、高速なのが特徴。

インストール¶

1
2
3

cargo install typos-cli
# or
brew install typos-cli

使い方¶

オプションなしにtyposコマンドを実行すると、カレントディレクトリ次のファイルを検査する。

1

typos

--write-changesもしくは-wオプションを指定すると、スペルミスを修正できる。

1
2

typos --write-changes
typos -w

設定ファイル¶

誤検出を無視するためには設定ファイルを記述する。次のような名前で設定ファイルを作成する。

• .typos.toml
• typos.toml
• _typos.toml
• pyproject.toml

詳しい設定項目は公式ドキュメントに記載されているが、一例として html ファイルを無視する設定を示す。

1
2
3
4

[tool.typos.files]
extend-exclude = [
  "*.html",
]

行・ブロック単位での無視¶

行単位での無視は、正規表現を使って行う。次の例では、# spellchecker:disable-lineというコメントがある行の実行を無視する。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

[default]
extend-ignore-re = [
  "(?Rm)^.*#\\s*spellchecker:disable-line$",
]

行単位だけでなくブロック単位での無視も可能。

```toml
[default]
extend-ignore-re = [
  "#\\s*spellchecker:off\\s*\\n.*\\n\\s*#\\s*spellchecker:on"
]
```