[VSCode] typoにお別れを。Code Spell Checkerのすゝめ
対象読者
- VSCode を使っている人
- 誤字・スペルミス・typo をしたことがある人
結論
VSCode の拡張機能であるCode Spell Checkerを入れましょう
Code Spell Checker は、VSCode 上での誤字・スペルミス・タイポなどを検知してくれる拡張機能です
単語ごとに判定しているので、副次的にキャメルケースの違反も検知してくれたり
迷いがちなusecaseとuseCaseなどもこれを基準に統一できます
これがあるだけで
- 誤字・スペルミス・typo を減らせる
- 不安な英単語のスペルを調べる手間が省ける
- キャメルケースの基準になり、違反を検知してくれる
などなど、格段に開発効率が上がります
こういったミスは沼にハマると自分だけでは気付きづらく、多くの時間を無駄にしてしまいがちです
また、チーム全体で導入していればレビュワーとしても typo を気にせずにより本質的な部分にフォーカスできます
使い方
基本的にはインストールするだけで使えます
メジャーなライブラリ名などは元から辞書に登録されているので、それらの単語は検知されません
ただし、辞書にないライブラリの単語や、専門的な単語は検知されることがあります。
その場合には自分の VSCode の設定かプロジェクトの.vscode/settings.jsonで無視する単語を設定することができます
{
"cSpell.ignoreWords": ["konva", "hono"]
}
ある程度無視する単語を設定して
その他の「正しいが検知されてしまう単語」は気にしないくらいの運用がコスパがいいと思います
あまり厳密にやりすぎると、辛くなるかもしれません
慣れてくると青線を無視するポイントと気にするポイントが自然にわかるようになります
最後に
私はこの Code Spell Checker は linter や静的型検査の一歩手前の重要なものだと思っています
最近だとbiomeでも命名規則の違反は検知てくれるっぽいですが、それでもこの拡張機能は非常に重宝しています
開発だけじゃなくて大学のテストでも役に立っています
単純なミスを減らして快適な開発環墺を整えることができるので、ぜひ導入してみてください
最後まで読んでいただきありがとうございました！
PS: Twitter やってます！ぜひフォローしてください！
Discussion