VSCodeにCode Spell Checkerを入れて、typoを防ぐ

VSCodeにCode Spell Checkerを入れて、typoを防ぐ

コードレビューをするとき、受けるときにスペルミス(typo)があると、コードレビューの手間が増えます。自分もよく見たつもりなのに、PRした後に気づいて直したことは数知れず。typoを指摘するのもされるのも結構、心苦しいものです。

バグの原因にもなりますので、PRする前に防ぎたい!そんなレビュアー、レビューイ双方の手間を減らしてくれるプラグインがVSCodeにはありました。

VSCodeにCode Spell Checkerを入れる

Code Spell Checkerというプラグインを入れると、スペルミスしている単語を波線で教えてくれます。英語以外にも、いろんな言語でチェックできるみたいです。

こんな感じで、波線でスペルミスしている箇所を教えてくれます。便利!

ホワイトリストの登録方法

ローマ字や特定の単語を使いたいときは、あらかじめホワイトリストに単語を登録することが可能です。

コマンドパレット or 右クリックで登録する方法

command + shift + P でコマンドパレットを開く or 登録したい単語を選択して右クリックで選びます。この方法だと、自動的にユーザーのsettings.json または ワークスペースのsettings.json に単語が書き込まれます。

ユーザー単位で登録する場合(ワークスペースをまたがってユーザー単位で単語登録を行う)

コマンドパレットを開く or 単語選択→右クリックで、Add Word to User Dictionary または Add Word to User Settingsを選択

ワークスペース単位で登録する場合(ワークスペース内でのみ単語登録を行う)

コマンドパレットを開く or 単語選択→右クリックで、Add Word to Workspace Dictionary または Add Word to Workspace Settings を選択

登録するか聞かれるので、登録する場合はEnter,やめる場合はEscapeを押します。

コマンドパレットの場合:

右クリックの場合:

setting.jsonに記述する方法

VSCodeのsetting.json を開きます。
setting.json内に "cSpell.userWords" を追加し、その中にホワイトリストに登録したい単語を記載します。

"cSpell.userWords":
[
  "tatistuteto","naninuneno",
]

登録した単語の削除&settings.jsonの開き方

登録した単語をやっぱり消したいな、ってときはユーザーのsettings.json または ワークスペースのsttings.jsonを開いて、削除します。

ユーザーのsettings.jsonの開き方

ユーザーのsettings.jsonの開き方:コマンドパレットに >open settings json と打ち込む → 基本設定: 設定 (JSON) を開く を選択すると表示されます。

ワークスペースのsettings.jsonの開き方

ワークスペースのsettings.jsonの開き方 :コマンドパレットに >open settings json と打ち込む → 基本設定: ワークスペース設定を開く (JSON) を選択すると表示されます。

終わりに

以上、とても便利なスペルチェックのプラグイン、Code Spell Checkerの導入方法、ホワイトリストの登録方法をご紹介しました。コードレビューの手間を減らせるので、ぜひ使ってみてください!

まい

フロントエンドエンジニア目指して、勉強中です。

VSCodeカテゴリの最新記事