Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neozenith/dotfiles
Personal Vim configuration and plugins under version control
https://github.com/neozenith/dotfiles
dotfile vim
Last synced: 3 months ago
JSON representation
Personal Vim configuration and plugins under version control
- Host: GitHub
- URL: https://github.com/neozenith/dotfiles
- Owner: neozenith
- Created: 2015-05-13T07:04:14.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T03:51:18.000Z (4 months ago)
- Last Synced: 2024-10-17T18:51:04.226Z (4 months ago)
- Topics: dotfile, vim
- Language: Vim Script
- Size: 19.9 MB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NeoZenith Vim dotFiles
## Brief
This is not intended as a public example of *good* management of VIM dotFiles
although I do make every attempt to apply best practices in maintaining this
configuration purely for my own ease of use and reference.
Like the Vim bonsai logo, it all starts with a seed and then you nurture
and prune it for your own environment. Each person's Vim journey is different
for this reason.
----
## Quick Start
A lot of this has evolved since I first started so the tooling and dev dependencies need updating.
### Some basics
- https://brew.sh/
```sh
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
```sh
brew install neovim node python3 pyenv
```
- https://ohmyz.sh/
```sh
sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
```
### The dotfiles
For now the thing that is constant is cloning this repo and copying some key _dotfiles_ that source into this repo.
Symlinks aren't always available so I have chosen to always cop these files that act as the symlinks.
```sh
DOTFILES=$HOME/dotfiles
[ ! -d "$HOME/dotfiles/.git" ] && git clone https://github.com/neozenith/dotfiles $HOME/dotfiles
[ ! -d "$HOME/dotfiles/zsh/scripts/aliases_work.sh" ] && touch $HOME/dotfiles/zsh/scripts/aliases_work.sh
[ ! -d "$HOME/dotfiles/bash/aliases_work.sh" ] && touch $HOME/dotfiles/scripts/aliases_work.sh
[ ! -d "$HOME/dotfiles/.vim/autoload/.git" ] && git clone https://github.com/junegunn/vim-plug.git $HOME/dotfiles/.vim/autoload
```
```sh
cp -rv $DOTFILES/.gitconfig ~/.gitconfig
cp -rv $DOTFILES/.zshrc_link ~/.zshrc
cp -rv $DOTFILES/.bashrc_link ~/.bashrc
cp -rv $DOTFILES/.vimrc_link ~/.vimrc
cp -rv $DOTFILES/.tmux_link.conf ~/.tmux.conf
cp -rv $DOTFILES/nvim ~/.config/nvim
```
```sh
eval "$(pyenv init --path)"
curl -fsSL https://raw.githubusercontent.com/neozenith/python-onboarding-guide/main/latest_penv_versions.py | python3
```
```sh
# Plugins: Install / Update / Prune
nvim +PlugInstall +PlugUpdate +PlugClean! +qall
nvim +checkhealth
```
List latest available Python3 versions in PyEnv
```sh
curl -fsSL https://raw.githubusercontent.com/neozenith/python-onboarding-guide/main/latest_penv_versions.py | python3
```
From here you'll have to manually explore the respective `/scripts/` folders for what is needed.
To change default shell to `zsh`.
```sh
sudo chsh -s /bin/zsh
```
----
## Highlights
- **Font**: [Sauce Code Pro][sauce-code-pro] [(Download link)][sauce-code-pro-download]
- **Plugin Manager**: [Vim Plug `junegunn/vim-plug`][vim-plug]
- Use any github repo slug to reference a plugin and it downloads in parallel. Quickest setup.
- **Autocomplete**: [YouCompleteMe `Valloric/YouCompleteMe`][ycm]
- Hooks into Vim's autocomplete API and depending upon filetype, it asynchronously uses the right parsing engine to reference the best autocomplete and even load documentation for function specs.
- **Linting Engine**: [ALE (Async Linting Engine) `w0rp/ale`][ale]
- I used to use [Syntastic][syntastic] for years but linting takes time and syntastic would lock up Vim. [ALE][ale] will dispatch async jobs so I can save and eventually it'll let me know whats up.
- Really good when paired with the following to have a cool status bar summary of failed lints:
- [Lightline `itchyny/lightline.vim`][lightline]
- [Lightline-ALE `maximbaz/lightline-ale`][lightline-ale]
- **File Management / Git**:
- [NerdTree `scrooloose/nerdtree`][nerdtree]
- [Vim-DevIcons `ryanoasis/vim-devicons`][vim-devicons]
- [NerdTree Git Plugin `Xuyuanp/nerdtree-git-plugin`][nerdtree-git]
- [Git Gutter `airblade/vim-gitgutter`][git-gutter]
[sauce-code-pro]: https://github.com/ryanoasis/nerd-fonts/blob/master/patched-fonts/SourceCodePro
[sauce-code-pro-download]: https://github.com/ryanoasis/nerd-fonts/releases/download/v1.2.0/SourceCodePro.zip
[vim-plug]: https://github.com/junegunn/vim-plug
[ycm]: https://github.com/Valloric/YouCompleteMe
[ale]: https://github.com/w0rp/ale
[syntastic]: https://github.com/vim-syntastic/syntastic
[lightline]: https://github.com/itchyny/lightline.vim
[lightline-ale]: https://github.com/maximbaz/lightline-ale
[nerdtree]: https://github.com/scrooloose/nerdtree
[vim-devicons]: https://github.com/ryanoasis/vim-devicons
[nerdtree-git]: https://github.com/Xuyuanp/nerdtree-git-plugin
[git-gutter]: https://github.com/airblade/vim-gitgutter
----
## Screenshots
![Vim sample with file explorer][sample1]
![Vim sample with autocomplete][sample2]
[sample1]: https://raw.githubusercontent.com/neozenith/vim-dotfiles/master/images/example1.png
[sample2]: https://raw.githubusercontent.com/neozenith/vim-dotfiles/master/images/example2.png
----
## Git Bash Prompt
![Screenshot of Git Prompt][gitprompt]
Inspired by the beautiful piece of bash scripting that is [Git Radar](https://github.com/michaeldfallen/git-radar)
yet having been in companies where due to their git security setup it made git-radar unusable.
So I have built out a basic version of `git-radar`. This version does not run
git fetch automatically in the background so you will need to run that manually.
[gitprompt]: https://raw.githubusercontent.com/neozenith/vim-dotfiles/master/images/git-prompt.png
If you want it without my complete dotfiles setup then:
Download [`bash-scripts/function_parse_git_prompt.sh`](https://github.com/neozenith/dotfiles/blob/master/bash-scripts/function_parse_git_prompt.sh)
to your home directory
```bash
curl -o $HOME/function_parse_git_prompt.sh https://github.com/neozenith/dotfiles/blob/master/bash-scripts/function_parse_git_prompt.sh
```
and add the following to your `.bash_profile` or `.bashrc`.
```bash
source $HOME/function_parse_git_prompt.sh
export PS1="\e[0;32m\w\e[m"
export PS1="$PS1 \$(parse_git_prompt)"
export PS1="$PS1\nλ "
```
----
## Developing and Maintaining
**.vimrc**
- The key entry file for vim configuration.
- This should only source vim scripts for features and commenting
out one shouldn't affect others.
**.vim/mysubcript.vim**
- Supporting files are located in `.vim/` and are *sourced* using the `runtime`
path.
**install.sh / install.bat**
- These have 5-7 goals:
- Install supporting tools like Ruby / Python / CMake / Node
- *(Optional)* Install and build latest Vim from Source
- Install `.vimrc`
- Install `.vim/` and associated `.vim/*.vim` scripts.
- Install Vim-Plug into `.vim/bundle/Plug.vim/autoload`
- Start Vim to run `vim +PlugInstall +PlugUpdate +qall` to install
plugins managed by Plug.
- *(Optional)* Build and install [YouCompleteMe][ycm]
- Rerunning the *install.sh / install.bat* should shortcut the install
and just update plugins.
**nvim/init.vim**
- This file should not change but will get symlinked to `~/.config/nvim/init.vim`
- This file will `source ~/.vimrc` and match existing plugin configuration.
----
## Plugins
### Update Plugins
```
vim +PlugUpdate +qall
```
## Adding Plugins
See [Plug documentation][plug-docs]
[plug-docs]: https://github.com/junegunn/vim-plug#example
----
## Resources and Training
_Getting Started and Getting Advanced with Vim_
These blogs have been hugely influential and informative in making the switch.
**Onboarding**
- `vimtutor`
- [Vim Adventures][vim-adventures] - Online game of Vim Tutor
**Core**
- [VimCasts][vimcasts] - Video Tutorials
- [VimCasts Modal Editting and Repetition][vimcasts-repetition]
- [VimCasts Sharpening the Saw][vimcasts-sharpeningthesaw]
- [Vim Text Objects: The Definitive Guide][text-objects]
- [Vim Revisted][vim-revisited] - Good for explaining core navigation shortcuts
- [Coming Home to Vim - Steve Losh][coming-home]
**Extending**
- [Doug Black - A Good Vimrc][dougblack-goodvimrc]
- [Thorsten Ball's Vim Resources][thorsten-ball-vim-resources]
[vimcasts]: http://vimcasts.org/
[vimcasts-repetition]: http://vimcasts.org/episodes/modal-editing-undo-redo-and-repeat/
[vimcasts-sharpeningthesaw]: http://vimcasts.org/blog/2012/08/on-sharpening-the-saw/
[text-objects]: http://blog.carbonfive.com/2011/10/17/vim-text-objects-the-definitive-guide/
[vim-revisited]: http://mislav.net/2011/12/vim-revisited/
[coming-home]: http://stevelosh.com/blog/2010/09/coming-home-to-vim/
[dougblack-goodvimrc]: https://dougblack.io/words/a-good-vimrc.html
[thorsten-ball-vim-resources]: https://thorstenball.com/blog/2012/07/09/vim-learning-resources/
[vim-adventures]: https://vim-adventures.com/
----
## Credits
- [Tim Pope](https://github.com/tpope)
- [Drew Neil](https://github.com/nelstrom)
- [Steve Losh](https://bitbucket.org/sjl/)
- [Thorsten Ball](https://github.com/mrnugget)
- [Alessandro Pezzato](https://github.com/alepez)
- [Mislav Marohnić](https://github.com/mislav)
Huge thanks for everything you have done for the VIM community.