nixos/shells-pkgs: added environment.shellPkgs option #110762

pasqui23 · 2021-01-25T12:10:54Z

Motivation for this change

Nowadays nixpkgs contains several packages containing snippets to be added to shells initializations, however those snippets are often in disparate places and need to read the package before knowing the specific path to be sourced.

This option allow for a programmatic addition of shell snippets, as simply as environment.sessionPackages

Things done

aanderse · 2021-01-25T21:50:50Z

After a quick read through I'm left wanting an example of when you might use this option. Just out of curiosity.

pasqui23 · 2021-01-27T22:43:59Z

@aanderse the reason being that most shell plugins contain the script to be sourced in several non standard locaation and often one need to look at the specific nix file. My approach instead is as easy as environment.systemPackages.
I've also pushed some changes to packages so that they can use the new framework.

aanderse · 2021-01-27T23:29:42Z

Oh get it now. Thanks for explaining.

nixos-discourse · 2021-02-11T15:18:54Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/prs-ready-for-review/3032/465

nixos-discourse · 2021-03-20T23:30:01Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/prs-ready-for-review/3032/485

sternenseemann

Cool idea! My thoughts are the following:

The code is a bit hard to read. More comments explaining and less aliases for stuff we know would be nice :)
I feel like this module is too magic. I'd prefer it if environment.shellPkgs was namespaced per Shell (i. e. environment.shellPkgs.fish, …), alternatively programs."${shell}".shellPkgs` could also be interesting. This would have the following benefits in my eyes:
- Users generally want to install stuff for a specific shell, not specific stuff for all shell which then only supports one shell anyways.
- If someone wants to install a zsh package, but uses say fish, with environment.shellPkgs it may be confusing why it didn't work. If it was namespaced we could add an assertion to make sure that doesn't happen or make evaluation fail.
The extra output is a neat idea, but also not nice that we duplicate everything effectively. Maybe there is an alternative solution like (ab)using passthru and adding a supportedShells list or something.
Needs documentation in the nixpkgs manual, so packagers know how to package a shell package to support this.

Just my 2 cents, let me know what you think on those points!

pasqui23 · 2021-03-22T14:58:46Z

@sternenseemann Added documentation ,programs.${sh}.shellPkgs options and clarified the code as you requested.

sternenseemann · 2021-03-24T21:48:03Z

pkgs/tools/misc/direnv/default.nix

