Break up Zsh configuration files by dysfungi · Pull Request #265 · holman/dotfiles

dysfungi · 2016-12-12T00:13:00Z

Depends on #246

Utilize:

zshenv
1. **/*path.zsh (except **/*fpath.zsh)
2. **/*env.zsh
zprofile
1. **/*profile.zsh
zshrc
1. **/*fpath.zsh
2. **/*.zsh (except **/*completion.zsh, **/*path.zsh, **/*env.zsh, **/*profile.zsh, **/*login.zsh, **/*logout.zsh)
3. **/*completion.zsh
zlogin
1. **/*login.zsh
zlogout
1. **/*logout.zsh

Benefits

Inclusion of zprofile/zlogin and zlogout allow for specific files to be sourced when shell is a login shell. Useful for printing todo files, fortune, or cowsay files and scripts.
Inclusion of zshenv allows for non-interactive shells to still have the proper environment setup. That especially matters for any scripts that use #!/bin/zsh and are run as cronjobs.
zshrc is still the primary file with exception of environment variables moving to zshenv.

Using `$ZSH` for the project root directory conflicts with zsh projects and plugins (e.g., oh-my-zsh). Change `$ZSH` -> `$DOTFILES`. WIP: #8/b

1. zshenv: path.zsh, env.zsh 2. zprofile: profile.zsh 3. zshrc: *.zsh, completion.zsh 4. zlogin: login.zsh 5. zlogout: logout.zsh WIP: #10

1. zshenv: *path.zsh, *env.zsh, *alias.zsh, *aliases.zsh 2. zprofile: *profile.zsh 3. zshrc: *fpath.zsh, *.zsh, *completion.zsh 4. zlogin: *login.zsh 5. zlogout: *logout.zsh WIP: #10

carhartl · 2016-12-16T11:28:06Z

zsh/zshrc.symlink

+typeset -U fpath_files interactive_files completion_files
+fpath_files=($DOTFILES/**/*fpath.zsh)
+interactive_files=($DOTFILES/**/*.zsh~**/*completion.zsh~**/*path.zsh~**/*env.zsh~**/*alias.zsh~**/*aliases.zsh~**/*profile.zsh~**/*login.zsh~**/*logout.zsh)
+completion_file=($DOTFILES/**/*completion.zsh)


This needs to be completion_files...?

Yes, thank you

carhartl · 2016-12-16T23:18:15Z

zsh/zshrc.symlink

+# all of our non-path/env/profile/login/logout zsh files
+typeset -U fpath_files interactive_files completion_files
+fpath_files=($DOTFILES/**/*fpath.zsh)
+interactive_files=($DOTFILES/**/*.zsh~**/*completion.zsh~**/*path.zsh~**/*env.zsh~**/*alias.zsh~**/*aliases.zsh~**/*profile.zsh~**/*login.zsh~**/*logout.zsh)


I believe ~**/*aliases.zsh doesn't belong here. Otherwise aliases defined in zsh/aliases.zsh won't be sourced...

Another good catch. Remnants of considering to source alias files in zshenv. Decided it was best to consider aliases as interactive only.

WIP: #10 Review: holman#265

carhartl · 2016-12-17T20:00:33Z

Having read about startup files, according to http://zsh.sourceforge.net/Intro/intro_3.html:

`.zprofile' is meant as an alternative to `.zlogin' for ksh fans; the two are not intended to be used together

Should we even keep a .zprofile around?

dysfungi · 2016-12-17T20:25:23Z

Pros for `.zprofile`

the two are not intended to be used together, although this could certainly be done if desired

My intent was to not be exclusive or make the decision for people.
I added notes at the top of the two files to point out this concern.
There could still be a use for.zprofile as it gets sourced before .zshrc, unlike .zlogin which is sourced after.
.profile has long been a file of importance for shells. I think including the additional **/*profile.zsh files can offer more separation of configuration files.
Startup time is probably negligible globbing for **/*profile.zsh.

Cons for `.zprofile`

the two are not intended to be used together

May cause confusion with regards to .zlogin.
Slower startup time globbing for **/*profile.zsh and excluding it from **/*.zsh in .zshrc interactive files.

Conclusion

Overall, I don't think it hurts to keep .zprofile. If you worry it may cause confusion, the file is small which makes the note at the top likely to be read.

If .zprofile were also sourced after .zshrc, then I would lean towards its removal. However, this is not the case.

As .zprofile is still a ZSH startup file, I would prefer to keep it.

carhartl · 2016-12-17T20:34:40Z

👍 Thanks for clarifying @Defrank, makes sense (I'm still new to zsh).

dysfungi · 2016-12-17T21:21:06Z

Yeah don't worry. I'm no expert either. Thanks for reviewing!

WIP: #10

carhartl · 2016-12-26T11:19:52Z

Another problem I only noticed now: excluding ~**/*env.zsh in interactive_files leads to ruby/rbenv.zsh no longer being sourced, rendering rbenv setup broken... should we maybe presume that topic based env files will have to be named zshenv.zsh, e.g. topic/zshenv.zsh (and then same for all the other startup files)? Would make sense to me.

carhartl · 2016-12-26T18:58:23Z

I think there's also room for simplification if we were to adopt the suggested naming scheme. All topic path.zsh files would become zshenv.zsh, removing the need for maintaining both path_files=($DOTFILES/**/*path.zsh) and env_files=($DOTFILES/**/*env.zsh).

dysfungi · 2016-12-26T20:05:23Z

I think I'd rather just remove the wildcard prefix feature. It is an overcomplication.

