Neovim

[rogerxu]

Documentation - Neovim

[rogerxu]

Install

Installing Neovim · neovim/neovim Wiki (github.com)

Ubuntu 20.04 apt-get 安装 Neovim v0.6.1 - SegmentFault 思否

apk add neovim

apt install neovim

brew install neovim

Setup

🚀 Getting Started | LazyVim

[rogerxu]

Lua

Lua - Neovim docs

nanotee/nvim-lua-guide: A guide to using Lua in Neovim (github.com)

LUA-VIMSCRIPT BRIDGE - Lua - Neovim docs

• vim.g - Global editor variables
• vim.b - Buffer-scoped editor variables
• vim.w - Window-scoped editor variables
• vim.o - Vim options
• vim.go - Global options
• vim.bo - Buffer-scoped options
• vim.wo - Window-scoped options
• vim.opt - list- and map-style option from Lua: It allows accessing them as Lua tables.

vim.o.listchars = 'space:_,tab:>~'
vim.opt.listchars = { space = '_', tab = '>~' }

[rogerxu]

Configuration

/config/options.lua

local opt = vim.opt

-- 2 moving around, searching and patterns
-- opt.incsearch = true
opt.ignorecase = true
opt.smartcase = true

-- 4 displaying text
-- opt.wrap = true
opt.cmdheight = 2
-- opt.columns = 150
-- opt.lines = 30
opt.list = true
opt.listchars = { tab = '»·', trail = '·', nbsp = '+' }
opt.number = true

-- 5 syntax, highlighting and spelling
-- opt.syntax = 'ON'
-- opt.hlsearch = true
opt.cursorline = true
opt.colorcolumn = '80'
-- opt.spell = false

-- 6 multiple windows
-- opt.hidden = true

-- 11 messages and info
-- opt.showcmd = true
opt.showmode = false
-- opt.ruler = true

-- 14 tabs and indenting
opt.tabstop = 4
opt.shiftwidth = 2
-- opt.smarttab = true
opt.softtabstop = 2
opt.expandtab = true
-- opt.autoindent = true
opt.smartindent = true

-- 17 mapping
-- opt.timeoutlen = 500

-- 18 reading and writing files
-- opt.endofline = true
-- opt.bomb = false
-- opt.fileformat = 'unix'

-- 24 multi-byte characters
-- opt.encoding = 'utf-8'
opt.fileencoding = 'utf-8'

[rogerxu]

Theme

plugins/colorscheme.lua

return {

  -- tokyonight
  {
    "folke/tokyonight.nvim",
    lazy = false,
    priority = 1000,
    opt = {
      style = "moon",
      transparent = true,
      styles = {
        sidebars = "transparent",
        floats = "transparent",
      },
    },
    config = function()
      -- load the colorscheme here
      vim.cmd([[colorscheme tokyonight]])
    end,
  },
}

[rogerxu]

Plugin

Plugin Manager

folke/lazy.nvim: 💤 A modern plugin manager for Neovim (github.com)

init.lua

require("config.lazy")

config/lazy.lua

-- Bootstrap lazy.vim
local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
if not (vim.uv or vim.loop).fs_stat(lazypath) then
  local lazyrepo = "https://github.com/folke/lazy.nvim.git"
  local out = vim.fn.system({ "git", "clone", "--filter=blob:none", "--branch=stable", lazyrepo, lazypath })
  if vim.v.shell_error ~= 0 then
    vim.api.nvim_echo({
      { "Failed to clone lazy.nvim:\n", "ErrorMsg" },
      { out, "WarningMsg" },
      { "\nPress any key to exit..." },
    }, true, {})
    vim.fn.getchar()
    os.exit(1)
  end
end
vim.opt.rtp:prepend(lazypath)

-- Make sure to setup before
-- loading lazy.nvim so that mappings are correct.
-- This is also a good place to setup other settings (vim.opt)
vim.g.mapleader = " "
vim.g.maplocalleader = "\\"

require("config.options")

-- Setup lazy.nvim
require("lazy").setup({
  spec = {
    -- import your plugins
    { import = "plugins" },
  },
  -- Congigure any other settings here.
  -- colorscheme that will be used when installing plugins.
  -- install = { colorscheme = { "habamax" } },
  -- automatically check for plugin updates
  checker = { enabled = true },
})

[rogerxu]

Editor

plugins/editor.lua

File explorer

nvim-neo-tree/neo-tree.nvim: Neovim plugin to manage the file system and other tree like structures. (github.com)

  -- file explorer
  {
    "nvim-neo-tree/neo-tree.nvim",
    branch = "v3.x",
    dependencies = {
      "nvim-lua/plenary.nvim",
      "nvim-tree/nvim-web-devicons",
      "MunifTanjim/nui.nvim",
    },
    cmd = "Neotree",
    opts = {
      source_selector = {
        winbar = true,
      }
    }
  },

Usage

:Neotree

Show key bindings

folke/which-key.nvim: 💥 Create key bindings that stick. WhichKey helps you remember your Neovim keymaps, by showing available keybindings in a popup as you type. (github.com)

  -- show key bindings
  {
    "folke/which-key.nvim",
    opts = {
    },
  },

git status

lewis6991/gitsigns.nvim: Git integration for buffers (github.com)

  -- git status
  {
    "lewis6991/gitsigns.nvim",
    opts = {
    },
  },

