g6ai/dotfiles

My dotfiles for Bash/Zsh, Vim/Neovim, Doom Emacs, tmux, Git, terminal emulators, JupyterLab, aria2, mpv, Nix and Homebrew

Dotfiles

My dotfiles. Some of my considerations are explained in Wiki.

Deployment • Shell • Vim/Neovim • Doom Emacs • tmux • Git • Terminal emulators • Other config

More screenshots here.

Features

Deploy with ease and efficiency

chezmoi is used to bootstrap dotfiles.

• Deploy with shell one-liner:

  sh -c "$(curl -fsLS git.io/chezmoi)" -- init --apply g6ai

• Uses text/template syntax from Go extended with text template functions from sprig.

  For instance, here is a typical snippet in one of my dotfiles, init.vim.tmpl, residing in private_dot_config/nvim:

  {{ $x := splitList "_" .chezmoi.sourceFile /* private dot config/nvim/init.vim.tmpl */ -}}
  {{ $y := last $x | dir /* config/nvim */ -}}
  {{ $rtp := list "~/." $y | join "" /* ~/.config/nvim */ -}}
  {{ $vim_flag := .vim_flag -}}
  {{ template "vim/vimrc" dict "rtp" $rtp "os" .chezmoi.os "vim_flag" $vim_flag -}}

  It passes variables rtp, os and vim_flag to a common vimrc template in .chezmoitemplates/vim. This vimrc template contains both the actual config details and the logic operations which check the variables it receives on deployment, so it can generate different config per Vim variants (Vim or Neovim), OS (Linux or macOS) and other user-defined variables.

  Such snippets are extensively used in these dotfiles to manage config files of different environments in one place (.chezmoitemplates), keeping the resource-demanding logical operations at the deployment step rather than the runtime.

Shell

• rc.sh template is the runcom (run commands) file for both Linux and macOS.
• bashrc template uses the rc.sh template.
• zshrc template uses the rc.sh template, and utilizes Zim for fancy features.
• profile.sh template is used in both dot_bash_profile.tmpl and dot_zprofile.tmpl.
• run_append_motd is a Bash script to personalize motd, which is run by chezmoi.

Vim/Neovim

• The configs are located in the .chezmoitemplates/vim directory. They are then deployed to Vim and Neovim's runtime path.
  • Vim's vimrc.tmpl template and Neovim's init.vim.tmpl template use the versatile configs in vimrc template, which works for Linux, macOS and Windows! You can set if your system is good enough to enable plugins on chezmoi deployment.
  • Most of the vimrc's functionalities are divided and located in core directory.
• Neovim-specific config:
  • Adopts the mighty coc.nvim. Its config is coc-settings.json.
  • Some experimetal features in Neovim 0.5+ are also embraced:
    • nvim-treesitter, provides beautiful code highlighting and more.
    • telescope.nvim, next generation fuzzy finder.

Doom Emacs

• Configs for org-journal and Org-roam, to cooperate with beorg.

tmux

• tmux.conf defines tmux's style and key bindings, etc. Access to system clipboard is supported:
  • For macOS, pbcopy is used. pbcopy is installed on macOS by default.
  • For Linux, xclip is used. xclip needs to be installed. Within an SSH session, primary and/or clipboard content on the remote server can be sent to local machine by X11 forwarding.
• Helper scripts executable_update_display_vim.sh and executable_update_vim.sh update environment variable $DISPLAY and/or Vim/Neovim theme.

Git

Global dot_gitignore_global.tmpl per OS template. GitHub’s collection of .gitignore file templates are used.

Terminal emulators

From my experience, there's no perfect terminal emulator. I have tried Terminal.app, iTerm2, Alacritty, kitty and WezTerm. Currently I'm using WezTerm.

• wezterm folder includes the WezTerm configuration file wezterm.lua.
• kitty folder includes the kitty configuration file kitty.conf for different OS.
• alacritty folder includes the Alacritty configuration file alacritty.yml for different OS.

Other config

