diff options
author | Michele Guerini Rocco <rnhmjoj@users.noreply.github.com> | 2021-01-11 09:10:52 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-01-11 09:10:52 +0100 |
commit | a306b088f6f1f2f66bdb01de654e6e2f51b3b937 (patch) | |
tree | 50cf49b18aead97cda5b52342f924a3f94ab026c | |
parent | 1109e2423d4b4ce34a860a13beb87ac88e76a40f (diff) | |
parent | 108fd69a8c40d4488c96fd275430b6638fed19df (diff) | |
download | nixlib-a306b088f6f1f2f66bdb01de654e6e2f51b3b937.tar nixlib-a306b088f6f1f2f66bdb01de654e6e2f51b3b937.tar.gz nixlib-a306b088f6f1f2f66bdb01de654e6e2f51b3b937.tar.bz2 nixlib-a306b088f6f1f2f66bdb01de654e6e2f51b3b937.tar.lz nixlib-a306b088f6f1f2f66bdb01de654e6e2f51b3b937.tar.xz nixlib-a306b088f6f1f2f66bdb01de654e6e2f51b3b937.tar.zst nixlib-a306b088f6f1f2f66bdb01de654e6e2f51b3b937.zip |
Merge pull request #108491 from pacien/fishPlugins-wrapFish
wrapFish: add fish shell wrapper package
-rw-r--r-- | doc/builders/packages/fish.section.md | 50 | ||||
-rw-r--r-- | doc/builders/packages/index.xml | 1 | ||||
-rw-r--r-- | pkgs/shells/fish/plugins/build-fish-plugin.nix | 36 | ||||
-rw-r--r-- | pkgs/shells/fish/plugins/fishtape.nix | 2 | ||||
-rw-r--r-- | pkgs/shells/fish/plugins/pure.nix | 2 | ||||
-rw-r--r-- | pkgs/shells/fish/wrapper.nix | 25 | ||||
-rw-r--r-- | pkgs/top-level/all-packages.nix | 2 |
7 files changed, 93 insertions, 25 deletions
diff --git a/doc/builders/packages/fish.section.md b/doc/builders/packages/fish.section.md new file mode 100644 index 000000000000..3086bd68348f --- /dev/null +++ b/doc/builders/packages/fish.section.md @@ -0,0 +1,50 @@ +# Fish {#sec-fish} + +Fish is a "smart and user-friendly command line shell" with support for plugins. + + +## Vendor Fish scripts {#sec-fish-vendor} + +Any package may ship its own Fish completions, configuration snippets, and +functions. Those should be installed to +`$out/share/fish/vendor_{completions,conf,functions}.d` respectively. + +When the `programs.fish.enable` and +`programs.fish.vendor.{completions,config,functions}.enable` options from the +NixOS Fish module are set to true, those paths are symlinked in the current +system environment and automatically loaded by Fish. + + +## Packaging Fish plugins {#sec-fish-plugins-pkg} + +While packages providing standalone executables belong to the top level, +packages which have the sole purpose of extending Fish belong to the +`fishPlugins` scope and should be registered in +`pkgs/shells/fish/plugins/default.nix`. + +The `buildFishPlugin` utility function can be used to automatically copy Fish +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 +`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. + + +## Fish wrapper {#sec-fish-wrapper} + +The `wrapFish` package is a wrapper around Fish which can be used to create +Fish shells initialised with some plugins as well as completions, configuration +snippets and functions sourced from the given paths. This provides a convenient +way to test Fish plugins and scripts without having to alter the environment. + +```nix +wrapFish { + pluginPkgs = with fishPlugins; [ pure foreign-env ]; + completionDirs = []; + functionDirs = []; + confDirs = [ "/path/to/some/fish/init/dir/" ]; +} +``` diff --git a/doc/builders/packages/index.xml b/doc/builders/packages/index.xml index 732560ec1992..ab335e24ff99 100644 --- a/doc/builders/packages/index.xml +++ b/doc/builders/packages/index.xml @@ -11,6 +11,7 @@ <xi:include href="elm.xml" /> <xi:include href="emacs.section.xml" /> <xi:include href="firefox.section.xml" /> + <xi:include href="fish.section.xml" /> <xi:include href="ibus.xml" /> <xi:include href="kakoune.section.xml" /> <xi:include href="linux.section.xml" /> diff --git a/pkgs/shells/fish/plugins/build-fish-plugin.nix b/pkgs/shells/fish/plugins/build-fish-plugin.nix index e2ec342e5440..a52c57464929 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,8 +15,10 @@ in attrs@{ installPath ? lib.getName pname, checkInputs ? [], - # plugins or paths to add to the function path of the test fish shell - checkFunctionPath ? [], + # 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 + checkFunctionDirs ? [], # test script to be executed in a fish shell checkPhase ? "", doCheck ? 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 = checkFunctionDirs; + }) ] ++ checkInputs; + checkPhase = '' export HOME=$(mktemp -d) # fish wants a writable home fish "${writeScript "${name}-test" 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 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 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 + " "$@" +'') diff --git a/pkgs/top-level/all-packages.nix b/pkgs/top-level/all-packages.nix index 96bc0ce87d54..cfd791fb0891 100644 --- a/pkgs/top-level/all-packages.nix +++ b/pkgs/top-level/all-packages.nix @@ -8933,6 +8933,8 @@ in fish = callPackage ../shells/fish { }; + wrapFish = callPackage ../shells/fish/wrapper.nix { }; + fishPlugins = recurseIntoAttrs (callPackage ../shells/fish/plugins { }); ion = callPackage ../shells/ion { |