【VSCode】「”xxxxxxxx”: Unknown word.」の警告から除外するキーワードを登録する方法

VSCodeのスペルチェック機能(cSpell)は非常に便利なのですが、辞書から外れた単語に対して全て「Unknown word.」と警告を出してきます。例えば、”yamadataro” という文字列を定義すると「”yamadataro”: Unknown word.」と警告されます。

特定の単語を cSpell のチェック対象外とするティップスです。

オススメのやり方

プロジェクトルート(VSCodeで開くディレクトリ)に「cspell.json」ファイルを作成します。そのファイルに”ignoreWords” キーに対して、除外するキーワードを定義します。

{
  "ignoreWords": ["yamadataro", "yamadahanako"]
}

これだけでプロジェクトに含まれる対象ワードの警告が全て消えます!

その他のやり方

VSCodeのワークスペース設定に記述する

ワークスペースの設定ファイルを既に作っている場合は、次の記述を行えば除外できます。

"cSpell.ignoreWords": ["yamadataro"]

チームでワークスペース設定ファイルを共有している場合はこれも良いですね。

ファイル毎に除外ワードを指定する

ファイルの最上部に次のようにコメントを入れることでcSpellの除外とすることもできます。

// cspell:ignore yamadataro

ロジックと関係ない記述を各ファイルに入れることになるので、個人的には好きではありません。

「Unknown word.」の警告を無視して開発されている方も多いと思いますが、この機会に全部の警告をやっつけましょう。

参考: Option to ignore words