Clojure 開発に VSCode の Code Spell Checker を使う

VSCode で Clojure 開発を行っている人向け

背景

VSCode で Clojure 開発をしているなら Calva を使っていると思う。 Calva は clojure-lsp も使っており、 clojure-lsp には clj-kondo が入っている。 cljstyle も同様なので、デフォルトで clj-kondo の Lint と cljstyle による Format の恩恵を受けている。

しかし、静的な型付けがない Clojure ではちょっとしたスペルミスや Typo によるエラーでそれに気づかず時間を使ってしまうということがある（自分だけだったらごめんなさい）。 もちろん、静的な型付けのある言語でも Typo ではまることはあるので Clojure や動的型付けの言語に限った話ではまったくない。 Spec や Schema を使えばいいというのもそのとおりで、それで解決する部分もある。 ただ、すべてにしっかり Spec 書いてるかというとそんなことないはず。（自分だけだったらごめんなさい）

というわけでスペルチェックを入れた。

インストール

まずは エクステンションを VSCode にインストール。

• Code Spell Checker - Visual Studio Marketplace

設定

１．Clojure に対する有効化とグローバルなユーザ辞書ファイル

settings.json

{
// ...省略...

  // Clojure にも有効にする
  "cSpell.enableFiletypes": [
    "clojure"
  ],
  // .clj だけでなく Clojurescript などのファイルも対象にする。 .clj と同じ扱いになる。
  "cSpell.overrides": [
    {
      "filename": "**/{*.cljs,*.cljc,*.edn}",
      "languageId": "clj"
    }
  ],
  // 「Spell: Add Words to User Settings」コマンドで辞書に単語を追加するとここに追加されていく
  "cSpell.userWords": [
  ],
  // この settings.json 内に単語直接追加していくと邪魔なので、辞書を独立したファイルに分離する設定。パスやファイル名は好きにどうぞ。
  "cSpell.customUserDictionaries": [
    {
      "name": "Custom",
      "description": "My custom user dictionary",
      "path": "~/.config/cSpell/cSpellCustomUserDictionary.txt",
      "addWords": true
    }
  ]
}

defn や defmethod など、普通にビルトインのマクロや関数も怒られるのでがんがん辞書追加する必要がある。 辞書への追加はコマンドパレットから

Spell: Add Words to User Settings

でできるが、その場合 settings.json の cSpell.userWords にインラインで直接どんどん追加されていくので量が増えると邪魔。 なので cSpell.customUserDictionaries 設定を作って、

Spell: Add Words to User Dictionally

を使って単語の追加を行っていくことをおすすめします。

ここまでは、全ワークスペースに対して有効になるユーザ辞書の設定。

２．ワークスペース・オンリーの辞書ファイル

ワークスペース直下にワークスペース限定の設定を .vscode/settings.json として置くことができる。

.vscode/settings.json

{
  "cSpell.enableFiletypes": [
    "clojure"
  ],
  "cSpell.overrides": [
    {
      "filename": "**/{*.cljs,*.cljc,*.edn}",
      "languageId": "clj"
    }
  ],
  // Spell: Add Words to Workspace Settings」コマンドを使うとここに登録されていく。
  "cSpell.words": [
    "reitit" // <- 例
  ]
}

こんな感じにして、gitignore しないようにしておけば、チームで設定を共有することもできる。 さっきと同様にこの辞書を独立したファイルに分離することも設定可能。

defn とかビルトインの関数やマクロはグローバルなユーザ辞書でいいけど、ライブラリの名前やその関数やマクロはワークスペースの辞書に入れて分けるというやり方も考えられる。 そうしておくと、リポジトリを初めてチェックアウトしてきたときに辞書内の単語一覧を見ればどういったライブラリや関数が使わているのか一気に分かって面白い（ shadow-cljs.edn や project.clj を見ればだいたい同じだろ、というのはある）。 そこにはプロジェクトのユビキタス言語から Derive した特殊な英単語や変数名などが入ってくることもあり、そのプロジェクトの特徴をある側面から抽出した情報に見えて楽しい。

辞書の単語で１つづつループしてワークスペース内のソースコードすべてを grep し登場回数を数えて集計すると、さらに面白いよ。

また、辞書ファイルを git blame すると、このライブラリ（あるいは関数）を初めにこのリポジトリに導入したのは 〜〜 さんか、とかこの人はどんどん新しいものを取り入れているな、という傾向が分かってやっぱりなんだか楽しい。