Diagnostics

folke/trouble.nvim: 🚦 A pretty diagnostics, references, telescope results, quickfix and location list to help you solve all the trouble your code is causing. (github.com)

TBD

TODO list

folke/todo-comments.nvim: ✅ Highlight, list and search todo comments in your projects (github.com)

TBD

Fuzzy Finder

nvim-telescope/telescope.nvim: Find, Filter, Preview, Pick. All lua, all the time. (github.com)

Dependencies

apt install ripgrep
apt install fd

Install

  -- fuzzy finder
  {
    "nvim-telescope/telescope.nvim",
    version = false,
    cmd = "Telescope",
    dependencies = {
      "nvim-lua/plenary.nvim",
    },
    opts = {
    }
  }

Usage

:checkhealth telescope

Pickers

:Telescope find_files
:Telescope live_grep
:Telescope buffers
:Telescope help_tags

[rogerxu]

UI

plugins/ui.lua

Tabs

akinsho/bufferline.nvim: A snazzy bufferline for Neovim (github.com)

  -- tabs
  {
    "akinsho/bufferline.nvim",
    version = "*",
    dependencies = {
      "nvim-tree/nvim-web-devicons",
    },
    opts = {
      options = {
        diagnostics = "nvim_lsp",
        offsets = {
          {
            filetype = "neo-tree",
            text = "Neo-tree",
            highlight = "Directory",
            text_align = "left",
          },
        },
      },
    },
  },

Statusline

nvim-lualine/lualine.nvim: A blazing fast and easy to configure neovim statusline plugin written in pure lua. (github.com)

  -- statusline
  {
    "nvim-lualine/lualine.nvim",
    opts = {
      options = {
        theme = "auto",
      }
    },
    extensions = { "neo-tree", "lazy" },
  },

rebelot/heirline.nvim: Heirline.nvim is a no-nonsense Neovim Statusline plugin designed around recursive inheritance to be exceptionally fast and versatile. (github.com)

plugins/heirline.lua

return {
  "rebelot/heirline.nvim",
  event = "BufEnter",
  opts = {
    statusline = {},
    winbar = {},
    tabline = {},
    statuscolumn = {},
  }
}

[rogerxu]

TreeSitter

plugins/treesitter.lua

treesitter

nvim-treesitter/nvim-treesitter: Nvim Treesitter configurations and abstraction layer (github.com)

Dependencies

apt install gcc

Install

  -- treesitter
  {
    "nvim-treesitter/nvim-treesitter",
    main = "nvim-treesitter.configs",
    build = ":TSUpdate",
    opts = {
      ensure_installed = {
        "bash",
        "css",
        "diff",
        "html",
        "java",
        "javascript",
        "json",
        "lua",
        "markdown",
        "python",
        "typescript",
        "vim",
        "vimdoc",
        "xml",
        "yaml",
      },
      sync_install = false,
      highlight = {
        enable = true
      },
      indent = {
        enable = true
      },
    },
  },

Usage

:TSUpdate

Auto close tags

windwp/nvim-ts-autotag: Use treesitter to auto close and auto rename html tag (github.com)

TBD

[rogerxu]

Coding

plugins/coding.lua

Auto completion

hrsh7th/nvim-cmp: A completion plugin for neovim coded in Lua. (github.com)

  -- auto completion
  {
    "hrsh7th/nvim-cmp",
    version = false,
    event = "InsertEnter",
    dependencies = {
      "hrsh7th/cmp-nvim-lsp",
      "hrsh7th/cmp-buffer",
      "hrsh7th/cmp-path",
    },
    opts = {
      auto_brackets = {},
    },
  },

[rogerxu]

Copilot

zbirenbaum/copilot.lua: Fully featured & enhanced replacement for copilot.vim complete with API for interacting with Github Copilot

plugins/copilot.lua

return {

  -- copilot
  {
    "zbirenbaum/copilot.lua",
    cmd = "Copilot",
    build = ":Copilot auth",
    opts = {
    },
  },
}

Usage

:Copilot auth

[rogerxu]

Usage

Go back

Go back to where exited vim

:marks
`0

Go back to edited recently

:browse oldfiles

[rogerxu]

Insert Mode

• Ctrl+a - insert previously inserted text
• Ctrl+@ - insert previously inserted text and exit to normal mode
• Ctrl+w - delete previous word
• Ctrl+u - delete to the start of line
• Ctrl+i - insert a tab
• Ctrl+j - insert a new line
• Ctrl+t - insert an indent
• Ctrl+d - delete an indent
• 0 Ctrl+d - delete all indent
• Ctrl+e - insert the character below the cursor
• Ctrl+y - insert the character above the cursor

Insert mode completion

• Ctrl+p - find previous keyword
• Ctrl+n - find next keyword

Ctrl+x - suggestions

• Ctrl+l - whole lines
• Ctrl+n - keywords int the current file
• Ctrl+k - words in dictionary
• Ctrl+t - words in thesaurus
• Ctrl+i - keywords in the current and included files
• Ctrl+] - tags
• Ctrl+f - file names
• Ctrl+d - definitions or macros
• Ctrl+v - Vim command line
• Ctrl+u - user defined completion
• Ctrl+o - omni completion
• s - spelling suggestions

Insert special characters

:digraphs

• Ctrl+k Co - insert digraph ©