Add a workaround to support VS Code's Remote WSL extension (fix #238)

flake.nix

@@ -4,14 +4,15 @@
   inputs = {
     nixpkgs.url = "github:NixOS/nixpkgs/nixos-23.05";
     flake-utils.url = "github:numtide/flake-utils";
+    nix-ld-rs.url = "github:nix-community/nix-ld-rs";
 
     flake-compat = {
       url = "github:edolstra/flake-compat";
       flake = false;
     };
   };
 
-  outputs = inputs@{ self, nixpkgs, flake-utils, ... }:
+  outputs = inputs@{ self, nixpkgs, flake-utils, nix-ld-rs, ... }:
     with nixpkgs.lib;
     {
 
@@ -21,6 +22,7 @@
 
           ({ ... }: {
             wsl.version.rev = mkIf (self ? rev) self.rev;
+            wsl.vscodeRemoteWslExtensionWorkaround.nix-ld-rs = nix-ld-rs;
           })
         ];
       };

modules/default.nix

@@ -9,6 +9,7 @@
     ./welcome.nix
     ./wsl-conf.nix
     ./wsl-distro.nix
+    ./vscode-remote-wsl-extension-workaround.nix
 
     (lib.mkRemovedOptionModule [ "wsl" "docker-native" ]
       "Additional workarounds are no longer required for Docker to work. Please use the standard `virtualisation.docker` NixOS options.")

modules/vscode-remote-wsl-extension-workaround.nix

@@ -0,0 +1,37 @@
+{ lib, config, pkgs, ... }:
+{
+  options.wsl.vscodeRemoteWslExtensionWorkaround = {
+    enable = lib.mkOption {
+      type = lib.types.bool;
+      default = false;
+      description = "Workaround for VSCode's Remote WSL extension";
+    };
+    nix-ld-rs = lib.mkOption {
+      type = lib.types.raw;
+      description = "The flake input to use for `nix-ld-rs`";
+    };
+  };
+
+  config =
+    let
+      cfg = config.wsl.vscodeRemoteWslExtensionWorkaround;
+    in
+    lib.mkIf cfg.enable {
+      wsl.extraBin = [
+        # Required by VS Code's Remote WSL extension
+        { src = "${pkgs.coreutils}/bin/dirname"; }
+        { src = "${pkgs.coreutils}/bin/readlink"; }
+        { src = "${pkgs.coreutils}/bin/uname"; }
+      ];
+      programs.nix-ld = {
+        enable = true;
+        libraries = [
+          # Required by NodeJS installed by VS Code's Remote WSL extension
+          pkgs.stdenv.cc.cc
+        ];
+
+        # Use `nix-ld-rs` instead of `nix-ld`, because VS Code's Remote WSL extension launches a non-login non-interactive shell, which is not supported by `nix-ld`, while `nix-ld-rs` works in non-login non-interactive shells.
+        package = cfg.nix-ld-rs.packages.${pkgs.system}.nix-ld-rs;
+      };
+    };
+}