Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/haydenrou/dotfiles

My Personalised Development Environment
https://github.com/haydenrou/dotfiles

dotfiles fzf golang javascript lua neovim nvim react ruby skhd tmux typescript vim vimrc yabai zsh

Last synced: 10 days ago
JSON representation

My Personalised Development Environment

Awesome Lists containing this project

README 

        


    
haydenrou/dotfiles


    My Personalized Development Environment







![Dotfiles Demo](https://i.imgur.com/F3wxfe1.jpeg)



To prevent myself from going down wild Linux rabbit holes and trying every distribution I can get my hands on, I've transcended into an Apple chad. Therefore, this configuration may require changes to work in a Linux environment.



## Mandatory Software:



- [neovim](https://github.com/neovim/neovim)

- [tmux](https://github.com/tmux/tmux)

- [yabai](https://github.com/koekeishiya/yabai) & [skhd](https://github.com/koekeishiya/skhd)

  - As part of the [yabairc](./yabai/yabairc), we use [jankyborders](https://github.com/FelixKratz/JankyBorders)

- [ripgrep](https://github.com/BurntSushi/ripgrep)

- [fzf](https://github.com/junegunn/fzf)

- [zsh](https://www.zsh.org/)

- [sketchybar](https://felixkratz.github.io/SketchyBar/setup)

  - As part of the scripts (see [here for example](./sketchybar/scripts/highlight_space.sh)) we need [jq](https://github.com/jqlang/jq)

  - Make sure you create a `sketchybar/scripts/weather.env.sh` file containing the values for `WEATHER_KEY=123` and `WEATHER_CITY=London`



### Optional Software: (Warning: you may have to remove some alises / plugins if these are not installed)

- [bat](https://github.com/sharkdp/bat)

- [eza](https://github.com/eza-community/eza)

- [zoxide](https://github.com/ajeetdsouza/zoxide)

- [todoist_helper](https://github.com/haydenrou/todoist_helper)

- [neofetch](https://github.com/dylanaraps/neofetch)

- [tmate](https://tmate.io/)

- [btop](https://github.com/aristocratos/btop)

- [alacritty terminal](https://alacritty.org/)

- [zoxide](https://github.com/ajeetdsouza/zoxide)

- [nerd fonts](https://www.nerdfonts.com/font-downloads) for devicons to display in nvim-tree

    - for instance, `brew tap homebrew/cask-fonts && brew install --cask font-commit-mono-nerd-font`, and added to your terminal (see [./alacrity/config.yml](./alacrity/config.yml))

- [cmake](https://cmake.org/) `brew install cmake` or else the installation of telescopes fzf plugin will fail

- [fd](https://github.com/sharkdp/fd) as an optional dependency of telescope, used in telescope.lua

- [gpgtools](https://gpgtools.org/) for signing commits. (Note: instead of symlinking `git/.gitconfig`, copy it instead as you'll need to add a signingkey)



## File Structure:



Most files in this repo are structured so that you can symlink the directory directly into `~/.config`, except for a few that need to live in different places such as `zshrc`.



## Neovim Plugins:



Using [lazy.nvim](https://github.com/folke/lazy.nvim) as a plugin manager, here are the plugins used:



- [goolord/alpha-nvim](https://github.com/goolord/alpha-nvim) for the dashboard (see the asciis in utils)

- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) for fuzzy finding

- [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) for code parsing etc

- [rose-pine/neovim](https://github.com/rose-pine/neovim) as a colour scheme. an equivalent is used for tmux and alacritty themes too

- [mason.nvim](https://github.com/williamboman/mason.nvim) is used in conjunction with lsp-zero to manage your different LSPs

- [lsp-zero.nvim](https://github.com/VonHeikemen/lsp-zero.nvim) to use NeoVim's LSP client

- [harpoon](https://github.com/ThePrimeagen/harpoon) is used for silky smooth file movement

- [undotree](https://github.com/mbbill/undotree) for all your accidental undo's

- [vim-fugitive](https://github.com/tpope/vim-fugitive) for git within vim

- [vim-rhubarb](https://github.com/tpope/vim-rhubarb) primarily just for `:GBrowse` - going to the file you're in, in your browser

- [copilot.vim](https://github.com/github/copilot.vim) to let robots do our work for us

- [nvim-tree.lua](https://github.com/nvim-tree/nvim-tree.lua) for a better than nerdtree experience

- [nvim-tree/nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons) for icons

- [lualine.nvim](https://github.com/nvim-lualine/lualine.nvim) a good looking statusline

- [Comment.nvim](https://github.com/numToStr/Comment.nvim) to comment out your broken code

- [nvim-surround](https://github.com/kylechui/nvim-surround) to surround whatever you want, with whatever you want

- [conform.nvim](https://github.com/stevearc/conform.nvim) to enable formatters such as eslint

- [vim-dadbod](https://github.com/tpope/vim-dadbod/) for mysql connections and queries in vim



## Notable Settings:



- Line numbers and relative numbers are turned on.

- Line wrapping is turned off.

- The grep program for searching is set to ripgrep.

- Trailing whitespace is automatically stripped on buffer write.



## Binds:



### General:



- `` is set to ``

- `sp` will spell the previous word correctly.

- `n` and `N` after a search will reposition the cursor to the center of the screen for better visibility.

- `J` combines the next line with the current line, ensuring the cursor remains at the beginning of the combined line.

- `` and `` scroll half a screen down or up while keeping the cursor position fixed.

- `` clears the search highlight.

- `J` (Visual Mode) and `K` (Visual Mode) move the selected lines down (`J`) or up (`K`) in visual mode.

- `y` and `Y` yank the current line (`y`) or from the cursor to the end of the line (`Y`) to the system clipboard.

- `p` and `d` paste (`p`) or delete (`d`) without copying to the buffer.

- `f` formats the current buffer using the LSP (Language Server Protocol).

- `` and `` navigate through the quickfix list, ensuring the cursor position is centered.

- `` + `h,j,k,l` move your cursor to different windows.

- `s` performs a case-insensitive search and replace across the entire buffer, prompting for confirmation.

- `r` toggles relative line numbers.

- `K` (Normal Mode) to show documentation.

- `+` and `-` vertically enlarge or reduce a pane.

- `co` and `cc` open and close the quickfix list.



[A random list of handy vim commands](./docs/vimbits.md)



### Plugin-Specific Keybinds:



- **Copilot:**

  - In insert mode, `` will complete the suggestion.



- **Fugitive:**

  - `gs` will open git in nvim.

  - `gdf` will open a git diff of the current file.



- **Harpoon:**

  - `a` will add to the list.

  - `e` will open the list. This is changeable using general vim motions, such as deleting or moving a line below.



- **Rhubarb:**

  - `gb` will open the browser to the current file.



- **Surround:**

  - `ys{motion}{wrapper}` will surround with the `{wrapper}` variable. This also works in `visual` mode.



- **Telescope:**

  - Use `\` for a fuzzy project word search.

  - `` to search files.

  - `` to search files that aren't in git.

  - `b` to browse your buffer files.

  - Pressing tab to select from the list, then following with `` will open a quickfix list



- **Tree:**

  - `nn` to open the file tree.

  - `nf` to find the current file in the tree. Use `a` to add files, `d` to delete, and `r` to rename from the tree.



- **Undotree:**

  - `u` to open undotree.



- **Dadbod:**

  - `db` to open the database UI.



## LSPs (Language Server Protocols):



By default, the following LSPs will be installed:

- `ts_ls` for typescript. (old: `tsserver`)

- `eslint` for eslint.

- `solargraph` for ruby.

- `lua_ls` for lua.

- `tailwindcss` for tailwind.

- `rust_analyzer` for rust.

- `gopls` for golang.

- `jsonls` for json.

- `emmet_ls` for emmet html.



### Bindings:



- Pressing `Tab` (or `Shift-Tab`) completes your LSP suggestions.

- Pressing `` populates the currently selected tab.

- `[g` and `]g` will go to the previous and next diagnostics error respectively.

- `gd` will go to definition.

- `gr` will go to references.

- `cr` will rename the currently highlighted variable.

- `vca` will display code actions.

- `cf` will apply the quickfix code action.



Additionally, use `` to open the completion menu if it's not automatically open.



## Aliases:



### Zsh



A full list of zsh aliases live under [./zsh/aliases.zsh](./zsh/aliases.zsh), but here are a few:



- `vi` and `vim` are aliased to `nvim`.

- `ga` and `gaa` alias git add for staging changes for either a specified file or all unstaged files.

- `gap` prompts for interactive staging with `git add -p`.

- `gb` shows the Git branch, and `gc` initiates a Git commit.

- `gca` combines `git add .` and `git commit`.

- `gco` is a shortcut for `git checkout`.

- `gcob` allows you to interactively switch Git branches.

- `gpushb`, `gbd`, `gpullb`, and `gmergeb` streamline branch operations.

- `gp` simplifies the Git push command.

- `gf` and `gfa` alias Git fetch commands.

- `gst` provides a concise Git status with untracked files.

- `egst` shows modified files with `git status` and opens them in Neovim.

- `CTRL-T` will search for files from the command line with fzf

- `ESC-C` (`ALT-C` on Linux) will search for directories from the command line, and selecting one will place you in the directory



### Tmux



See the tmux config in [./tmux/.tmux.conf](./tmux/.tmux.conf), here are a few helpful aliases:



- `` is the prefix

- `[` to open vi mode within tmux

- `f` to use the `tmux-sessionizer` script, which will open a project in a new session

- `f` to use the `tmux-sessionizer` script, which will open a project in a new session

- `|` to split vertically

- `-` to split horizontally



## Debugging:



- Check `:checkhealth` to ensure all plugins are working correctly.

- Use `:map` or `:verbose map nn` (for instance) to check keybinds are being set correctly.

- `:lua print(vim.inspect(vim.lsp.buf_get_clients()[1].resolved_capabilities))` to see what the LSP can do

- If seeing errors using flags such as `error parsing flag -E` - remember that this could be because it's aliased. In the instance of `grep`, you may need to use `/usr/bin/grep` to use grep intead of `rg`

- When starting `yabai`, you may need to run `yabai --start-service` instead of `brew services start yabai` per [this issue](https://github.com/koekeishiya/yabai/issues/1738#issuecomment-1541596750)



## Contribution:



You're more than welcome to submit an issue or PR with any bugs or feature suggestions. See issues for current feature requests/bugs.



If you want to pair up on a project or build out any of the above, pop me an email at .