zshenv
- ~~**/*path.zsh~~ **/path.zsh
- ~~**/*env.zsh~~ **/env.zsh
zprofile
- ~~**/*profile.zsh~~ **/profile.zsh
zshrc
- ~~**/*fpath.zsh~~
- ~~**/*.zsh~**/*completion.zsh~**/*path.zsh~**/*env.zsh~**/*profile.zsh~**/*login.zsh~**/*logout.zsh~~ **/*.zsh~**/completion.zsh~**/path.zsh~**/env.zsh~**/profile.zsh~**/login.zsh~**/logout.zsh
- ~~**/*completion.zsh~~ **/completion.zsh
zlogin
- ~~**/*login.zsh~~ **/login.zsh
zlogout
- ~~**/*logout.zsh~~ **/logout.zsh

This will allow rbenv.zsh to be sourced as an interactive file instead of an environment file. I suspect it was being sourced too early.

I will probably also want to rename system/_path.zsh --> system/path.zsh.

--static doesnt exist anymore

WIP: dysfungi/dotfiles#10 Review: holman/dotfiles#265

Derek Michael Frank added 3 commits July 17, 2016 13:13

fix(zsh): Change project directory environment variable

9066533

Using `$ZSH` for the project root directory conflicts with zsh projects and plugins (e.g., oh-my-zsh). Change `$ZSH` -> `$DOTFILES`. WIP: #8/b

feat(zsh): Break up Zsh configuration files

aede5ea

1. zshenv: path.zsh, env.zsh 2. zprofile: profile.zsh 3. zshrc: *.zsh, completion.zsh 4. zlogin: login.zsh 5. zlogout: logout.zsh WIP: #10

feat(zsh): Find Zsh config files using suffixes

6c3365c

1. zshenv: *path.zsh, *env.zsh, *alias.zsh, *aliases.zsh 2. zprofile: *profile.zsh 3. zshrc: *fpath.zsh, *.zsh, *completion.zsh 4. zlogin: *login.zsh 5. zlogout: *logout.zsh WIP: #10

carhartl reviewed Dec 16, 2016

View reviewed changes

Derek Michael Frank added 2 commits December 17, 2016 10:33

fix(zsh): Completion files variable typo

03dca6c

WIP: #10 Review: holman#265

fix(zsh): Source alias files as interactive files

b6568f0

WIP: #10 Review: holman#265

dysfungi mentioned this pull request Dec 17, 2016

Break up ZSH config files dysfungi/dotfiles#10

Open

5 tasks

docs(readme): Update for Zsh configuration file break up

0011734

WIP: #10

Derek Michael Frank added 2 commits May 27, 2018 14:50

Merge branch 'upstream/master' into pr/zsh-config-files

b00f261

fix(zsh): Disable wildcard prefix of special ZSH rc files

051b85c

dysfungi force-pushed the pr/zsh-config-files branch from 0d7428a to 051b85c Compare May 27, 2018 22:06

Derek Michael Frank added 2 commits May 27, 2018 15:16

Merge remote-tracking branch 'upstream/master' into pr/zsh-config-files

16f310d

fix(zsh-prompt): Update variable of dotfile path

d190735

ajdexter pushed a commit to ajdexter/dotfiles that referenced this pull request Jan 5, 2019

Merge pull request holman#265 from caarlos0/antibody-v2

fa2bfa5

--static doesnt exist anymore

lgo pushed a commit to lgo/dotfiles that referenced this pull request Jun 5, 2021

fix(zsh): Completion files variable typo

7c761b3

WIP: dysfungi/dotfiles#10 Review: holman/dotfiles#265

lgo pushed a commit to lgo/dotfiles that referenced this pull request Jun 5, 2021

fix(zsh): Source alias files as interactive files

426a226

WIP: dysfungi/dotfiles#10 Review: holman/dotfiles#265

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Break up Zsh configuration files#265

Break up Zsh configuration files#265
dysfungi wants to merge 10 commits intoholman:masterfrom
dysfungi:pr/zsh-config-files

dysfungi commented Dec 12, 2016

Uh oh!

carhartl Dec 16, 2016

Uh oh!

dysfungi Dec 17, 2016

Uh oh!

carhartl Dec 16, 2016 •

edited

Loading

Uh oh!

dysfungi Dec 17, 2016 •

edited

Loading

Uh oh!

carhartl commented Dec 17, 2016

Uh oh!

dysfungi commented Dec 17, 2016 •

edited

Loading

Uh oh!

carhartl commented Dec 17, 2016 •

edited

Loading

Uh oh!

dysfungi commented Dec 17, 2016

Uh oh!

carhartl commented Dec 26, 2016

Uh oh!

carhartl commented Dec 26, 2016

Uh oh!

dysfungi commented Dec 26, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

dysfungi commented Dec 12, 2016

Utilize:

Benefits

Uh oh!

carhartl Dec 16, 2016

Choose a reason for hiding this comment

Uh oh!

dysfungi Dec 17, 2016

Choose a reason for hiding this comment

Uh oh!

carhartl Dec 16, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dysfungi Dec 17, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

carhartl commented Dec 17, 2016

Uh oh!

dysfungi commented Dec 17, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pros for .zprofile

Cons for .zprofile

Conclusion

Uh oh!

carhartl commented Dec 17, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dysfungi commented Dec 17, 2016

Uh oh!

carhartl commented Dec 26, 2016

Uh oh!

carhartl commented Dec 26, 2016

Uh oh!

dysfungi commented Dec 26, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

carhartl Dec 16, 2016 •

edited

Loading

dysfungi Dec 17, 2016 •

edited

Loading

dysfungi commented Dec 17, 2016 •

edited

Loading

Pros for `.zprofile`

Cons for `.zprofile`

carhartl commented Dec 17, 2016 •

edited

Loading