Visual Studio Code: Difference between revisions

<syntaxHighlight lang=nix>

environment.systemPackages = with pkgs; [ vscode ];

</syntaxHighlight>

   (vscode-with-extensions.override {

     vscodeExtensions = with vscode-extensions; [

       ms-python.python

       ms-azuretools.vscode-docker

     ];

   })

   enable = true;

     dracula-theme.theme-dracula

     vscodevim.vim

     yzhang.markdown-all-in-one

   ];

* Search for extensions with configurations: [https://search.nixos.org/packages?type=packages&query=vscode-extensions NixOS Search: vscode-extensions]

<syntaxHighlight lang=nix>

environment.systemPackages = with pkgs; [ vscode.fhs ];

</syntaxHighlight>

<syntaxHighlight lang=nix>

programs.vscode = {

</syntaxHighlight>

Adding extension-specific dependencies, these will be added to the FHS environment:

# needed for rust lang server and rust-analyzer extension

If you need to test a recent code change, you can run the insiders build. It is designed to run alongside the main build, with a separate <code>code-insiders</code> command and a different config path, so you can leave your main VS Code instance installed/running.

<syntaxHighlight lang=nix>

(pkgs.vscode.override { isInsiders = true; }).overrideAttrs (oldAttrs: rec {

   version = "latest";

});

</syntaxHighlight>

You will need to update the placeholder <code>sha256</code> value for each new Insiders build.

The new value will appear in a validation error when you try to build.

Put an arbitrary placeholder value in the <code>sha256</code> field, try to build and you'll get an error message regarding the sha256 value.

       error: hash mismatch in file downloaded from 'https://code.visualstudio.com/sha/download?build=insider&os=linux-x64':

         specified: sha256:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA

         got:      sha256:16fzxqs6ql4p2apq9aw7l10h4ag1r7jwlfvknk5rd2zmkscwhn6z

         error: hash mismatch in fixed-output derivation '/nix/store/path':

         specified: sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=

             got:    sha256-aQvTtZdPU2F1UjkFxiLs4A+60A4qc9bXKwKriNsCDPg=

import base64

print(base64.decodebytes(text).hex())

{ extensions = [

   {

   }

];

The remote-ssh extension works by connecting to a remote host and downloading scripts and pre-built binaries to {{ic|$HOME/.vscode-server}}. When first launching remote-ssh for a NixOS host, the connection will fail due to the provided node.js not having been built for a NixOS system (the dynamic libraries aren't in the same place).

'''tl;dr Use [https://github.com/msteen/nixos-vscode-server nix-vscode-server] or [https://github.com/Mic92/nix-ld nix-ld] on host machines.'''

Note that nix-vscode-server works as of 8/21/21 but is occasionally broken (See https://github.com/msteen/nixos-vscode-server/pull/3, https://github.com/msteen/nixos-vscode-server/pull/4, https://github.com/msteen/nixos-vscode-server/pull/5). Here's a workaround: Install the <code>nodejs-16_x</code> package on the NixOS host, and then run the following nix-shell script:

<syntaxHighlight lang=haskell>

#! nix-shell --pure -i runghc -p "haskellPackages.ghcWithPackages (pkgs: [ pkgs.turtle ])"

{-# LANGUAGE OverloadedStrings #-}

import Turtle

main = sh $ do

   homedir <- home

</syntaxHighlight>

If instead you'd prefer to fix the binaries manually and have to do so every time that you upgrade your VS Code version, then you can install the <code>nodejs-16_x</code> package on the NixOS host and replace the VS Code provided version. This workaround is described here: https://github.com/microsoft/vscode-remote-release/issues/648#issuecomment-503148523. Note that NodeJS needs to be updated according to VS Code upstream requirements (NodeJS 16 required from 4/2022).

Add the following settings to <code>configuration.nix</code> on the NixOS host

{{file|/etc/nixos/configuration.nix|nix|<nowiki>

</nowiki>}}

Then run <code>nixos-rebuild switch</code> to enable <code>nix-ld</code>. Unlike the <code>nix-vscode-server</code> solution, the <code>nix-ld</code> solution also enables VSCode extensions even if they include non-Nix binaries.

If vscode-remote is installed from nix (vscode-extensions.ms-vscode-remote as above) on the client machine, everything should "just work".

Similar to SSH hosts, both <code>nix-vscode-server</code> and <code>nix-ld</code> solution allows a VSCode Windows client to connect a [https://github.com/nix-community/NixOS-WSL NixOS-WSL] host. However, by default the VSCode Windows client uses <code>wsl.exe --exec</code> to start the code server, which bypasses NixOS environment variables required by <code>nix-ld</code>, resulting in failures.  

As a workaround, search for the following text in all files under the directory <code>$HOME\.vscode\extensions\</code>

{{file|wslDaemon.js|js|<nowiki>

</nowiki>}}

Replace it with

{{file|wslDaemon.js|js|<nowiki>

</nowiki>}}

Then restart VS Code and your VS Code client should be able to connect to NixOS host

See https://github.com/nix-community/NixOS-WSL/issues/222 for the discussion about <code>wsl --exec</code> issue on NixOS-WSL.

See https://github.com/microsoft/vscode-remote-release/issues/8305#issuecomment-1661396267 about the workaround.

<blockquote>

Server did not start successfully. Full server log at /home/user/.vscode-server/.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.log<br>

</blockquote>

"No such file or directory" means that libc is not found, see

try to run the node binary on the server

if this fails, install node version 16, and try to patch the node binary

<syntaxHighlight lang=bash>

#! /bin/sh

fi

</syntaxHighlight>