Skip to content

VS Code拡張機能

TIP

このページは、Oxc VS Code拡張機能への貢献に関するものです。 拡張機能のダウンロードについては、Visual Studio Marketplace または Open VSX Registry をご参照ください。

開発

oxc-vscode リポジトリをクローンし、pnpm install を実行してください。

拡張機能のローカルビルドと実行

Oxc VS Code拡張機能の変更を実行およびテストするには、2つの方法があります。

コマンドライン経由:

  • pnpm build を実行して、VS Code拡張機能をコンパイルし、言語サーバーのリリース版をビルドします。
  • pnpm install-extension を実行して、拡張機能をVS Codeにインストールします。
  • Ctrl + Shift + P を押して、「Developer: Reload Window」を検索します。
  • これで、VS Code内で手動で変更内容をテストできるようになります。

VS Code自体経由:

  • エディタ左側のサイドバーにある「Run and Debug」タブを開きます。
  • Launch VS Code Extension の構成を選択します。
  • 一番上の緑色の再生ボタンをクリックします。
  • これにより、VS Code拡張機能がビルドされ、新しくビルドされた拡張機能がインストールされた新しいVS Codeウィンドウが起動します。

oxlint/oxfmt の未公開バージョンのテスト

oxcプロジェクトで以下のコマンドでプロジェクトをビルドします:

bash
cd apps/oxlint && pnpm build-test
cd ../oxfmt && pnpm build-test

その後、settings.json の拡張機能設定を通じて、ローカルビルドを使用するようにVS Code拡張機能を設定します:

json
{
  "oxc.path.oxlint": "/path/to/oxc/apps/oxlint/dist/cli.js",
  "oxc.path.oxfmt": "/path/to/oxc/apps/oxfmt/dist/cli.js"
}

出力チャンネルの利用

拡張機能や言語サーバーの動作状況を確認するには、VS CodeのOxc出力チャンネルを使用してください。 さらに詳細な情報を得るには、settings.json で以下の拡張機能設定を有効にします:

json
{
  "oxc.trace.server": "verbose"
}

oxlint/oxfmt 用の言語サーバー統合(たとえば、oxc_language_server クレート)では、info! または error! マクロを使用して、メッセージをVS CodeのOxc出力チャンネルに送信できます。

テストの作成

変更内容に応じて、テストを作成する必要があります。 テストは、VS Code固有のものである場合にのみ、VS Code拡張機能内に記述してください。 ツールとのLSP通信に関するテストは、oxlint/oxfmt またはRustクレート oxc_language_server に追加してください。

例:

  • VS Code: ステータスバーの変更
  • oxlint: 返された診断情報 / コードアクション
  • oxc_language_server: ワークスペースの問題