【勉強記録】Code Spell Checkerを導入してみた

はじめに

こんにちは。アメリカで独学でエンジニアを目指している者です。
この記事を読んでいる皆さまの中に、エラーが発生して30分くらい格闘してその原因がタイポだった何てこと今までに一回は経験したことあるのではないでしょうか。
そこで今回は、VScodeの拡張機能である code spell checkerについて紹介していきたいと思います

VSCodeのCode Spell Checker拡張機能とは

コードを書くときに気になるのがスペルミスや誤字脱字。VSCodeにはさまざまな拡張機能がありますが、その中でも手軽に導入できて効果的なのがCode Spell Checkerです。Code Spell Checkerは、名前の通りプログラミング中のスペルミスや単語の誤りを検知し、ハイライトして指摘してくれる拡張機能です。

Code Spell Checkerの主な特徴

1. プログラミング言語のキーワードに干渉しない

   • 一般的なスペルチェッカーとは異なり、プログラミング言語特有の単語や関数名を柔軟に扱います。誤判定が少ないのが強みです。

2. ハイライト表示で簡単に誤字を発見

   • ミスがある単語は波線などで強調表示されるため、一目で誤字を検知できます。

3. 辞書の拡張が可能

   • しばしば使う専門用語やカスタムワードは、ユーザー辞書に追加して誤判定を防げます。例えばプロジェクト名や命名規則にも対応しやすいです。

4. 複数言語のサポート

   • 英語だけでなく、複数の言語辞書を導入可能。国際化されたドキュメントを扱う際に便利です。

---

インストール方法

1. VSCodeを起動し、左のサイドバーから拡張機能パネル（Extensions）をクリックします。
2. 検索バーでCode Spell Checkerと入力して拡張機能を検索します。
3. Code Spell Checker (by Street Side Software)が表示されたら「Install」ボタンをクリックします。
4. インストール完了後、VSCodeを再起動するか、もしくはタブを閉じて再度開くと拡張機能が有効になります。

---

使い方の基本

1. コードを書くと自動でチェック

   • インストール後は、コーディングをするだけで誤字をハイライトしてくれます。

2. 誤検知を除外する

   • 特定の単語に波線が表示されてしまう場合は、Add Word to Settingsなどのアクションから辞書に登録し、次回以降は誤判定されないように設定できます。

3. 設定ファイルでの管理

   • .vscode/settings.jsonやVSCodeのSettingsで拡張機能ごとの設定をカスタマイズできます。英語以外の辞書を追加したい場合や、プロジェクトごとに単語を登録したい場合に便利です。

4. ショートカットでの修正

   • ミスが指摘された単語上でCtrlと.（Macの場合はCmdと.）を押すことで、修正候補や辞書への登録をおこなえます。

なお、3.4について詳しく書いてある記事を見つけたので、具体的な保存方法は以下をご確認ください

---

使ってみての感想

ここからは実際にCode Spell Checkerを使ってみて気づいたことをまとめてみました

• 英語だけしかチェックされない
  spellと書いてあるから当たり前だろと思うかもしれませんが、Qiitaで記事を書いているときふと気づいたことです。余談ですがQiitaという文字は誤字判定されます。

• プログラミング以外にも英語を書く際にも使用できる
  これは私が英語の記事を投稿しているのにも起因しますが、英語を書くことでスペルチェックしてくれるのはありがたいです。

• ターミナルにspell checkerという欄がありそこでスペルミスだと思われる言葉が確認できる
  この拡張機能はタイポした時点でその間違いだと思われる単語に青い波下線が引かれるのですが色だけでは視覚的に見落とすことも。
  ですが、これを使用すれば一覧で見れるので見落とすリスクをかなり下げることができて便利だと感じました

---

まとめ

VSCodeのCode Spell Checkerは、誤字脱字を素早く発見できる便利な拡張機能です。
ログラミングでの誤字はバグや可読性低下の原因になることも多く、普段から気をつけていても意外と見落としがちです。
Code Spell Checkerを活用すれば、開発効率を維持しながらコードの品質を向上させられます。

ちなみにこの機能を知ったのは以下の記事を読んででした。ほかにもツールが36個もあるようなので使いたいものがあればぜひ使ってみてください