Skip to content
This repository has been archived by the owner on Dec 6, 2024. It is now read-only.

Latest commit

 

History

History
81 lines (62 loc) · 2.63 KB

nvim-kickstart-refactor.md

File metadata and controls

81 lines (62 loc) · 2.63 KB

Refactoring with nvim-kickstart

Basically, we want to port over our preferences into nvim-kickstart-modular so our configuration is more maintainable and future proof. New Nvim Config

Primary Goals

  • More universal bindings for easier transition between regular vim and neovim
  • Easier to add different LSP servers
  • Easier to add and maintain additional plugins
  • Improve performance

Guidelines

  • Try to extend but not overwrite the default keybindings of nvim-kickstart, the intent is to relearn our bindings to that our experience is more universal.
  • This is an special regards to our base bindings i.e split-window, we should use the default bindings moving forward.
    • Example: 
      -  splitting windows

CTRL-W s _CTRL-W_s_
CTRL-W S _CTRL-W_S_
CTRL-W CTRL-S _CTRL-W_CTRL-S_
CTRL-W CTRL-V _CTRL-W_CTRL-V_
  • This also means we should rebind our current binding for save.
  • Port only what is necessary, there exists a lot of auto commands that we have that we don't need.
    • In addition, this will get rid of a lot of our icons that we don't use.
  • The LazyVim distro is a good resource

Plugins of Note/Complexity When Porting

  1. nvim-navic (This is going to be interesting to see how it plays with mini statusline)
  • And nvim-navbuddy, basically ranger to pair w/ navic
  1. nvim-cmp
  2. nvim-ufo
  • This might be less of an issue since neovim now supports built in folding.
  • It should follow then that any vim.opt related to folding should be taken a look at
  1. mini.nvim - My current understanding is that this bundles many quality of life plugins together
  2. nvim-lualine
  3. nvim-lsp
  4. mason
  5. bufferline
  6. toggleterm
  7. neodev
  8. outline - Perhaps replace w/ aerial.nvim
  9. nvim-treesitter-context - and basically all treesitter addons

Porting Notes

Follow the basic init.lua in kickstart to which to port over first

  • Exclude steps that involve an external plugin

Things to Probably Skip

  • Close certain windows with q
  • noice
  • lualine (it's actually kind of nice to have status line jump to current buffer you're working on)

options.lua

  • Exclude regarding tabs (mainly because other plugins/defaults take care of it)
-- 
opt.expandtab = true
opt.shiftround = true -- Round indent
opt.shiftwidth = 2
opt.smartindent = true
opt.tabstop = 2
opt.softtabstop = 2
---

autocmd.lua

  • For simplicity's sake, do not import TrimWhiteSpaceGrp
    • This autocmd removes all trailing whitespaces, make it a toggle feature but due to the amount of legacy codebases we work with, do not enable