Awesome

Always Work In Process

Neovim Configure

.
├── compiler                  -- compiler related setting
├── coc-settings.json         -- for coc.nvim if you use coc.nvim as default complation framework, you can also select the builtin lsp
├── ftplugin                  -- some specific setting for some filetype
├── init.lua
├── install.sh
├── lua
│   ├── configure
│   │   ├── nvim_cmp.lua      -- builtin lsp complation config
│   │   ├── lsp_config        -- builtin lsp config
│   │   ├── ....              -- other plugin configs
│   │   └── coc.lua           -- coc.nvim based lsp config
│   ├── core
│   │   ├── after.lua         -- just eusure this will be setting after all plugin loaded
│   │   ├── default.lua       -- some default setting
│   │   ├── init.lua          --
│   │   ├── mapping.lua       -- mapping register module
│   │   ├── plugins.lua       -- all plugin name and group center
│   │   └── themes.lua        -- my favorite themes
│   ├── hack                  -- something you want to hack
│   │   ├── init.lua
│   │   └── pomodoro.lua
│   ├── local.lua             --
│   ├── user.lua              -- user related configure like email, name, etc.
│   └── util                  -- some useful tools and functions
└── tasks.ini                 -- asynctasks

Install

1. Install Neovim >=0.9, git >= 2.32

2. Install pynvim and debugpy(optional)

  # pynvim for python based plugins
  pip install pynvim
  # debugpy for python debug, just install it to your environment
  pip install debugpy
  # optional yapf for python format
  pip install yapf

3. Install node.js, npm, and yarn

curl -sL install-node.vercel.app/lts | bash
npm install --global yarn

Optional:

for grammarly-language-server, it requires the node@16

# install node@16
npm install -g n
n -d 16

# export the GRAMMARLY_PATH in you .bashrc or .zshrce or what shell you use
export GRAMMARLY_PATH="$HOME/.local/share/nvim/mason/packages/grammarly-languageserver/node_modules/grammarly-languageserver"

4. Install lolcat for display the NEOVIM logo

Ubuntu:
    sudo apt install lolcat
OSX:
    brew install lolcat

5. Install ag or rg

OSX:
    brew install rg
Ubuntu:
    sudo apt-get install ripgrep

6. Install Nerd Font

Install Nerd Font Family: `DejaVuSansMono Nerd Font` or  what you want
Download from https://www.nerdfonts.com/
Install method depend on your os.

7. Install xclip (X11), wl-clipboard (Wayland), pngpaste (MacOS), for Clipboard Image

8. Make some link

./install.sh

9. User related setting in lua/core/user.lua.

Both local.lua and user.lua are bind to user. user.lua is more general for each user, and local.lua is special to each machine, and setting in local.lua will not be indexed by git but user.lua will be.

My own setting example in local.lua is:

local M = {}

M.setup = function()
    vim.g.global_proxy_port = 'http://127.0.0.1:7893' -- like "http://127.0.0.1:7893", this is for some plugin like google translate that is banned by GFW. if you don't have this issue, set it to `nil`
end

M.after = function()
...your code
end
return M

In the user.lua you must provide the setup and after method in the module

local M = {}
M.setup = function()
-- call the local setup
-- require('core.local').setup()
...your code
end
M.after = function() ... end
-- call the local after
-- require('core.local').after()
...your code
return M

NOTE: The default leader is setting in lua/core/default.lua. The setting is

let maplocalleader=','
let mapleader=';'
nnoremap \\ ;
vnoremap \\ ;

10. Select builtin or coc.nvim for the default LSP in 'core/init.lua'.

For my experience, coc.nvim is more easy to configure to get all things work. But now more and more neovim users change to use builtin?

11. Open neovim and run :PackerSync<cr> command to install Plugins by Packer plugin manager.

Optional

1. Install pg_format for sql format

see https://github.com/darold/pgFormatter#:~:text=following%20your%20distribution.-,INSTALLATION,-Following%20your%20Linux

2. Install sqlite3 for better frequence files display(<leader>fh)

sudo apt-get install sqlite3
sudo apt-get install libsqlite3-dev

More

For getting the best performance, please use the GPU-based terminal:

• kitty
• alacritty

Main features

Each figure may display with different colorscheme.

ChatGPT

Complete/Nvim-Tree/Navigator(based builtin lsp)

Complete/Nvim-Tree/Navigator(based coc.nvim)

Fuzzy Search

Agenda

Markdown & Vimwiki

Project TODO

Debug Adapter Protocol

Pomodoro Clock

There are some shortcuts.

NOTE: Default set

    vim.cmd("let maplocalleader=' '")
    vim.cmd("let mapleader=';'")
    vim.cmd("nnoremap ' ;")
    vim.cmd("vnoremap ' ;")

WARNING: We will remap some shortcuts but not update this table, just for reference.