• dot_jupyter folder includes config files for JupyterLab configs. See config file and command line options of Jupyter Server for details.
  • jupytext.toml is the config file for Jupytext.
• dot_aria2 folder includes config file for aria2. See options section of aria2 documentation for more options.
• mpv folder includes config files for mpv. See mpv documentation for more options.
• macOS package manager:
  • darwin-configuration.nix contains config of nix-darwin.
  • Brewfile contains config of the Homebrew Bundle bundler.

dotfiles's Issues

Neovim over SSH clipboard: error: `Error: target STRING not available`

This could be reproduced on Linux with xclip installed.
Related issues: neovim/neovim#2642, neovim/neovim#7958 and svermeulen/vim-yoink#16.

`g:UltiSnipsEnableSnipMate` won't work if in plugin directory

See SirVer/ultisnips#1424.

Also 1d5a54a.

Telescope previewer shows wrong indentation

Specifically, the indent guides show this mistake.

Zsh vi-mode cursor not working well

`git diff --cached` shows no output

This is due to a 'bad pager', as explained in this SO answer. Specifically, some of the less options, -E and -F, cause less to automatically exit, as per less manual:

-E or --QUIT-AT-EOF
Causes less to automatically exit the first time it reaches end-of-file.

-F or --quit-if-one-screen
Causes less to automatically exit if the entire file can be displayed on the
first screen.

fd8115a sets $LESS to FR, causing the problem.

Wiki still contains dotbot deployment for windows

I'm guessing you've migrated from dotbot to chezmoi, which I'm also doing. I just noticed your windows deployment wiki section still has dotbot as your dotfile deployment manager.

I appreciate how much work you put into documenting all of these config files so other people can use it for reference, it's been very helpful!

CmdLine black box on startup

During Vim startup, the file name and some other file info showed in the cmdline and then disappears, then left a black box in the cmdline (as red arrow points in the snapshot).

better-escape.vim conflicts with Pear Tree's repeatable expand feature

Vim in tmux does not set cursor right

When I reopen Vim frequently in tmux, sometimes the normal mode cursor is the one of insert mode.

xclip does not close STDOUT, might be a problem

As of right now I use xclip to redirect tmux buffer. However, according to https://wiki.archlinux.org/index.php/Tmux#X_clipboard_integration :

Nevertheless, it is neater to use xsel because xclip does not close STDOUT after it has read from the tmux buffer. As such, tmux does not know that the copy task has completed, and continues to wait for xclip to terminate, thereby rendering tmux unresponsive. A workaround is to redirect STDOUT to /dev/null:

# Vim style
bind-key -T copy-mode-vi y send-keys -X copy-pipe-and-cancel "xclip -i -sel clip > /dev/null"
bind-key p run "xclip -o -sel clip | tmux load-buffer - ; tmux paste-buffer"

how to uninstall that

how to uninstall that

Bash prompt in tmux breaks when command reaches next line

Only happens in Bash prompt. Zsh prompt (using powerlevel10k) works well.

CoC interface broken in NeoVim

When I run :CocList extensions:

And when I run :CocInfo, the output opens in another buffer instead of vertical split. Then if I try to move to that buffer by ;bn:

Display problem in kitty SSH session with vim-airline

Relevant issues: kovidgoyal/kitty#348 and vim-airline/vim-airline#393.

Workaround for now (200ac14):

dotfiles/vim/vimrc

Lines 356 to 364 in 200ac14

	" Workaround for display problem in kitty SSH session
	if $TERM == 'xterm-kitty'
	augroup airline_init_kitty
	au!
	autocmd VimEnter * call airline#extensions#tabline#buffers#invalidate()
	autocmd VimEnter * AirlineRefresh
	autocmd VimEnter * redraw!
	augroup END
	endif

~/.profile already exists in some Linux machines

Directory colours not displayed when SSHing in Alacritty

When I SSH into other machine (tried Manjaro and Raspberry Pi OS) with terminfo set to alacritty in local machine (macOS), the directory colours are not displayed and is in black and white, even if I've installed alacritty terminfo on the remote machine.