Visual Studio Code: Difference between revisions

(17 intermediate revisions by 10 users not shown)

Line 37:

Some examples here: [https://github.com/search?q=extensionFromVscodeMarketplace&type=code GitHub search for "extensionFromVscodeMarketplace"]

{{ic|extensionsFromVscodeMarketplace}} is a manual way to fetch extensions. However, to keep updated from upstream, [https://github.com/nix-community/nix-vscode-extensions nix-community/nix-vscode-extensions] provides the Nix expressions for the majority of available extensions from Open VSX and VSCode Marketplace. A GitHub Action updates the extensions daily.

Note: For fetching the sha256 string you can use the following command. Make sure to replace the author, the package name and version!<syntaxhighlight lang="bash">

nix-prefetch-url https://marketplace.visualstudio.com/_apis/public/gallery/publishers/ms-vscode-remote/vsextensions/remote-ssh-edit/0.47.2/vspackage

</syntaxhighlight>{{ic|extensionsFromVscodeMarketplace}} is a manual way to fetch extensions. However, to keep updated from upstream, [https://github.com/nix-community/nix-vscode-extensions nix-community/nix-vscode-extensions] provides the Nix expressions for the majority of available extensions from Open VSX and VSCode Marketplace. A GitHub Action updates the extensions daily.

It's also possible to install VS Code via [[Home Manager]]:

Line 44:

Line 46:

programs.vscode = {

enable = true;

extensions = with pkgs.vscode-extensions; [

profiles.default.extensions = with pkgs.vscode-extensions; [

dracula-theme.theme-dracula

vscodevim.vim

Line 52:

Line 54:

</syntaxhighlight>

* See for more options: [https://nix-community.github.io/home-manager/options.~~html~~#opt-programs.vscode.enable Home Manager Manual: Options - programs.vscode]

* See for more options: [https://nix-community.github.io/home-manager/options.xhtml#opt-programs.vscode.enable Home Manager Manual: Options - programs.vscode]

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

Line 96:

Line 98:

src = (builtins.fetchTarball {

url = "https://code.visualstudio.com/sha/download?build=insider&os=linux-x64";

sha256 = "~~1dajhfsdr55mfnj12clf5apy1d4swr71d3rfwlq2hvvmpxvxsa59~~";

sha256 = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA";

});

version = "latest";

buildInputs = oldAttrs.buildInputs ++ [ pkgs.krb5 ];

});

</syntaxHighlight>

~~You will need to update the <code>sha256</code> value for each new Insiders build. The new value will appear in a validation error when you try to build.~~

~~Example~~:

==== Updating insiders placeholder <code>sha256</code>: ====

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.

===== If insiders error contains <code>sha256:</code>, follow these instructions: =====

~~Put an arbitrary value in the sha256 field, try to build and you'll get an error message like this:~~

<pre>

//-- ...

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

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

specified: sha256:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA

got: sha256:16fzxqs6ql4p2apq9aw7l10h4ag1r7jwlfvknk5rd2zmkscwhn6z

//-- ...

</pre>

Take that last line and input it where your placeholder was, 'sha256:' in the beginning should be removed.

===== If insiders error contains <code>sha256-</code>, follow these instructions: =====

<pre>

//-- ...

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

specified: sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=

got: sha256-aQvTtZdPU2F1UjkFxiLs4A+60A4qc9bXKwKriNsCDPg=

Line 116:

Line 140:

Take that last line and run the following python script (you can search for an online python interpreter if it's not installed), the output will give you the correct value:

import base64

Line 122:

Line 147:

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

</syntaxHighlight>

Take the output from this command and input it where your placeholder was.

== Creating development environments using nix-shell ==

Instead of using configuration.nix to add packages (e.g. Python or NodeJS) for developing code on VSCode, you can instead use nix-shell. This will allow you to seamlessly create development environments with the correct packages for your project, without rebuilding and restarting NixOS. See [[Development_environment_with_nix-shell | this page]] for further instructions in building nix-shell development environments.

=== Automatically switch nix shells when switching projects ===

You can do this by using [https://github.com/nix-community/nix-direnv nix-direnv] and [https://marketplace.visualstudio.com/items?itemName=mkhl.direnv the VSCode extension direnv] for integration. View the nix-direnv github page linked for a guide on setting it up.

=== Alternative for manually switching shells ===

The extension [https://marketplace.visualstudio.com/items?itemName=arrterian.nix-env-selector nix-env-selector] will make switching between different nix-shell environments within VSCode so you can switch between different coding projects easily and manually. It has a guide for setting up nix-shell environments for VSCode.

== Wayland ==

Line 200:

Line 236:

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

programs.nix-ld.enable = true;

~~environment.variables = {~~

~~NIX_LD_LIBRARY_PATH = lib.makeLibraryPath [~~

~~pkgs.stdenv.cc.cc~~

];

~~NIX_LD = lib.fileContents "${pkgs.stdenv.cc}/nix-support/dynamic-linker";~~

};

</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.

=== Nix-sourced VS Code to NixOS host ===

Line 216:

Line 246:

== Remote WSL ==

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, add the following settings for the VSCode Windows client:~~

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.

~~{{file|%USERPROFILE%\AppData\Roaming\Code\User\settings.json|json|<nowiki>~~

{

~~"remote.WSL2.connectionMethod": "localhost"~~

}

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

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

.push("sh","-c"

</nowiki>}}

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

~~== Using nix-shell ==~~

Replace it with

Some features of VS Code, 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 VS Code itself to add dependencies.

~~== Troubleshooting ==~~

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

.push("sh","-l","-c"

</nowiki>}}

~~=== Error after Sign On ===~~

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

~~If you get such an error after sign~~ on ~~in application~~:

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.

~~<pre>~~

== Troubleshooting ==

~~Writing login information to the keychain failed with error 'The name org.freedesktop.secret was not provided by any .service files'.~~

~~</pre>~~

~~Try to add the following setting in your system configuration (even if you don't use Gnome as desktop environment):~~

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

=== Writing login information to the keychain failed ===

~~# needed for store VS Code auth token~~

~~services.gnome.gnome-keyring.enable~~ = ~~true;~~

~~</nowiki>}}~~

~~''Optional'': add <code>gnome.seahorse</code>~~ to ~~<code>environment.systemPackages</code> to install GUI for GNOME Keyring~~.

If you get an error similar to the following, enable a [[Secret Service]] provider.

~~Don't forget to perform~~ <~~code~~>~~nixos-rebuild switch~~</~~code~~> ~~and reboot the system.~~

<pre>Writing login information to the keychain failed with error 'The name org.freedesktop.secret was not provided by any .service files'.</pre>

=== Server did not start successfully ===

Line 292:

Line 316:

fi

</syntaxHighlight>

[[Category:Applications]]

[[Category:IDE]]

@@ Line 37: / Line 37: @@
 Some examples here: [https://github.com/search?q=extensionFromVscodeMarketplace&type=code GitHub search for "extensionFromVscodeMarketplace"]
-{{ic|extensionsFromVscodeMarketplace}} is a manual way to fetch extensions. However, to keep updated from upstream, [https://github.com/nix-community/nix-vscode-extensions nix-community/nix-vscode-extensions] provides the Nix expressions for the majority of available extensions from Open VSX and VSCode Marketplace. A GitHub Action updates the extensions daily.
+Note: For fetching the sha256 string you can use the following command. Make sure to replace the author, the package name and version!<syntaxhighlight lang="bash">
+nix-prefetch-url https://marketplace.visualstudio.com/_apis/public/gallery/publishers/ms-vscode-remote/vsextensions/remote-ssh-edit/0.47.2/vspackage
+</syntaxhighlight>{{ic|extensionsFromVscodeMarketplace}} is a manual way to fetch extensions. However, to keep updated from upstream, [https://github.com/nix-community/nix-vscode-extensions nix-community/nix-vscode-extensions] provides the Nix expressions for the majority of available extensions from Open VSX and VSCode Marketplace. A GitHub Action updates the extensions daily.
 It's also possible to install VS Code via [[Home Manager]]:
@@ Line 44: / Line 46: @@
 programs.vscode = {
    enable = true;
-   extensions = with pkgs.vscode-extensions; [
+   profiles.default.extensions = with pkgs.vscode-extensions; [
      dracula-theme.theme-dracula
      vscodevim.vim
@@ Line 52: / Line 54: @@
 </syntaxhighlight>
-* See for more options: [https://nix-community.github.io/home-manager/options.html#opt-programs.vscode.enable Home Manager Manual: Options - programs.vscode]
+* See for more options: [https://nix-community.github.io/home-manager/options.xhtml#opt-programs.vscode.enable Home Manager Manual: Options - programs.vscode]
 * Search for extensions with configurations: [https://search.nixos.org/packages?type=packages&query=vscode-extensions NixOS Search: vscode-extensions]
@@ Line 96: / Line 98: @@
    src = (builtins.fetchTarball {
      url = "https://code.visualstudio.com/sha/download?build=insider&os=linux-x64";
-     sha256 = "1dajhfsdr55mfnj12clf5apy1d4swr71d3rfwlq2hvvmpxvxsa59";
+     sha256 = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA";
    });
    version = "latest";
+  buildInputs = oldAttrs.buildInputs ++ [ pkgs.krb5 ];
 });
 </syntaxHighlight>
-You will need to update the <code>sha256</code> value for each new Insiders build. The new value will appear in a validation error when you try to build.
-Example:
+==== Updating insiders placeholder <code>sha256</code>: ====
+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.
+===== If insiders error contains <code>sha256:</code>, follow these instructions:  =====
-Put an arbitrary value in the sha256 field, try to build and you'll get an error message like this:
 <pre>
 //-- ...
-error: hash mismatch in fixed-output derivation '/nix/store/path':
+       error: hash mismatch in file downloaded from 'https://code.visualstudio.com/sha/download?build=insider&os=linux-x64':
+         specified: sha256:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+         got:       sha256:16fzxqs6ql4p2apq9aw7l10h4ag1r7jwlfvknk5rd2zmkscwhn6z
+//-- ...
+</pre>
+Take that last line and input it where your placeholder was,  'sha256:' in the beginning should be removed.
+===== If insiders error contains <code>sha256-</code>, follow these instructions:  =====
+<pre>
+//-- ...
+        error: hash mismatch in fixed-output derivation '/nix/store/path':
           specified: sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=
              got:    sha256-aQvTtZdPU2F1UjkFxiLs4A+60A4qc9bXKwKriNsCDPg=
@@ Line 116: / Line 140: @@
 Take that last line and run the following python script (you can search for an online python interpreter if it's not installed), the output will give you the correct value:
 <syntaxHighlight lang=python>
 import base64
@@ Line 122: / Line 147: @@
 print(base64.decodebytes(text).hex())
 </syntaxHighlight>
+Take the output from this command and input it where your placeholder was.
+== Creating development environments using nix-shell ==
+Instead of using configuration.nix to add packages (e.g. Python or NodeJS) for developing code on VSCode, you can instead use nix-shell. This will allow you to seamlessly create development environments with the correct packages for your project, without rebuilding and restarting NixOS. See [[Development_environment_with_nix-shell | this page]] for further instructions in building nix-shell development environments.
+=== Automatically switch nix shells when switching projects ===
+You can do this by using [https://github.com/nix-community/nix-direnv nix-direnv] and [https://marketplace.visualstudio.com/items?itemName=mkhl.direnv the VSCode extension direnv] for integration. View the nix-direnv github page linked for a guide on setting it up.
+=== Alternative for manually switching shells ===
+The extension [https://marketplace.visualstudio.com/items?itemName=arrterian.nix-env-selector nix-env-selector] will make switching between different nix-shell environments within VSCode so you can switch between different coding projects easily and manually. It has a guide for setting up nix-shell environments for VSCode.
 == Wayland ==
@@ Line 200: / Line 236: @@
 {{file|/etc/nixos/configuration.nix|nix|<nowiki>
    programs.nix-ld.enable = true;
-  environment.variables = {
-      NIX_LD_LIBRARY_PATH = lib.makeLibraryPath [
-        pkgs.stdenv.cc.cc
-      ];
-      NIX_LD = lib.fileContents "${pkgs.stdenv.cc}/nix-support/dynamic-linker";
-  };
 </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.
 === Nix-sourced VS Code to NixOS host ===
@@ Line 216: / Line 246: @@
 == Remote WSL ==
-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, add the following settings for the VSCode Windows client:
+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.
-{{file|%USERPROFILE%\AppData\Roaming\Code\User\settings.json|json|<nowiki>
-{
-    "remote.WSL2.connectionMethod": "localhost"
-}
+As a workaround, search for the following text in all files under the directory <code>$HOME\.vscode\extensions\</code>
+{{file|wslDaemon.js|js|<nowiki>
+.push("sh","-c"
 </nowiki>}}
-See https://github.com/nix-community/NixOS-WSL/issues/222 for the discussion about <code>wsl --exec</code> issue on NixOS-WSL.
-== Using nix-shell ==
+Replace it with
-Some features of VS Code, 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 VS Code itself to add dependencies.
-== Troubleshooting ==
+{{file|wslDaemon.js|js|<nowiki>
+.push("sh","-l","-c"
+</nowiki>}}
-=== Error after Sign On  ===
+Then restart VS Code and your VS Code client should be able to connect to NixOS host
-If you get such an error after sign on in application:
+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.
-<pre>
+== Troubleshooting ==
-Writing login information to the keychain failed with error 'The name org.freedesktop.secret was not provided by any .service files'.
-</pre>
-Try to add the following setting in your system configuration (even if you don't use Gnome as desktop environment):
-{{file|/etc/nixos/configuration.nix|nix|<nowiki>
+=== Writing login information to the keychain failed ===
-# needed for store VS Code auth token
-services.gnome.gnome-keyring.enable = true;
-</nowiki>}}
-''Optional'': add <code>gnome.seahorse</code> to <code>environment.systemPackages</code> to install GUI for GNOME Keyring.
+If you get an error similar to the following, enable a [[Secret Service]] provider.
-Don't forget to perform <code>nixos-rebuild switch</code> and reboot the system.
+<pre>Writing login information to the keychain failed with error 'The name org.freedesktop.secret was not provided by any .service files'.</pre>
 === Server did not start successfully ===
@@ Line 292: / Line 316: @@
 fi
 </syntaxHighlight>
+[[Category:Applications]]
+[[Category:IDE]]