zsh: refactor zsh configuration for better order control over .zshrc
#6479
Conversation
Emin017
force-pushed
the
zsh-shellInitLast
branch
from
b5e6cca to
394b2d9
Compare
Add a new option called `initExtraLast` to the zsh module. This option allows users to specify shell script code that will be executed as the last step during interactive zsh shell initialization. Signed-off-by: Qiming Chu <[email protected]>
Emin017
force-pushed
the
zsh-shellInitLast
branch
from
394b2d9 to
315ce87
Compare
Emin017
changed the title
initContents option for custom .zshrc content insertion
- Users can add content anywhere by using `lib.mkOrder`, `lib.mkBefore` and `lib.mkAfter` custom configurations. - Add test cases to verify the insertion of content before and after existing configurations in `.zshrc`. Signed-off-by: Qiming Chu <[email protected]>
Emin017
force-pushed
the
zsh-shellInitLast
branch
from
5879b08 to
472e79e
Compare
modules/programs/zsh.nix
Outdated
| @@ -616,158 +622,162 @@ in | |||
| ++ optional cfg.enableCompletion pkgs.nix-zsh-completions | |||
| ++ optional cfg.oh-my-zsh.enable cfg.oh-my-zsh.package; | |||
|
|
|||
| home.file."${relToDotDir ".zshrc"}".text = concatStringsSep "\n" ([ | |||
| programs.zsh.initContents = mkMerge [ | |||
There was a problem hiding this comment.
the introduction of initContents is something I would like to avoid.
Can we keep home.file."${relToDotDir ".zshrc"}".text or use initExtra instead ?
There was a problem hiding this comment.
In the new commit, I've modified the implementation to use initExtra instead of introducing initContents as you requested.
My concern is:
To maintain compatibility, we should ensure that:
- The final .zshrc content maintains the same order of components
- Any user-provided
initExtracontent still appears in the same location (Just as they used before)
I'm having a bit of a headache assigning this content order (I want to the default insertion order of initExtra is on the same location like before), do we need to consider the compatibility of the initExtra option? Or is this fine for now?
There was a problem hiding this comment.
The final .zshrc content maintains the same order of components
That would be ideal but it doesn't have to be 100% exact. The improvement you submitted solves several open issues so we can have small changes and the tradeoff would still be good.
Any user-provided initExtra content still appears in the same location (Just as they used before)
not sure what you mean. Seems like a good thing.
Or is this fine for now?
I think it is but I am not a specialist of the merging of elements in the module, I might have missed something.
|
thanks for taking on this huge work. I am quite looking forward to it. |
- Renamed `initContents` to `initExtra` for consistency and clarity - Updated related test files to reflect the change - Added a new test file `zshrc-contents-insert.nix` to ensure proper functionality Signed-off-by: Qiming Chu <[email protected]>
Emin017
force-pushed
the
zsh-shellInitLast
branch
from
776daea to
f1fdc33
Compare
Emin017
changed the title
initContents option for custom .zshrc content insertion.zshrc
|
on a quick glance it looks fine by me. I have follow up ideas but merging this first is better, it's the hardest part. diffing my ~/.zshrc with and without this just shows a few different newlines which is fine. I would like to let this cook a few days to give the opportunity for users with different zsh setups test this since it's a "dangerous" change :) |
Changed the initialization order of `zprof` from 500 to 400 in `zsh.nix` to ensure it loads before other shell initialization steps, as it benchmarks the shell initialization process. Signed-off-by: Qiming Chu <[email protected]>
This commit introduces a new test file `zshrc-contents-init-zprof.nix` to verify the initialization of `zprof` in the `.zshrc` file. The test ensures that the `.zshrc` file exists and contains the expected `zmodload zsh/zprof` command. Signed-off-by: Qiming Chu <[email protected]>
Description
zsh.nixto usemkMergeandmkOrderfor better control over.zshrccontent orderinglib.mkOrder,lib.mkBeforeandlib.mkAftercustom configurationszshrc-contents-insert.nix,zshrc-contents-insert-before.nix,zshrc-contents-insert-after.nix) to verify the behavior ofinitExtrawithmkBefore,mkAfter, and default insertion.Checklist
Change is backwards compatible.
Code formatted with
./format.Code tested through
nix-shell --pure tests -A run.allor
nix build --reference-lock-file flake.lock ./tests#test-allusing Flakes.Test cases updated/added. See example.
Commit messages are formatted like
See CONTRIBUTING for more information and recent commit messages for examples.
If this PR adds a new module
Maintainer CC