VS CodeやZedでOxlintを使うとTypeScriptなどの開発ツールの応答性が低下する問題の対処法

症状の詳細

ZedにOxcの拡張機能をインストールしてOxlintの言語サーバーを有効化すると、コードを変更した際に次のような症状が発生しました。

• コードを変更してからOxlintの診断結果が更新されるまで異常に時間がかかる
• コードを変更してからTypeScript（typescript-ls）の診断結果が更新されるまで異常に時間がかかる
• しばらくコードを編集していると、言語サーバーを再起動するまでOxlintやTypeScriptの診断結果が更新されなくなる
• ターミナルで実行するVitestの処理に時間がかかるようになる

原因

調べた結果、これらの症状は実質的に1文字入力するごとにOxlintが新しいTypeScriptのプロセスを起動していることが原因でした。これにより、システムのリソースが圧迫されます。

これらの問題は、プロジェクトでtype-aware lintingが有効になっている場合で、コードエディター側で入力のたびにlinterが実行される設定になっている場合に発生します。

TypeScriptのプロセスを大量に起動してしまう問題は、Oxlintのtype-aware lintingが使用しているtsgolintの問題です。tsgolint側でもこの問題は認識しているようで、VS Codeでも同様の問題が発生するとの報告があります。

対処法

根本的な対策はtsgolintの修正を待つしかありませんが、一時的な回避策としてエディター側の設定を変更できます。

Zedの場合

Zedの場合は、診断にデバウンスを追加して診断の呼びだし頻度を減らす方法があります。デバウンスの最適な長さはPCのスペックによって変わりますが、筆者の環境では1,000msに設定しました。

キー入力を停止してから少なくとも1,000msは診断が更新されなくなりますが、デバウンスなしでは前述の問題で10秒以上診断が更新されないのでそれよりはよいと思います。

1
{
2
    "diagnostics": {
3
        "lsp_pull_diagnostics": {
4
            "debounce_ms": 1000
5
        }
6
    }
7
}

VS Codeの場合

VS Codeでは確認していませんが、VS Codeの場合はデバウンス設定がなく、"oxc.lint.run": "onSave"に設定して保存時にのみOxlintが走るようにするしかないようです。

1
{
2
    "oxc.lint.run": "onSave",
3
    // 自動保存を有効化している場合は自動保存にデバウンスが必要
4
    "files.autoSave": "afterDelay",
5
    "files.autoSaveDelay": 1000
6
}