Visual Studio Code

Code とは、Microsoft によって開発されているクロスプラットフォームのテキストエディタで、Electron フレームワーク上でビルドされています。Visual Studio Code は、MIT ライセンス Code - OSS リポジトリの1つのバイナリディストリビューションで、Microsoft 特有のカスタマイズがなされており、プロプライエタリライセンスのもとでリリースされています。この混合ライセンスに関する詳細は、この GitHub コメントを見てください。また、MIT ライセンスの VSCodium というバイナリリリースもあり、これはコミュニティで運営されていて、テレメトリ がデフォルトで無効化されています。

インストール

Visual Studio Code は以下のフレーバが提供されています:

• Code - OSS — 公式の Arch Linux オープンソースリリース。Open VSX を有効化する設定が同梱されています。

https://github.com/microsoft/vscode || code, code-git^AUR

• Visual Studio Code — プロプライエタリな Microsoft ブランドのリリース。

https://code.visualstudio.com/ || visual-studio-code-bin^AUR, visual-studio-code-insiders-bin^AUR

• VSCodium — コミュニティのオープンソースリリース。ソースコード内でテレメトリが無効化されており [1]、Open VSX の設定も同梱されています。

https://vscodium.com/ || vscodium^AUR, vscodium-bin^AUR, vscodium-git^AUR, vscodium-electron^AUR

