nixpkgs/neovim: reorganize and add comments

.config/nixpkgs/neovim/init.lua

@@ -1,3 +1,4 @@
+-- file/buffer/etc picker
 require('telescope').setup({
   defaults = {
     mappings = {
@@ -13,12 +14,16 @@ require('telescope').setup({
     sorting_strategy = 'ascending',
   },
 })
+
+-- use native sorter for better performance
 require('telescope').load_extension('fzf')
 
+-- shows added/removed/changed lines
 require('gitsigns').setup()
 
 require('mini.statusline').setup({
   content = {
+    -- copy-pasted from default, we just want to remove the icon
     active = function()
       local mode, mode_hl = MiniStatusline.section_mode({ trunc_width = 120 })
       local git           = MiniStatusline.section_git({ trunc_width = 75, icon = '' })
@@ -40,20 +45,35 @@ require('mini.statusline').setup({
   },
 })
 
+-- delete buffer while preserving layout
 require('mini.bufremove').setup()
 
+-- shows a line indicating the current indentation scope
 require('mini.indentscope').setup()
 
-require('nvim-treesitter.configs').setup {
+-- LSP completion and function signature display
+require('mini.completion').setup({
+  delay = {
+    -- disable autocomplete
+    completion = 100000000,
+    info = 100,
+    signature = 50,
+  },
+  lsp_completion = {
+    source_func = 'omnifunc',
+    auto_setup = false,
+  },
+});
+
+-- Use Treesitter for syntax highlighting
+require('nvim-treesitter.configs').setup({
   highlight = {
     enable = true,
   },
-}
-
-vim.diagnostic.config({
-  virtual_text = { severity = { min = vim.diagnostic.severity.WARN } }
 })
 
+-- ------ Mappings ------
+
 local opts = { noremap=true, silent=true }
 vim.api.nvim_set_keymap('n', '<space>e', '<cmd>lua vim.diagnostic.open_float()<CR>', opts)
 vim.api.nvim_set_keymap('n', '[d', '<cmd>lua vim.diagnostic.goto_prev()<CR>', opts)
@@ -64,7 +84,6 @@ vim.api.nvim_set_keymap('n', '<Leader>q', '<cmd>lua MiniBufremove.delete()<CR>',
 vim.api.nvim_set_keymap('n', '<C-P>', '<cmd>Telescope find_files<CR>', opts)
 vim.api.nvim_set_keymap('n', '<C-O>', '<cmd>Telescope buffers<CR>', opts)
 vim.api.nvim_set_keymap('n', '<Leader>ff', '<cmd>Telescope live_grep<CR>', opts)
-vim.api.nvim_set_keymap('n', '<Leader>fs', '<cmd>Telescope lsp_document_symbols<CR>', opts)
 
 -- Allow pressing enter to autocomplete
 vim.api.nvim_set_keymap('i', '<CR>', 'pumvisible() ? "\\<C-y>" : "\\<CR>"', { noremap = true, expr = true })
@@ -73,8 +92,7 @@ function on_attach(client, bufnr)
   -- Enable completion triggered by <c-x><c-o>
   vim.api.nvim_buf_set_option(bufnr, 'omnifunc', 'v:lua.MiniCompletion.completefunc_lsp')
 
-  -- Mappings.
-  -- See `:help vim.lsp.*` for documentation on any of the below functions
+  -- LSP-specific mappings
   vim.api.nvim_buf_set_keymap(bufnr, 'n', 'gD', '<cmd>lua vim.lsp.buf.declaration()<CR>', opts)
   vim.api.nvim_buf_set_keymap(bufnr, 'n', 'gd', '<cmd>lua vim.lsp.buf.definition()<CR>', opts)
   vim.api.nvim_buf_set_keymap(bufnr, 'n', 'K', '<cmd>lua vim.lsp.buf.hover()<CR>', opts)
@@ -88,32 +106,22 @@ function on_attach(client, bufnr)
   vim.api.nvim_buf_set_keymap(bufnr, 'n', '<space>ca', '<cmd>lua vim.lsp.buf.code_action()<CR>', opts)
   vim.api.nvim_buf_set_keymap(bufnr, 'n', 'gr', '<cmd>Telescope lsp_references<CR>', opts)
   vim.api.nvim_buf_set_keymap(bufnr, 'n', '<space>f', '<cmd>lua vim.lsp.buf.formatting()<CR>', opts)
+  vim.api.nvim_buf_set_keymap(bufnr, 'n', '<Leader>fs', '<cmd>Telescope lsp_document_symbols<CR>', opts)
 end
 
-require'nvim-treesitter.configs'.setup {
-  highlight = {
-    enable = true,
-  },
-}
+-- ------ LSP settings ------
 
-require('mini.completion').setup({
-  delay = {
-    -- disable autocomplete
-    completion = 100000000,
-    info = 100,
-    signature = 50,
-  },
-  lsp_completion = {
-    source_func = 'omnifunc',
-    auto_setup = false,
-  },
-});
+-- only show virtual text for WARN and higher
+vim.diagnostic.config({
+  virtual_text = { severity = { min = vim.diagnostic.severity.WARN } }
+})
 
 local nvim_lsp = require('lspconfig')
 local null_ls = require('null-ls')
 
 local null_ls_sources = {}
 
+-- enable LS / null-ls sources based on executable presence
 if vim.fn.executable("node_modules/.bin/eslint") == 1 then
   table.insert(null_ls_sources, null_ls.builtins.formatting.eslint_d)
   table.insert(null_ls_sources, null_ls.builtins.diagnostics.eslint_d)
@@ -131,13 +139,13 @@ end
 
 if vim.fn.executable("deno") == 1 then
   nvim_lsp.denols.setup({
-    capabilities = require('cmp_nvim_lsp').update_capabilities(vim.lsp.protocol.make_client_capabilities()),
     on_attach = on_attach,
   });
   table.insert(null_ls_sources, null_ls.builtins.formatting.deno_fmt);
 end
 
 if vim.fn.executable("node_modules/.bin/tsc") == 1 then
+  -- this provides auto-import on completion, among other things
   local ts_utils = require("nvim-lsp-ts-utils")
 
   nvim_lsp.tsserver.setup({
@@ -146,11 +154,13 @@ if vim.fn.executable("node_modules/.bin/tsc") == 1 then
       debounce_text_changes = 150,
     },
     on_attach = function(client, bufnr)
+      -- mark tsserver as not having formatting available as we rely on
+      -- null-ls/eslint for that and having both available makes nvim ask us
+      -- which LS to use everytime we format
       client.resolved_capabilities.document_formatting = false
       client.resolved_capabilities.document_range_formatting = false
 
-      on_attach(client, bufnr)
-
+      -- settings here are buffer-local so has to be run on_attach
       ts_utils.setup({
         debug = false,
         disable_commands = false,
@@ -184,6 +194,8 @@ if vim.fn.executable("node_modules/.bin/tsc") == 1 then
 
       -- required to fix code action ranges and filter diagnostics
       ts_utils.setup_client(client)
+
+      on_attach(client, bufnr)
     end,
   })
 end
@@ -192,6 +204,7 @@ null_ls.setup({
   sources = null_ls_sources,
 
   on_attach = function(client, bufnr)
+    -- format on save
     if client.resolved_capabilities.document_formatting then
       vim.cmd([[
       augroup LspFormatting

.config/nixpkgs/neovim/vimrc

@@ -47,6 +47,9 @@ set backupcopy=yes
 " disable modelines
 set nomodeline
 
+" show preview of lines when using :s
+set inccommand=split
+
 " ------ key bindings ------
 
 " ; as :
@@ -76,35 +79,30 @@ nnoremap <Leader>gb :Merginal<CR>
 " undo tree
 nnoremap <Leader>ut :UndotreeToggle<CR>
 
-" vimrc
-nnoremap <Leader>ve :vsplit $MYVIMRC<CR>
-nnoremap <Leader>vs :source $MYVIMRC<CR>
-
-" ------ nvim specific ------
-if has('nvim')
-  set inccommand=split
-  tnoremap <C-[><C-[> <C-\><C-N>
-  autocmd TermOpen * setlocal scrollback=10000 nonumber norelativenumber
-  autocmd TermOpen * startinsert
-  autocmd FileType fzf tnoremap <buffer> jj <ESC>
-  autocmd BufWinEnter,WinEnter term://* startinsert
-  autocmd BufLeave term://* stopinsert
-
-  " fix flickering when clearing terminal
-  autocmd TermEnter * setlocal scrolloff=0
-  autocmd TermLeave * setlocal scrolloff=99
-
-  nnoremap <Leader>tv :vsp term://$SHELL<CR>
-  nnoremap <Leader>to :term<CR>
-endif
+" use <ESC><ESC> to leave terminal mode
+tnoremap <C-[><C-[> <C-\><C-N>
+
+" opening terminals
+nnoremap <Leader>tv :vsp term://$SHELL<CR>
+nnoremap <Leader>to :term<CR>
+
+" default terminal settings
+autocmd TermOpen * setlocal scrollback=10000 nonumber norelativenumber
+
+" automatically enter,leave terminal mode
+autocmd TermOpen * startinsert
+autocmd BufWinEnter,WinEnter term://* startinsert
+autocmd BufLeave term://* stopinsert
+
+" strip trailing whitespace
+autocmd BufWritePre * %s/\s\+$//e
+
+" filetype specific options
+autocmd FileType markdown set tw=80
 
-augroup formatting
-  au!
-  " strip trailing whitespace
-  autocmd BufWritePre * :%s/\s\+$//e
-  autocmd FileType markdown :set tw=80
-augroup end
+" ------ theme ------
 
+" use full color if available
 if has('termguicolors')
   set termguicolors
 endif
@@ -125,6 +123,7 @@ call sonokai#highlight('MiniStatuslineModeVisual', s:palette.black, s:palette.or
 call sonokai#highlight('MiniStatuslineModeReplace', s:palette.black, s:palette.red)
 call sonokai#highlight('MiniStatuslineModeOther', s:palette.black, s:palette.green)
 
+" use default terminal colors
 unlet! g:terminal_color_0
 unlet! g:terminal_color_1
 unlet! g:terminal_color_2