zsh: generated plugin loading cleanup/improvements #7849

khaneliman · 2025-09-20T16:39:40Z

Description

Just doing some loops for adding to path and sourcing to clean up the generated code.

Plugin path:

path+="/Users/khaneliman/.config/zsh/plugins/fzf-tab"
fpath+="/Users/khaneliman/.config/zsh/plugins/fzf-tab"

path+="/Users/khaneliman/.config/zsh/plugins/zsh-nix-shell"
fpath+="/Users/khaneliman/.config/zsh/plugins/zsh-nix-shell"

path+="/Users/khaneliman/.config/zsh/plugins/zsh-vi-mode"
fpath+="/Users/khaneliman/.config/zsh/plugins/zsh-vi-mode"

path+="/Users/khaneliman/.config/zsh/plugins/fast-syntax-highlighting"
fpath+="/Users/khaneliman/.config/zsh/plugins/fast-syntax-highlighting"

path+="/Users/khaneliman/.config/zsh/plugins/zsh-autosuggestions"
fpath+="/Users/khaneliman/.config/zsh/plugins/zsh-autosuggestions"

path+="/Users/khaneliman/.config/zsh/plugins/zsh-better-npm-completion"
fpath+="/Users/khaneliman/.config/zsh/plugins/zsh-better-npm-completion"

path+="/Users/khaneliman/.config/zsh/plugins/zsh-you-should-use"
fpath+="/Users/khaneliman/.config/zsh/plugins/zsh-you-should-use"

->

# Add plugin directories to PATH and fpath
plugin_dirs=(
  "fzf-tab" "zsh-nix-shell" "zsh-vi-mode" "fast-syntax-highlighting"
  "zsh-autosuggestions" "zsh-better-npm-completion" "zsh-you-should-use"
)
for plugin_dir in "${plugin_dirs[@]}"; do
  path+="/Users/khaneliman/.config/zsh/plugins/$plugin_dir"
  fpath+="/Users/khaneliman/.config/zsh/plugins/$plugin_dir"
done

Plugin sourcing:

if [[ -f "/Users/khaneliman/.config/zsh/plugins/fzf-tab/share/fzf-tab/fzf-tab.plugin.zsh" ]]; then
  source "/Users/khaneliman/.config/zsh/plugins/fzf-tab/share/fzf-tab/fzf-tab.plugin.zsh"
fi
if [[ -f "/Users/khaneliman/.config/zsh/plugins/zsh-nix-shell/share/zsh-nix-shell/nix-shell.plugin.zsh" ]]; then
  source "/Users/khaneliman/.config/zsh/plugins/zsh-nix-shell/share/zsh-nix-shell/nix-shell.plugin.zsh"
fi
if [[ -f "/Users/khaneliman/.config/zsh/plugins/zsh-vi-mode/share/zsh-vi-mode/zsh-vi-mode.plugin.zsh" ]]; then
  source "/Users/khaneliman/.config/zsh/plugins/zsh-vi-mode/share/zsh-vi-mode/zsh-vi-mode.plugin.zsh"
fi
if [[ -f "/Users/khaneliman/.config/zsh/plugins/fast-syntax-highlighting/share/zsh/site-functions/fast-syntax-highlighting.plugin.zsh" ]]; then
  source "/Users/khaneliman/.config/zsh/plugins/fast-syntax-highlighting/share/zsh/site-functions/fast-syntax-highlighting.plugin.zsh"
fi
if [[ -f "/Users/khaneliman/.config/zsh/plugins/zsh-autosuggestions/share/zsh-autosuggestions/zsh-autosuggestions.zsh" ]]; then
  source "/Users/khaneliman/.config/zsh/plugins/zsh-autosuggestions/share/zsh-autosuggestions/zsh-autosuggestions.zsh"
fi
if [[ -f "/Users/khaneliman/.config/zsh/plugins/zsh-better-npm-completion/share/zsh-better-npm-completion" ]]; then
  source "/Users/khaneliman/.config/zsh/plugins/zsh-better-npm-completion/share/zsh-better-npm-completion"
fi
if [[ -f "/Users/khaneliman/.config/zsh/plugins/zsh-you-should-use/share/zsh/plugins/you-should-use/you-should-use.plugin.zsh" ]]; then
  source "/Users/khaneliman/.config/zsh/plugins/zsh-you-should-use/share/zsh/plugins/you-should-use/you-should-use.plugin.zsh"
fi

->

