From ae5c6621825f73fb32a734b4bf2127655369f97a Mon Sep 17 00:00:00 2001 From: pacien Date: Tue, 5 Jan 2021 17:20:39 +0100 Subject: wrapFish: add fish shell wrapper package This adds a wrapper for fish which allows creating shells pre-initialised with some completions, functions, and configuration scripts from given paths or from fish plugin packages (`pkgs.fishPlugins.*`). This is especially handy when one wants to try a plugin in an ephemeral shell. GitHub: see https://github.com/NixOS/nixpkgs/pull/107834#discussion_r550612519 --- pkgs/shells/fish/wrapper.nix | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 pkgs/shells/fish/wrapper.nix (limited to 'pkgs/shells/fish') diff --git a/pkgs/shells/fish/wrapper.nix b/pkgs/shells/fish/wrapper.nix new file mode 100644 index 000000000000..053568bc6b9b --- /dev/null +++ b/pkgs/shells/fish/wrapper.nix @@ -0,0 +1,25 @@ +{ lib, writeShellScriptBin, fish }: + +with lib; + +makeOverridable ({ + completionDirs ? [], + functionDirs ? [], + confDirs ? [], + pluginPkgs ? [] +}: + +let + vendorDir = kind: plugin: "${plugin}/share/fish/vendor_${kind}.d"; + complPath = completionDirs ++ map (vendorDir "completions") pluginPkgs; + funcPath = functionDirs ++ map (vendorDir "functions") pluginPkgs; + confPath = confDirs ++ map (vendorDir "conf") pluginPkgs; + safeConfPath = map escapeShellArg confPath; + +in writeShellScriptBin "fish" '' + ${fish}/bin/fish --init-command " + set --prepend fish_complete_path ${escapeShellArgs complPath} + set --prepend fish_function_path ${escapeShellArgs funcPath} + for c in {${concatStringsSep "," safeConfPath}}/*; source $c; end + " "$@" +'') -- cgit 1.4.1 From 648a3db9343755a3d380c3247bc0bb2f3b4c5b30 Mon Sep 17 00:00:00 2001 From: pacien Date: Tue, 5 Jan 2021 17:30:52 +0100 Subject: fishPlugins.buildFishPlugin: use wrapFish --- pkgs/shells/fish/plugins/build-fish-plugin.nix | 34 +++++++++----------------- pkgs/shells/fish/plugins/pure.nix | 2 +- 2 files changed, 13 insertions(+), 23 deletions(-) (limited to 'pkgs/shells/fish') diff --git a/pkgs/shells/fish/plugins/build-fish-plugin.nix b/pkgs/shells/fish/plugins/build-fish-plugin.nix index e2ec342e5440..98e0912a33c6 100644 --- a/pkgs/shells/fish/plugins/build-fish-plugin.nix +++ b/pkgs/shells/fish/plugins/build-fish-plugin.nix @@ -1,23 +1,6 @@ -{ stdenv, lib, writeShellScriptBin, writeScript, fish }: +{ stdenv, lib, writeScript, wrapFish }: -let - rtpPath = "share/fish"; - - mapToFuncPath = v: - if lib.isString v - then v - else "${v}/${rtpPath}/vendor_functions.d"; - - fishWithFunctionPath = plugins: let - funcPaths = map mapToFuncPath plugins; - in writeShellScriptBin "fish" '' - ${fish}/bin/fish \ - --init-command \ - "set --prepend fish_function_path ${lib.escapeShellArgs funcPaths}" \ - "$@" - ''; - -in attrs@{ +attrs@{ pname, version, src, @@ -32,7 +15,9 @@ in attrs@{ installPath ? lib.getName pname, checkInputs ? [], - # plugins or paths to add to the function path of the test fish shell + # plugin packages to add to the vendor paths of the test fish shell + checkPlugins ? [], + # vendor directories to add to the function path of the test fish shell checkFunctionPath ? [], # test script to be executed in a fish shell checkPhase ? "", @@ -52,7 +37,7 @@ stdenv.mkDerivation (attrs // { ( install_vendor_files() { source="$1" - target="$out/${rtpPath}/vendor_$2.d" + target="$out/share/fish/vendor_$2.d" [ -d $source ] || return 0 mkdir -p $target @@ -69,7 +54,12 @@ stdenv.mkDerivation (attrs // { ''; inherit doCheck; - checkInputs = [ (fishWithFunctionPath checkFunctionPath) ] ++ checkInputs; + + checkInputs = [ (wrapFish { + pluginPkgs = checkPlugins; + functionDirs = checkFunctionPath; + }) ] ++ checkInputs; + checkPhase = '' export HOME=$(mktemp -d) # fish wants a writable home fish "${writeScript "${name}-test" checkPhase}" diff --git a/pkgs/shells/fish/plugins/pure.nix b/pkgs/shells/fish/plugins/pure.nix index 54af2e0663e8..3221f6b97ca7 100644 --- a/pkgs/shells/fish/plugins/pure.nix +++ b/pkgs/shells/fish/plugins/pure.nix @@ -12,7 +12,7 @@ buildFishPlugin rec { }; checkInputs = [ git ]; - checkFunctionPath = [ fishtape ]; + checkPlugins = [ fishtape ]; checkPhase = '' # https://github.com/rafaelrinaldi/pure/issues/264 rm tests/_pure_string_width.test.fish -- cgit 1.4.1 From 108fd69a8c40d4488c96fd275430b6638fed19df Mon Sep 17 00:00:00 2001 From: pacien Date: Mon, 11 Jan 2021 03:39:57 +0100 Subject: fishPlugins.buildFishPlugin: rename checkFunctionPath parameter --- doc/builders/packages/fish.section.md | 2 +- pkgs/shells/fish/plugins/build-fish-plugin.nix | 4 ++-- pkgs/shells/fish/plugins/fishtape.nix | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) (limited to 'pkgs/shells/fish') diff --git a/doc/builders/packages/fish.section.md b/doc/builders/packages/fish.section.md index 43956fc531bb..3086bd68348f 100644 --- a/doc/builders/packages/fish.section.md +++ b/doc/builders/packages/fish.section.md @@ -27,7 +27,7 @@ scripts from `$src/{completions,conf,conf.d,functions}` to the standard vendor installation paths. It also sets up the test environment so that the optional `checkPhase` is executed in a Fish shell with other already packaged plugins and package-local Fish functions specified in `checkPlugins` and -`checkFunctionPath` respectively. +`checkFunctionDirs` respectively. See `pkgs/shells/fish/plugins/pure.nix` for an example of Fish plugin package using `buildFishPlugin` and running unit tests with the `fishtape` test runner. diff --git a/pkgs/shells/fish/plugins/build-fish-plugin.nix b/pkgs/shells/fish/plugins/build-fish-plugin.nix index 98e0912a33c6..a52c57464929 100644 --- a/pkgs/shells/fish/plugins/build-fish-plugin.nix +++ b/pkgs/shells/fish/plugins/build-fish-plugin.nix @@ -18,7 +18,7 @@ attrs@{ # plugin packages to add to the vendor paths of the test fish shell checkPlugins ? [], # vendor directories to add to the function path of the test fish shell - checkFunctionPath ? [], + checkFunctionDirs ? [], # test script to be executed in a fish shell checkPhase ? "", doCheck ? checkPhase != "", @@ -57,7 +57,7 @@ stdenv.mkDerivation (attrs // { checkInputs = [ (wrapFish { pluginPkgs = checkPlugins; - functionDirs = checkFunctionPath; + functionDirs = checkFunctionDirs; }) ] ++ checkInputs; checkPhase = '' diff --git a/pkgs/shells/fish/plugins/fishtape.nix b/pkgs/shells/fish/plugins/fishtape.nix index 326ff61c4174..82f2375d5e3f 100644 --- a/pkgs/shells/fish/plugins/fishtape.nix +++ b/pkgs/shells/fish/plugins/fishtape.nix @@ -11,7 +11,7 @@ buildFishPlugin rec { sha256 = "0dxcyhs2shhgy5xnwcimqja8vqsyk841x486lgq13i3y1h0kp2kd"; }; - checkFunctionPath = [ "./" ]; # fishtape is introspective + checkFunctionDirs = [ "./" ]; # fishtape is introspective checkPhase = '' rm test/tty.fish # test expects a tty fishtape test/*.fish -- cgit 1.4.1