+        ${lib.concatMapStrings
+    (
+        sh: ''
+          $out/bin/direnv hook ${sh} > $${sh}_interactiveShellInit


$${foo} escapes the ${foo}.

Suggested change

$out/bin/direnv hook ${sh} > $${sh}_interactiveShellInit

$out/bin/direnv hook ${sh} > ''$${sh}_interactiveShellInit

stale · 2021-09-22T12:24:39Z

I marked this as stale due to inactivity. → More info

pasqui23 · 2021-09-22T13:20:25Z

Still developing it

pasqui23 · 2021-09-22T13:21:04Z

Still waiting on @sternenseemann ,@Ma27 or @mweinelt to review this

SuperSandro2000 · 2021-11-18T12:12:53Z

doc/languages-frameworks/shell.section.md

+Those need to have extra outputs called `${shell}_${phase}` where:
+* shell refers to the specific shell it needs to be included (either bash, fish or zsh).
+* phase refers to when the file will be sourced, this can be one of:
+* * `interactiveShellInit`,if it needs to be included in the interactive shell initialization


Suggested change

* * `interactiveShellInit`,if it needs to be included in the interactive shell initialization

* * `interactiveShellInit` if it needs to be included in the interactive shell initialization

SuperSandro2000 · 2021-11-18T12:13:50Z

pkgs/shells/zsh/fzf-zsh/default.nix

+  outputs = [ "out" "interactiveShellInit_zsh"];
+
  installPhase = ''
    install -Dm0644 fzf-zsh.plugin.zsh $out/share/zsh/plugins/fzf-zsh/fzf-zsh.plugin.zsh
+    install -Dm0644 fzf-zsh.plugin.zsh $interactiveShellInit_zsh


I think it would be a better design to only have the interactiveShellInit output and subdirectories for bash, fish and zsh. This would also be easier to extend.

I've chosen this design for a couple of reason:

It allow users of, say, zsh to not pay for fish plugins

It allows programs,zsh,shellPkgs to contain only packages with zsh plugins

In the immediate future I intend to create (either here or on home-manager) a module that allows me to manage zsh plugins to be loaded and managed by zplugin to improve parsing even further.

Especially point 3 require IFD with your design

In short I need to filter plugins by shell without IFD and I can't do that with per shell subdirs

As for extensibility, you just have to add to the lists in the imports in https://github.com/NixOS/nixpkgs/blob/a4e97999decd694aba59773ae384d030a97e08e0/nixos/modules/config/shells-pkgs.nix#L71

SuperSandro2000 · 2021-11-18T12:15:59Z

pkgs/tools/misc/direnv/default.nix


  # replace the build phase to use the GNUMakefile instead
  buildPhase = ''
    make BASH_PATH=$BASH_PATH
  '';

+  outputs = [ "out" ] ++ map (sh: "${sh}_interactiveShellInit");


Why do we have once the shells at the end and here at the front? Not very consistent.

I don't understand

ok now I get it,it was an error

Co-authored-by: sterni <sternenseemann@systemli.org>

Co-authored-by: Manuel Mendez <708570+mmlb@users.noreply.github.com>

Daholli · 2025-03-24T17:44:54Z

@pasqui23 is this something where someone can help you finish this or is this not needed anymore?

ofborg bot added 6.topic: nixos 8.has: module (update) labels Jan 25, 2021

pasqui23 mentioned this pull request Jan 30, 2021

nixos/shell: added environment.shellFiles option #89943

Closed

10 tasks

pasqui23 requested review from sternenseemann, mweinelt and Ma27 and removed request for mweinelt March 6, 2021 10:37

sternenseemann reviewed Mar 21, 2021

View reviewed changes

github-actions bot added the 8.has: documentation label Mar 22, 2021

sternenseemann reviewed Mar 24, 2021

View reviewed changes

stale bot added the 2.status: stale label Sep 22, 2021

stale bot removed the 2.status: stale label Sep 22, 2021

SuperSandro2000 reviewed Nov 18, 2021

View reviewed changes

mweinelt removed their request for review November 25, 2021 20:50

pasqui23 force-pushed the shplugins branch 5 times, most recently from 0d0fae3 to 85fc860 Compare November 25, 2021 21:43

pasqui23 and others added 22 commits June 2, 2022 15:24

direnv: use shellPkgs

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

GPG key ID: 4AEE18F83AFDEB23
Expired

Verified
Learn about vigilant mode

270b3af

direnv: fix typo

df29404

Co-authored-by: sterni <sternenseemann@systemli.org>

nixos/documentation: clarifying shellPkgs outputs usage

112c756

nixos/shellPkgs: fixing filtering of unneeded ouputs in per sh shellPkgs

227fe6f

nixos/shellPkgs: refactoring

ae1995c

direnv: fixed shellPkgs integration

eb60f5c

atuin: using shellPkgs framework

89b654b

autojump: using shellPkgs framework

d7cb0ed

mcfly: add shellPkgs

f391032

navi: add shellPkgs

daebc6b

pazi: add shellPkgs

2c4996c

skim: add shellPkgs

59f3f53

starship: add shellPkgs

6eb8603

z-lua: add shellPkgs

1fd45d8

zoxide: add shellPkgs

d5d3e25

thefuck: add .mkShellPkg

d28c6dc

nixos/thefuck: adding options, using shellPkgs

ddba87e

thefuck: instant mode does not support fish

690a3a5

nixos/thefuck: fix typo

8004c4f

Co-authored-by: Manuel Mendez <708570+mmlb@users.noreply.github.com>

starship: use promptInit

130f2fc

starship: use promptInit

9d1299a

zoxide: fix shellPkgs

a395d1f

pasqui23 force-pushed the shplugins branch from 7abea1f to a395d1f Compare June 2, 2022 14:16

ofborg bot removed the 2.status: merge conflict label Jun 2, 2022

stale bot added the 2.status: stale label Jan 8, 2023

wegank added the 2.status: merge conflict label Mar 20, 2024

stale bot removed the 2.status: stale label Mar 20, 2024

wegank added the 2.status: stale label Jul 4, 2024

stale bot removed the 2.status: stale label Mar 24, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nixos/shells-pkgs: added environment.shellPkgs option #110762

nixos/shells-pkgs: added environment.shellPkgs option #110762

pasqui23 commented Jan 25, 2021

aanderse commented Jan 25, 2021

pasqui23 commented Jan 27, 2021

aanderse commented Jan 27, 2021

nixos-discourse commented Feb 11, 2021

nixos-discourse commented Mar 20, 2021

sternenseemann left a comment

pasqui23 commented Mar 22, 2021

sternenseemann Mar 24, 2021

stale bot commented Sep 22, 2021

pasqui23 commented Sep 22, 2021

pasqui23 commented Sep 22, 2021

SuperSandro2000 Nov 18, 2021

SuperSandro2000 Nov 18, 2021

pasqui23 Nov 24, 2021

pasqui23 Dec 11, 2021

SuperSandro2000 Nov 18, 2021

pasqui23 Dec 11, 2021

pasqui23 Dec 11, 2021

Daholli commented Mar 24, 2025

	$out/bin/direnv hook ${sh} > $${sh}_interactiveShellInit
	$out/bin/direnv hook ${sh} > ''$${sh}_interactiveShellInit

	* * `interactiveShellInit`,if it needs to be included in the interactive shell initialization
	* * `interactiveShellInit` if it needs to be included in the interactive shell initialization

nixos/shells-pkgs: added environment.shellPkgs option #110762

Are you sure you want to change the base?

nixos/shells-pkgs: added environment.shellPkgs option #110762

Conversation

pasqui23 commented Jan 25, 2021

Motivation for this change

Things done

aanderse commented Jan 25, 2021

pasqui23 commented Jan 27, 2021

aanderse commented Jan 27, 2021

nixos-discourse commented Feb 11, 2021

nixos-discourse commented Mar 20, 2021

sternenseemann left a comment

Choose a reason for hiding this comment

pasqui23 commented Mar 22, 2021

Choose a reason for hiding this comment

stale bot commented Sep 22, 2021

pasqui23 commented Sep 22, 2021

pasqui23 commented Sep 22, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Daholli commented Mar 24, 2025