これらの異なるフレーバはすべて Code - OSS リポジトリからビルドされていますが、ライセンスとデフォルトの設定が異なっています。特に、プロプライエタリなビルドだけが、Microsoft の marketplace 使用と (OmniSharp C# Debugger などの) Microsoft のプロプライエタリな拡張機能の使用を許可されています。後者はハンドシェイク機構によって強制されており、迂回することはできません。"Visual Studio Code" ブランドのオープンソースビルドとプロプライエタリビルドの違いに関する詳細は、Code - OSS GitHub wiki を見てください。

拡張機能のサポート

Code の主な強みの1つとして、柔軟な API と Visual Studio Marketplace 上でホストされていますリッチな拡張エコシステムがあります。しかし、marketpace の利用規約は Microsoft ブランドのリリースのみでの使用を許可しています。そのため、Code - OSS source には、設定済みの marketplace が含まれていません。上記のオープンソースのリリースは、Open VSIX 拡張レジストリを追加しますが、拡張機能の数は劣ります。この制限を回避することは可能です。

警告: Microsoft はこの問題に直接コメントしてはいませんが、ノンブランドの Code ビルドは、利用規約で定められている "In-Scope Products and Services" (「対象の製品とサービス」)に含まれないと合理的に結論づけることができます。つまり、この行為は marketplace によって許可されていません。FS#67780 も参照してください。

既知の回避策は:

• .vsix ファイルから手動で拡張機能をインストールする。.vsix ファイルは Microsoft Visual Studio Code Marketplace から入手できます。
• 拡張機能のメンテナに拡張機能を Open VSX registry にアップロードするように依頼する。
• 次のパッケージのうち、あなたが使用しているビルドと関連するものを使って、Microsoft Visual Studio Code Marketplace を追加する: code-marketplace^AUR/vscodium-bin-marketplace^AUR/vscodium-marketplace^AUR。

これらのパッケージは、パッケージ更新のたびにこの Github コメントにあるように product.json ファイルにパッチを適用する Pacman フックをインストールします。

ヒント: product.json の変更を実験する際にIDE をリロードするキーボードショートカットを有効化すると便利です。

使用方法

code を実行して、アプリケーションを起動します (または、他のリリースを使用している場合、code-git^AUR は code-git を、vscodium-bin^AUR/vscodium^AUR/vscodium-git^AUR は codium を実行します)。

何らかの理由で Visual Studio Code の複数のインスタンスを起動した場合、-n フラグを使用できます。

設定

code は設定を ~/.config/Code - OSS/User/settings.json に保存します。

visual-studio-code-bin^AUR は設定を ~/.config/Code/User/settings.json に保存します。

vscodium^AUR や関連するパッケージは設定を ~/.config/VSCodium/User/settings.json に保存します。

Code から Codium に (またはその逆) 移行する場合、設定ディレクトリはコピー/移動することができます。設定はコードベースの殆どを共有しているので、互換性があります。

統合ターミナル

View > Integrated Terminal や Ctrl + ` で統合ターミナルが開きます。 デフォルトでは追加の引数がない場合に Bash が使用されますが、この挙動は変更できます。 terminal.integrated.shell.linux はデフォルトのシェルを設定し、terminal.integrated.shellArgs.linux はそのシェルに渡される引数を設定します。

例:

~/.config/Code/User/settings.json

"terminal.integrated.shell.linux": "/usr/bin/fish",
"terminal.integrated.shellArgs.linux": ["-l","-d 3"]

外部ターミナルで統合シェルの引数を設定するとプロンプトがおかしくなる場合があります。その行を削除してこの問題を解決するか、外部ターミナルを使用してください。

外部ターミナル

Arch のデフォルトターミナルとして Terminator を使っている場合、Visual Studio Code で次のようなエラーが発生します: Unable to launch debugger worker process (vsdbg) through the terminal. spawn truecolor ENOENT。Visual Studio で使用するターミナルを別のターミナルに変更することで解決します (例: gnome-terminal)。

"terminal.external.linuxExec": "Your alternative terminal" で実行デバッグのときに使用するデフォルトのターミナルを設定します。

例:

~/.config/Code/User/settings.json

"terminal.external.linuxExec": "gnome-terminal"

Wayland でネイティブに実行する

Visual Studio Code は Electron を使います。VSCode を Wayland 上でネイティブに動かす方法についての詳細は Wayland#Electron を見てください。

ノート: ユーザごとの設定を使用してる場合、visual-studio-code-bin^AUR と code は両方 .config/code-flags.conf を読み込みますが、code は歴史的には .config/electron18-flags.conf を読み込んでいました。

トラブルシューティング

KDE/Plasma でグローバルメニューが機能しない

Visual Studio Code は DBus を使用してメニューを Plasma に渡します。libdbusmenu-glib をインストールしてみてください。

アイテムをゴミ箱に移動できない

デフォルトでは、Electron アプリは gio を使用してファイルを削除します。Plasma が検出されると、代わりに kioclient5 が自動的に選択されます。環境変数 ELECTRON_TRASH を設定することにより、異なるゴミ箱の実装を使用できます。

例えば、trash-cli を使ってファイルを削除する場合:

$ ELECTRON_TRASH=trash-cli code

本稿執筆時点で、Electron は kioclient5、kioclient、trash-cli、gio (デフォルト)、gvfs-trash (非推奨) をサポートしています。詳細はこちらの ドキュメントページ で確認できます。

C# をデバッグできない

C#.NET を (OmniSharp 拡張機能を使って) デバッグしたい場合、Microsoft ブランドの .NET リリースを (AUR から) インストールする必要があります。これは、.NET Core デバッガーが公式の Microsoft 製品でのみ使用できるようにライセンスされているからだと思われます。GitHub のディスカッションを見てください。

オープンソース版のパッケージを利用している場合は、デバッグは静かなメッセージで失敗します。デバッグコンソールは最初のメッセージが出力されるだけです:

You may only use the Microsoft .NET Core Debugger (vsdbg) with
Visual Studio Code, Visual Studio or Visual Studio for Mac software
to help you develop and test your applications.

オープンソース版のパッケージでデバッグする場合、netcoredbg^AUR を利用できます。VS Code で実行するには、以下の設定をこのプロジェクトの .NET Core 起動設定に追加してください:

./.vscode/launch.json

"configurations": [
    {
...
    "pipeTransport": {
        "pipeCwd": "${workspaceFolder}",
        "pipeProgram": "/usr/bin/bash",
        "pipeArgs": ["-c"],
        "debuggerPath": "/usr/bin/netcoredbg"
    }
...

Unable to open .csproj with OmniSharp server, invalid Microsoft.Common.props location

mono から適切な SDK バージョンの props に変更する必要があります。

/opt/dotnet/sdk/{VERSION}/Sdks/Microsoft.NET.Sdk/Sdk/Sdk.props

$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props

インポートを次のように変更します。

/opt/dotnet/sdk/{VERSION}/Sdks/Microsoft.NET.Sdk/Sdk/Sdk.props

/opt/dotnet/sdk/{VERSION}/Current/Microsoft.Common.props

Error from OmniSharp that MSBuild cannot be located

It is noted in the OmniSharp introduction that Arch Linux users should install the mono-msbuild package. Without it, you might get an error like:

OmniSharp Log

[info]: OmniSharp.MSBuild.Discovery.MSBuildLocator
        Registered MSBuild instance: StandAlone 15.0 - "~/.vscode/extensions/ms-vscode.csharp-1.18.0/.omnisharp/1.32.11/omnisharp/msbuild/15.0/Bin"
            MSBuildExtensionsPath = /usr/lib/mono/xbuild
            BypassFrameworkInstallChecks = true
            CscToolPath = ~/.vscode/extensions/ms-vscode.csharp-1.18.0/.omnisharp/1.32.11/omnisharp/msbuild/15.0/Bin/Roslyn
            CscToolExe = csc.exe
            MSBuildToolsPath = ~/.vscode/extensions/ms-vscode.csharp-1.18.0/.omnisharp/1.32.11/omnisharp/msbuild/15.0/Bin
            TargetFrameworkRootPath = /usr/lib/mono/xbuild-frameworks
System.TypeLoadException: Could not load type of field 'OmniSharp.MSBuild.ProjectManager:_queue' (13) due to: Could not load file or assembly 'System.Threading.Tasks.Dataflow, Version=4.5.24.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a' or one of its dependencies.
...

You might be able to build anyway (possibly depending whether you have mono installed too).

Omnisharp ships with its own mono version, so, if it is unable to locate the installed one, if you want to tell omnisharp to look for a "global" mono installed in your machine, put this in your settings.json:

settings.json

"omnisharp.useGlobalMono:"always"

"Retry as Sudo" での保存がうまくいかない

Microsoft は Arch パッケージのパッケージ方法 (バンドルされた Electron ではなくネイティブ) をサポートしていないため、この機能は code パッケージでは動きません。詳しくは FS#61516 とアップストリームのバグレポートをご確認ください。

バイナリリリースの visual-studio-code-bin^AUR にはこの問題はなく、この機能は動作します。

キーボードのバリアントやキーマッピングがマッピングされない

GitHub の wiki によると、

一部の Linux ウィンドウマネージャでキーボードレイアウトを切り替えても、VS Code が現在のキーボードレイアウトを読み取るために使用する低レベルの X ウィンドウ API に変更が生じません。このため、VS Code は、現在アクティブなキーボードレイアウトではなく、他の設定されたキーボードレイアウトの 1 つを読み取ることになる場合があることを意味します。PR 歓迎...

wiki によると、2 つの可能な解決策があります。

1. setxkbmap -query が最初のキーボードレイアウトとして、VS Codeで作業したいものを返すことを確認する。
2. "keyboard.dispatch": "keyCode" を使用し、VS Codeを再起動します。これで、VS Code がキーボードレイアウトを決定しようとするのを防ぐことができます。

Command "..." not found

In the official build of VS Code, a product.json file lists the extensions that are allowed to use certain proposed APIs accessed by extensions. However, the product.json is absent in the OSS build code. [2]

In the related issues below, some flags may be required to enable certain APIs. [3] You may either run code with these flags, or you can add the relevant entries to the extensionAllowedProposedApi section in the product.json file (code installs this to /usr/lib/code/product.json).

"extensionAllowedProposedApi": [
    "ms-vsliveshare.vsliveshare",
    "ms-vscode.node-debug",
    "ms-vscode.node-debug2"
]

This can also be resolved by installing the code-features^AUR package, which installs a pacman hook that patches the file on every package update. Alternatively, you may also consider installing the Microsoft branded packages: visual-studio-code-bin^AUR, visual-studio-code-insiders-bin^AUR.

VS Live Share missing API

Use either the solution above by editing the product.json, or open VS Code with:

$ code --enable-proposed-api ms-vsliveshare.vsliveshare

Command 'remote-containers.openFolder' not found

Open VS Code enabling remote-containers API as commented in FS#63374:

$ code-oss --enable-proposed-api ms-vscode-remote.remote-containers

Command 'GitHub Pull Requests: Configure Remotes...' resulted in an error (command 'pr.configureRemotes' not found)

以下のように VS Code を開きます。

$ code --enable-proposed-api GitHub.vscode-pull-request-github

Git: ssh_askpass: exec(/usr/lib/ssh/ssh-askpass): No such file or directory

このエラーは ssh-key が暗号化されているために発生するもので、 SSH 鍵#x11-ssh-askpass のようなダイアログプロバイダや、KDE 用の ksshaskpass などの代替品をインストールすることで解決します。

注意点としては、例えば ksshaskpass の場合、VSCode に見つけてもらうために、/usr/lib/ssh/ssh-askpass からリンクする必要があることです。

# ln /usr/bin/ksshaskpass /usr/lib/ssh/ssh-askpass

統合端末のカットオフ文字

幅が広すぎる文字は、クリッピングしてしまうことがあります。例えば、Deno のスタックトレースのイタリック体の太字など。

"terminal.integrated.rendererType" を "experimentalWebgl" に設定することで、これを回避することができます。

Waylandでの文字化け

Visual Studio Code はデフォルトで XWayland で実行されるため、HiDPI スクリーンを使用している場合、文字がぼやけてしまうことがあります。この問題を解決するには、Electron を強制的に Wayland で実行するようにしてください（#Wayland でのネイティブ実行 を参照）。

No such interface“org.freedesktop.Secret.Collection”

settings-sync#_troubleshooting-keychain-issues を参照してください。

VSCodium 使用時に Github との認証に失敗する

Github アカウントに接続する場合、このコメントにあるように URLの 「vscodium」を「vscode」に変更します。その後、識別トークンを VSCodium にコピーします。それでも失敗する場合は、Visual Studio Code docs や Github にあるように、gnome-keyring のようなキーリングをインストールするか、新しいキーリングを作成します。