Visual Studio Code: Difference between revisions

For the free distribution of the vscode codebase (without MS branding/telemetry) see [[VSCodium]].

== Installing Microsoft's Visual Studio Code ==

<syntaxHighlight lang=console>

And to open or launch the IDE, do:

<syntaxHighlight lang=console>

== Managing extensions ==

Extensions can be managed using the 'vscode-with-extensions' package:

{ pkgs, ... }:

  extensions = (with pkgs.vscode-extensions; [

      bbenoist.Nix

      ms-python.python

      ms-azuretools.vscode-docker

      ms-vscode-remote.remote-ssh

    ]) ++ pkgs.vscode-utils.extensionsFromVscodeMarketplace [{

      name = "remote-ssh-edit";

      publisher = "ms-vscode-remote";

      version = "0.47.2";

      sha256 = "1hp6gjh4xp2m1xlm1jsdzxw9d8frkiidhph6nvl24d0h8z34w49g";

   }];

   vscode-with-extensions = pkgs.vscode-with-extensions.override {

      vscodeExtensions = extensions;

     };

  config = {

     environment.systemPackages = [

    ];

   };

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] 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-14_x</code> package on the NixOS host, and then run the following nix-shell script:

If instead you'd prefer to fix the binaries manually and have to do so every time that you upgrade your VSCode version, then you can install the <code>nodejs-14_x</code> package on the NixOS host and replace the VSCode 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 VSCode upstream requirements (nodejs 14 is needed as of 5/14/2021).

=== Nix-sourced VSCode to NixOS host ===

== Using nix-shell ==

Some features of VSCode, like the Python package, require linters or other dependencies. The package [https://marketplace.visualstudio.com/items?itemName=arrterian.nix-env-selector nix-env-selector] makes this easy and does not require overrides on vscode itself to add dependencies.

{{note| Only available in nixpkgs-unstable or 21.05 and after }}

In [https://github.com/NixOS/nixpkgs/pull/99968 #99968], vscode-fhs and vscodium-fhs packages were added in which the editors launch inside of a [https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard FHS] compliant chroot environment using buildFHSUserEnv. This reintroduces directories such as /bin, /lib/, and /usr, which allows for extensions which ship pre-compiled binaries to work with little to no additional nixification.

{{note| From a philosophical view, use of buildFHSUserEnv allows for ease-of-use at the cost of some impurity and non-reproducibility. If you prioritize purely-declarative configurations, please stay with the above guidance.}}

<syntaxHighlight lang=console>

$ nix-shell -p vscode-fhs --run code

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

  programs.vscode.package = pkgs.vscode-fhsWithPackages (ps: with ps; [ rustup zlib ]);