cSpell で特定のファイルやパスをスペルチェック非対象にする

こんにちは、ビジネステクノロジー部の若槻です。

cSpell を使うと、Node.js 環境にコードのスペルチェッカーを導入することができます。

今回は、cSpell で特定のファイルやパスをスペルチェック非対象にする方法を確認してみました。

cSpell の導入

cSpell は npm でインストールできます。

npm install --save-dev cspell@latest

特定のファイルやパスをスペルチェック非対象にする

cspell.json ファイルが未作成の場合は作成します。

touch cspell.json

ignorePaths フィールドに、スペルチェック非対象にしたいファイルやパスを指定します。

{
  "ignorePaths": [
    "aaa.ts",
    "ccc/*"
  ]
}

動作確認

スペルミスのある文章を含んだファイルを動作確認用に作成します。

echo "// Hello Wrold!" > aaa.ts
echo "// Hello Wrold!" > bbb.ts
mkdir ccc
echo "// Hello Wrold!" > ccc/ddd.ts

cspell コマンドを実行してスペルチェックを行うと、ignorePaths に指定したファイルやパスをスペルチェック対象外とさせられました。

$ npx cspell '**/*.{ts,json}'
 1/1 ./bbb.ts 170.79ms X
./bbb.ts:1:10 - Unknown word (Wrold)
-------------------------------------------
Issues found:
./bbb.ts:1:10 - Unknown word (Wrold)
CSpell: Files checked: 1, Issues found: 1 in 1 files.

ignorePaths が無い場合

cSpell.json から ignorePaths を削除した場合、スペルミスがあるすべてのファイルがスペルチェック対象となりました。

$ npx cspell '**/*.{ts,json}'
 1/77 ./aaa.ts 169.74ms X
./aaa.ts:1:10 - Unknown word (Wrold)
 2/77 ./bbb.ts 2.66ms X
./bbb.ts:1:10 - Unknown word (Wrold)
 3/77 ./ccc/ddd.ts 0.72ms X
./ccc/ddd.ts:1:10 - Unknown word (Wrold)
-------------------------------------------
Issues found:
./aaa.ts:1:10 - Unknown word (Wrold)
./bbb.ts:1:10 - Unknown word (Wrold)
./ccc/ddd.ts:1:10 - Unknown word (Wrold)
CSpell: Files checked: 3, Issues found: 3 in 3 files.

おわりに

cSpell で特定のファイルやパスをスペルチェック非対象にする方法を確認しました。

独自の用語が多く含まれるファイルや、機密情報を含むコンフィグファイルなど、スペルチェック対象外にしたいファイルがある場合は、ignorePaths を活用してみてください。

以上