# Source plugins
plugins=(
  "fzf-tab/share/fzf-tab/fzf-tab.plugin.zsh"
  "zsh-nix-shell/share/zsh-nix-shell/nix-shell.plugin.zsh"
  "zsh-vi-mode/share/zsh-vi-mode/zsh-vi-mode.plugin.zsh"
  "fast-syntax-highlighting/share/zsh/site-functions/fast-syntax-highlighting.plugin.zsh"
  "zsh-autosuggestions/share/zsh-autosuggestions/zsh-autosuggestions.zsh"
  "zsh-better-npm-completion/share/zsh-better-npm-completion"
  "zsh-you-should-use/share/zsh/plugins/you-should-use/you-should-use.plugin.zsh"
)
for plugin in "${plugins[@]}"; do
  [[ -f "/Users/khaneliman/.config/zsh/plugins/$plugin" ]] && source "/Users/khaneliman/.config/zsh/plugins/$plugin"
d

Hist:

setopt HIST_FCNTL_LOCK
unsetopt APPEND_HISTORY
setopt HIST_IGNORE_DUPS
unsetopt HIST_IGNORE_ALL_DUPS
setopt HIST_SAVE_NO_DUPS
setopt HIST_FIND_NO_DUPS
setopt HIST_IGNORE_SPACE
setopt HIST_EXPIRE_DUPS_FIRST
setopt SHARE_HISTORY
setopt EXTENDED_HISTORY
setopt autocd

source '/nix/store/i1q7kjxqmfwi4h2kdl18wyidqsxx3yp0-catppuccin-zsh-syntax-highlighting-0-unstable-2024-07-20/catppuccin_macchiato-zsh-syntax-highlighting.zsh'

setopt AUTO_LIST
setopt AUTO_PARAM_SLASH
setopt AUTO_PUSHD
setopt ALWAYS_TO_END
setopt CORRECT
setopt HIST_FCNTL_LOCK
setopt HIST_VERIFY
setopt INTERACTIVE_COMMENTS
setopt MENU_COMPLETE
setopt PUSHD_IGNORE_DUPS
setopt PUSHD_TO_HOME
setopt PUSHD_SILENT
setopt NOTIFY
setopt PROMPT_SUBST
setopt MULTIOS
setopt NOFLOWCONTROL
setopt NO_CORRECT_ALL
setopt NO_HIST_BEEP
setopt NO_NOMATCH

->

setopt HIST_FCNTL_LOCK

# Enabled history options
enabled_opts=(
  "EXTENDED_HISTORY" "HIST_EXPIRE_DUPS_FIRST" "HIST_FIND_NO_DUPS"
  "HIST_IGNORE_DUPS" "HIST_IGNORE_SPACE" "HIST_SAVE_NO_DUPS" "SHARE_HISTORY"
  "autocd"
)
for opt in "${enabled_opts[@]}"; do
  setopt "$opt"
done

# Disabled history options
disabled_opts=("APPEND_HISTORY" "HIST_IGNORE_ALL_DUPS")
for opt in "${disabled_opts[@]}"; do
  unsetopt "$opt"
done

Checklist

Change is backwards compatible.
Code formatted with nix fmt or
nix-shell -p treefmt nixfmt deadnix keep-sorted --run treefmt.
Code tested through nix run .#tests -- test-all or
nix-shell --pure tests -A run.all.
Test cases updated/added. See example.
Commit messages are formatted like
```
{component}: {description}

{long description}
```
See CONTRIBUTING for more information and recent commit messages for examples.
If this PR adds a new module
- Added myself as module maintainer. See example.
- Generate a news entry. See News
- Basic tests added. See Tests
If this PR adds an exciting new feature or contains a breaking change.
- Generate a news entry. See News

Replace individual conditional checks with a single loop over a plugin array. This generates cleaner shell code and follows common bash patterns while maintaining the same functionality. Signed-off-by: Austin Horstman <[email protected]>

Add test assertions to verify the new array-based plugin loading structure generates the expected shell code patterns. Signed-off-by: Austin Horstman <[email protected]>

Replace individual plugin PATH and fpath statements with efficient array-based loops, reducing generated shell code and improving consistency with existing plugin sourcing logic. Signed-off-by: Austin Horstman <[email protected]>

Update test assertions to match the new array and loop structure for plugin directory and completion path setup, replacing checks for individual statements with loop-based pattern verification. Signed-off-by: Austin Horstman <[email protected]>

