Ideal order of loading the plugins ? #543

xd003 · 2024-08-27T18:50:35Z

xd003
Aug 27, 2024

Hello, i was wondering what should be the ideal order of loading the plugins

I currently have the plugins defined in following order in .zimrc file

zmodule zsh-users/zsh-completions --fpath src
zmodule zsh-users/zsh-syntax-highlighting
zmodule zsh-users/zsh-history-substring-search
zmodule zsh-users/zsh-autosuggestions
zmodule Aloxaf/fzf-tab
zmodule ohmyzsh/ohmyzsh --root plugins/sudo
zmodule ohmyzsh/ohmyzsh --root plugins/command-not-found

And my .zshrc file is as follows -

# Source/Load zim
source "${ZIM_HOME}/init.zsh"

# Load completions
autoload -Uz compinit && compinit

# Use oh my posh prompt
eval "$(oh-my-posh init zsh --config $XDG_CONFIG_HOME/oh-my-posh/p10k.toml)"

# History
HISTSIZE=5000
HISTFILE=~/.zsh_history
SAVEHIST=$HISTSIZE
HISTDUP=erase
setopt appendhistory
setopt sharehistory
setopt hist_ignore_space
setopt hist_ignore_all_dups
setopt hist_save_no_dups
setopt hist_ignore_dups
setopt hist_find_no_dups

# Completion styling
zstyle ':completion:*' matcher-list 'm:{a-z}={A-Za-z}'
zstyle ':completion:*' list-colors "${(s.:.)LS_COLORS}"
zstyle ':completion:*' menu no
zstyle ':fzf-tab:complete:cd:*' fzf-preview 'ls --color $realpath'
zstyle ':fzf-tab:complete:__zoxide_z:*' fzf-preview 'ls --color $realpath'

# Source zsh aliases & functions file
source "$ZDOTDIR/.zsh_aliases_functions"

# Shell integrations
eval "$(fzf --zsh)"
eval "$(zoxide init --cmd cd zsh)"

Is there anything you would recommend changing for better startup times and/or overall functionality of the plugins

Answered by ericbn

Aug 27, 2024

You'll find the recommended order here: https://github.com/zimfw/install/blob/master/src/templates/zimrc

It's

# Start configuration added by Zim install {{{
#
# This is not sourced during shell startup, and it's only used to configure the
# zimfw plugin manager.
#

#
# Modules
#

# Sets sane Zsh built-in environment options.
zmodule environment
# Provides handy git aliases and functions.
zmodule git
# Applies correct bindkeys for input events.
zmodule input
# Sets a custom terminal title.
zmodule termtitle
# Utility aliases and functions. Adds colour to ls, grep and less.
zmodule utility

#
# Prompt
#

# Exposes to prompts how long the last command took to execute, used by asciiship.
zmod…

View full answer

ericbn · 2024-08-27T20:36:32Z

ericbn
Aug 27, 2024
Maintainer

You'll find the recommended order here: https://github.com/zimfw/install/blob/master/src/templates/zimrc

It's

# Start configuration added by Zim install {{{
#
# This is not sourced during shell startup, and it's only used to configure the
# zimfw plugin manager.
#

#
# Modules
#

# Sets sane Zsh built-in environment options.
zmodule environment
# Provides handy git aliases and functions.
zmodule git
# Applies correct bindkeys for input events.
zmodule input
# Sets a custom terminal title.
zmodule termtitle
# Utility aliases and functions. Adds colour to ls, grep and less.
zmodule utility

#
# Prompt
#

# Exposes to prompts how long the last command took to execute, used by asciiship.
zmodule duration-info
# Exposes git repository status information to prompts, used by asciiship.
zmodule git-info
# A heavily reduced, ASCII-only version of the Spaceship and Starship prompts.
zmodule asciiship

#
# Completion
#

# Additional completion definitions for Zsh.
zmodule zsh-users/zsh-completions --fpath src
# Enables and configures smart and extensive tab completion.
# completion must be sourced after all modules that add completion definitions.
zmodule completion

#
# Modules that must be initialized last
#

# Fish-like syntax highlighting for Zsh.
# zsh-users/zsh-syntax-highlighting must be sourced after completion
zmodule zsh-users/zsh-syntax-highlighting
# Fish-like history search (up arrow) for Zsh.
# zsh-users/zsh-history-substring-search must be sourced after zsh-users/zsh-syntax-highlighting
zmodule zsh-users/zsh-history-substring-search
# Fish-like autosuggestions for Zsh.
zmodule zsh-users/zsh-autosuggestions
# }}} End configuration added by Zim install

Usually any new modules would go above # Prompt

# <-- new modules here

#
# Prompt
#

unless their documentation states that they should be initialized in a specific order.

For example, according to https://github.com/Aloxaf/fzf-tab/blob/master/README.md#install, this plugin should be initialized after zmodule completion and before zmodule zsh-users/zsh-syntax-highlighting. You should always check the documentation of all modules you're planning to install.

Also, if you use zmodule completion, which I recommend you do so you can initialize the completion in the proper order, then remove the autoload -Uz compinit && compinit from your .zshrc.

3 replies

xd003 Aug 28, 2024
Author

Thanks for the heads up, i have arranged my .zimrc as per the template and done all the other changes. .zimrc is now as follows

# Modules
zmodule environment
zmodule fzf
zmodule ohmyzsh/ohmyzsh --root plugins/sudo
zmodule ohmyzsh/ohmyzsh --root plugins/command-not-found

# Completions
zmodule zsh-users/zsh-completions --fpath src
zmodule completion

# Modules that must be initialized last
zmodule kiesman99/zim-zoxide
zmodule Aloxaf/fzf-tab
zmodule zsh-users/zsh-syntax-highlighting
zmodule zsh-users/zsh-history-substring-search
zmodule zsh-users/zsh-autosuggestions

I noticed that the template recommends the following order: Normal modules -> Prompt -> Completions -> End Modules
But my prompt is from oh my posh which is called externally and not really from zsh so i am quite unsure if i should initialise it before zim or after. oh-my-posh documentation doesn't mention anything about the order per se. At the moment, i have kept the .zshrc as follows

# Use oh my posh prompt
eval "$(oh-my-posh init zsh --config $XDG_CONFIG_HOME/oh-my-posh/p10k.toml)"

# Source/Load zim
source "${ZIM_HOME}/init.zsh"

# Source zsh aliases & functions file
source "$ZDOTDIR/.zsh_aliases_functions"

antoineco Aug 28, 2024

Oh my Posh is an external program, not a Zsh module, so it can be loaded anywhere inside your .zshrc file.

xd003 Aug 28, 2024
Author

Thanks for confirming, marking this thread as solved

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Ideal order of loading the plugins ? #543

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 1 comment 3 replies

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

Ideal order of loading the plugins ? #543

Uh oh!

Uh oh!

xd003 Aug 27, 2024

Replies: 1 comment · 3 replies

Uh oh!

ericbn Aug 27, 2024 Maintainer

Uh oh!

Uh oh!

xd003 Aug 28, 2024 Author

Uh oh!

antoineco Aug 28, 2024

Uh oh!

xd003 Aug 28, 2024 Author

xd003
Aug 27, 2024

Replies: 1 comment 3 replies

ericbn
Aug 27, 2024
Maintainer

xd003 Aug 28, 2024
Author

xd003 Aug 28, 2024
Author