nixpkgs/pkgs/applications/editors/vscode/extensions/vscodeEnv.nix
2024-05-01 06:00:27 -04:00

104 lines
3.3 KiB
Nix

#Use vscodeWithConfiguration and vscodeExts2nix to create a vscode executable. When the executable exits, it updates the mutable extension file, which is imported when evaluated by Nix later.
{
lib,
buildEnv,
writeShellScriptBin,
extensionsFromVscodeMarketplace,
vscodeDefault,
jq,
}:
##User input
{
vscode ? vscodeDefault,
nixExtensions ? [ ],
vscodeExtsFolderName ? ".vscode-exts",
# will add to the command updateSettings (which will run on executing vscode) settings to override in settings.json file
settings ? { },
createSettingsIfDoesNotExists ? true,
launch ? { },
createLaunchIfDoesNotExists ? true,
# will add to the command updateKeybindings(which will run on executing vscode) keybindings to override in keybinding.json file
keybindings ? { },
createKeybindingsIfDoesNotExists ? true,
user-data-dir ? ''"''${TMP}''${name}"/vscode-data-dir'',
# if file exists will use it and import the extensions in it into this derivation else will use empty extensions list
# this file will be created/updated by vscodeExts2nix when vscode exists
mutableExtensionsFile,
}:
let
mutableExtensionsFilePath = toString mutableExtensionsFile;
mutableExtensions = lib.optionals (builtins.pathExists mutableExtensionsFile) (
import mutableExtensionsFilePath
);
vscodeWithConfiguration =
import ./vscodeWithConfiguration.nix
{
inherit lib writeShellScriptBin extensionsFromVscodeMarketplace;
vscodeDefault = vscode;
}
{
inherit
nixExtensions
mutableExtensions
vscodeExtsFolderName
user-data-dir
;
};
updateSettings = import ./updateSettings.nix { inherit lib writeShellScriptBin jq; };
userSettingsFolder = "${user-data-dir}/User";
updateSettingsCmd = updateSettings {
settings = {
"extensions.autoCheckUpdates" = false;
"extensions.autoUpdate" = false;
"update.mode" = "none";
} // settings;
inherit userSettingsFolder;
createIfDoesNotExists = createSettingsIfDoesNotExists;
symlinkFromUserSetting = (user-data-dir != "");
};
updateLaunchCmd = updateSettings {
settings = launch;
createIfDoesNotExists = createLaunchIfDoesNotExists;
vscodeSettingsFile = ".vscode/launch.json";
};
updateKeybindingsCmd = updateSettings {
settings = keybindings;
createIfDoesNotExists = createKeybindingsIfDoesNotExists;
vscodeSettingsFile = ".vscode/keybindings.json";
inherit userSettingsFolder;
symlinkFromUserSetting = (user-data-dir != "");
};
vscodeExts2nix =
import ./vscodeExts2nix.nix
{
inherit lib writeShellScriptBin;
vscodeDefault = vscodeWithConfiguration;
}
{
extensionsToIgnore = nixExtensions;
extensions = mutableExtensions;
};
code = writeShellScriptBin "code" ''
${updateSettingsCmd}/bin/vscodeNixUpdate-settings
${updateLaunchCmd}/bin/vscodeNixUpdate-launch
${updateKeybindingsCmd}/bin/vscodeNixUpdate-keybindings
${vscodeWithConfiguration}/bin/code --wait "$@"
echo 'running vscodeExts2nix to update ${mutableExtensionsFilePath}...'
${vscodeExts2nix}/bin/vscodeExts2nix > ${mutableExtensionsFilePath}
'';
in
buildEnv {
name = "vscodeEnv";
paths = [
code
vscodeExts2nix
updateSettingsCmd
updateLaunchCmd
updateKeybindingsCmd
];
}