Use arrays and loops for bindkey statements instead of individual statements, improving consistency with other zsh optimizations and reducing generated shell code. Signed-off-by: Austin Horstman <[email protected]>

Update test expectations to match the new array and loop structure for key bindings instead of checking for individual bindkey statements. Signed-off-by: Austin Horstman <[email protected]>

Replace repetitive setopt/unsetopt conditional statements with efficient array-based loops, reducing generated shell code and improving consistency with other zsh module optimizations. Signed-off-by: Austin Horstman <[email protected]>

Replace individual setopt statements with array-based loops for cfg.setOptions, improving consistency with other zsh optimizations and reducing generated shell code. Signed-off-by: Austin Horstman <[email protected]>

…zation Add shared utility function that formats shell arrays with smart width optimization. Signed-off-by: Austin Horstman <[email protected]>

Improve array formatting to pack multiple items per line based on available width (~76 characters), making better use of terminal space while maintaining readability. Examples: - Before: Each item on separate line - After: Multiple items per line within width limit disabled_opts=( "APPEND_HISTORY" "EXTENDED_HISTORY" "HIST_EXPIRE_DUPS_FIRST" "HIST_FIND_NO_DUPS" "HIST_IGNORE_ALL_DUPS" "HIST_SAVE_NO_DUPS" ) This provides optimal balance of compactness and readability. Signed-off-by: Austin Horstman <[email protected]>

ambroisie

I like the change, I read it commit-by-commit so suggestions might be slightly repetitive.

ambroisie · 2025-09-23T10:36:25Z

modules/programs/zsh/plugins/default.nix

+            plugins=(
+              ${lib.concatMapStringsSep "\n  " (path: ''"${path}"'') pluginPaths}
+            )


We have lib.hm.zsh.define to do this. Arguably the formatting won't be quite as pretty (no newlines -- this could be fixed in define itself though)

As a note, I think both toZshValue and your own version of it fail to account for escaping caracters in a string.

This line should probably read lib.escapeShellArg v. Your mapped function should probably be lib.escapeShellArg instead of a naive quote.

ambroisie · 2025-09-23T10:36:41Z

modules/programs/zsh/plugins/default.nix

+            )
+            for plugin in "''${plugins[@]}"; do
+              [[ -f "${pluginsDir}/$plugin" ]] && source "${pluginsDir}/$plugin"
+            done


I think we should unset plugin plugins after the loop.

ambroisie · 2025-09-23T10:37:36Z

modules/programs/zsh/plugins/default.nix

+            plugin_dirs=(
+              ${lib.concatMapStringsSep "\n  " (name: ''"${name}"'') pluginNames}
+            )
+            for plugin_dir in "''${plugin_dirs[@]}"; do
+              path+="${pluginsDir}/$plugin_dir"
+              fpath+="${pluginsDir}/$plugin_dir"
+            done
+            ${lib.optionalString (completionPaths != [ ]) ''
+              # Add completion paths to fpath
+              completion_paths=(
+                ${lib.concatMapStringsSep "\n  " (path: ''"${path}"'') completionPaths}
+              )
+              for completion_path in "''${completion_paths[@]}"; do
+                fpath+="${pluginsDir}/$completion_path"
+              done
+            ''}


Same suggestions.

ambroisie · 2025-09-23T10:37:54Z

modules/programs/zsh/history.nix

+                # Bind search up keys
+                search_up_keys=(${lib.concatStringsSep " " (map (key: ''"${key}"'') upKeys)})
+                for key in "''${search_up_keys[@]}"; do
+                  bindkey "$key" history-substring-search-up
+                done
+
+                # Bind search down keys
+                search_down_keys=(${lib.concatStringsSep " " (map (key: ''"${key}"'') downKeys)})
+                for key in "''${search_down_keys[@]}"; do
+                  bindkey "$key" history-substring-search-down
+                done


Same suggestions.

ambroisie · 2025-09-23T10:38:31Z

modules/programs/zsh/history.nix

+            lib.filter (s: s != "") [
+              (lib.optionalString (enabledOpts != { }) ''
+                # Enabled history options
+                enabled_opts=(${lib.concatStringsSep " " (lib.mapAttrsToList (name: _: ''"${name}"'') enabledOpts)})
+                for opt in "''${enabled_opts[@]}"; do
+                  setopt "$opt"
+                done'')
+              (lib.optionalString (disabledOpts != { }) ''
+                # Disabled history options
+                disabled_opts=(${
+                  lib.concatStringsSep " " (lib.mapAttrsToList (name: _: ''"${name}"'') disabledOpts)
+                })
+                for opt in "''${disabled_opts[@]}"; do
+                  unsetopt "$opt"
+                done'')
+            ]


Same suggestions.

ambroisie · 2025-09-23T10:42:08Z

modules/programs/zsh/default.nix

+                # Set shell options
+                set_opts=(${concatStringsSep " " (map (opt: ''"${opt}"'') cfg.setOptions)})
+                for opt in "''${set_opts[@]}"; do
+                  setopt "$opt"
+                done


Same suggestions.

Also: should the history options be deprecated to use cfg.setOptions instead? That'd be a big change so definitely not suggesting it for this MR, just floating the idea.

I've been thinking about that, too. I mentioned the idea #7333 (comment) just wasn't 100% sure, yet.

ambroisie · 2025-09-23T10:43:50Z

modules/lib/shell.nix

We could use this in lib.hm.zsh.define directly, I guess.

ambroisie · 2025-09-23T10:45:06Z

modules/programs/zsh/default.nix

              mkOrder 950 ''
                # Set shell options
-                set_opts=(${concatStringsSep " " (map (opt: ''"${opt}"'') cfg.setOptions)})
+                set_opts=(${lib.hm.shell.formatShellArray cfg.setOptions})


... Because I think this is slightly weird: formatShellArray does not define an array (i.e: I have to call it inside the (/)).

github-actions bot added the shell label Sep 20, 2025

khaneliman force-pushed the zsh-improvements branch from 11f46cd to fd07a18 Compare September 20, 2025 16:47

khaneliman added 10 commits September 21, 2025 09:22

tests/zsh: add coverage for plugin loading optimization

88b6810

Add test assertions to verify the new array-based plugin loading structure generates the expected shell code patterns. Signed-off-by: Austin Horstman <[email protected]>

zsh: use loops for plugin PATH/fpath setup

e8f5a18

Replace individual plugin PATH and fpath statements with efficient array-based loops, reducing generated shell code and improving consistency with existing plugin sourcing logic. Signed-off-by: Austin Horstman <[email protected]>

zsh: optimize history substring search key bindings

6b707ab

Use arrays and loops for bindkey statements instead of individual statements, improving consistency with other zsh optimizations and reducing generated shell code. Signed-off-by: Austin Horstman <[email protected]>

tests/zsh: update history substring search test for loop approach

5aec9b3

Update test expectations to match the new array and loop structure for key bindings instead of checking for individual bindkey statements. Signed-off-by: Austin Horstman <[email protected]>

zsh: use loops for history setopt configuration

0fa5544

Replace repetitive setopt/unsetopt conditional statements with efficient array-based loops, reducing generated shell code and improving consistency with other zsh module optimizations. Signed-off-by: Austin Horstman <[email protected]>

zsh: use loops for setOptions configuration

aeba6b2

Replace individual setopt statements with array-based loops for cfg.setOptions, improving consistency with other zsh optimizations and reducing generated shell code. Signed-off-by: Austin Horstman <[email protected]>

lib/shell: add formatShellArray function for intelligent width optimi…

a491e86

…zation Add shared utility function that formats shell arrays with smart width optimization. Signed-off-by: Austin Horstman <[email protected]>

khaneliman force-pushed the zsh-improvements branch from fd07a18 to 2b0da06 Compare September 21, 2025 14:45

ambroisie reviewed Sep 23, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

zsh: generated plugin loading cleanup/improvements #7849

zsh: generated plugin loading cleanup/improvements #7849

khaneliman commented Sep 20, 2025 •

edited

Loading

Uh oh!

ambroisie left a comment

Uh oh!

ambroisie Sep 23, 2025

Uh oh!

ambroisie Sep 23, 2025

Uh oh!

ambroisie Sep 23, 2025

Uh oh!

ambroisie Sep 23, 2025

Uh oh!

ambroisie Sep 23, 2025

Uh oh!

ambroisie Sep 23, 2025

Uh oh!

ambroisie Sep 23, 2025

Uh oh!

khaneliman Sep 23, 2025

Uh oh!

ambroisie Sep 23, 2025

Uh oh!

ambroisie Sep 23, 2025

Uh oh!

Uh oh!

Uh oh!

zsh: generated plugin loading cleanup/improvements #7849

Are you sure you want to change the base?

zsh: generated plugin loading cleanup/improvements #7849

Conversation

khaneliman commented Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

ambroisie left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

khaneliman commented Sep 20, 2025 •

edited

Loading