MODERN NVIM CONFIG

Table of Contents

MODERN NVIM CONFIG

ChangingLog

V.0.10 Release

Adding the following color highlights to the githubG.nvim our colorschme, which includes:
- LspInlayHint,
- WinSeparator,
- WinBar and WinBarNC
What has been added since v.0.10, read more neovim news-0.10
- hl-FloatBorder is linked to hl-NormalFloat instead of hl-WinSeparator.
- hl-NormalFloat is not linked to hl-Pmenu.
- hl-WinBar has different background.
- hl-WinBarNC is similar to hl-WinBar but not bold.
- hl-WinSeparator is linked to hl-Normal instead of hl-VertSplit.

V.0.9.2 Release Nvim

This version has no issue in performance, I just included minor fixes for some libraries.
- nvim-saga now works flawlessly.
- ranger now can open in new buffer, support the icons and other features.
- terminal: Terminal now uses the saga package to open the new terminal.
- conform: Added formatter for both rust and R customized.
- gen.nvim; Added AI with LLM language models support - model are locally installed.

v.0.9.1 Release Nvim

The following major realse shows a bit longer time to trigger the nvim.

v.0.9.0 Release Nvim 0.9 with Lazy

v.0.8.0 Update release Nvim-workflow v0.1

As nvim has been updated to version 0.8, which includes a stable release, several deprecated third-party plugins and APIs have also been optimized. As a result, the startup time has been reduced from 800 milliseconds to only 18 milliseconds. With this optimization, nvim is now faster than light while maintaining backwards compatibility with some outdated plugins that are essential to my daily workflow.

The configuration files are all written in lua using the most modern APIs by this time. Check for more details :h deprecated to see the news feature of the new release. Here, is a summary of the most wanted upgrades to my configuration file (to name few)

Nvim Workflow

Shortcuts

ContextEnable: will give you a nice folding to your functions.
DocsViewToogle: for showing documents and tracing your cursor.
SymbolsOutline: for getting a nice jump over all coding elements.
<leader> + o: will also give us similar to SymbosOutline.
Remember, once you are in insert mode, it will trigger other plugins to be loaded. but some of them until you open next buffer. (reason is to get speed and loading only necessary plugins on demands.)
Ctr + n/p: to scroll faster while center.
Shift + { or } to scroll faster while centered but jump on coding elements.
<F6>: To toggle the spell checking.
<F1>: To show help
<leader>ff, <leader>fg, <leader>fb and <leader>fh all are reserved to nvim-Telelscope toggler.
<leader>tt: horizontal terminal,
<leader>t: floating terminal but slower
<leader>r: Ranger for navigating your files.
<leader>u: undo-tree toggler.

Workflow notes

Cargo with Rust

To enable the crate plugin, you need to enter a buffer with file extension '.rs' associated with 'rustfile' first. This can be triggered on the 'Insert' event. It also activates 'cmp-create' and 'nvim-crate'. Later, you can use the 'keymapping: gH' on the crate name, which will display documentation about the crate history and other considerations.

Auto Save

By default, the file will automatically save based on the auto-saved plugin. This feature is triggered as soon as we begin writing. To stop this auto-save, we can use the keymapping leader + s, which will prevent further automatic saves.

For development

We can use add the following to the top of the file

require("core.myInspectorFucntions")

In order to request the required custom-development functions that I have created, please refer to the following as an example:

assume you have a file called testing_file at the lua directory

local fn = require("testing_file")
P(fn.setup())

More details for the configurations

To do

Configuration for the dap
install dap for rust-analyzer, integrated with rust-tools
Adding only the keymapping-window.
spell-checking for nvim such as
Spelunker.vim The current configurations are from the needs of getting the best optimized IDE for the startup time.

Major Changes in Nvim 0.8

General Configuration helper

configure nvim using lua

USEFUL COMMANDS

The following command are super handy and useful when developign lua plugins.

:source %                  -- This will repload the curretn buffer (usually can be used with init.lua)
:lua <function_name()>     -- How to run a function (especially the __G.) global functions (check special function file)

Packer and packadd

packer usually will load the required plugins and thats suppose to be for any file you will put at plugin which where packer usually dumps its contents.

Color-scheme

Any color scheme (*.vim) will be put at colors directory inside the nvim will be loaded to the color-scheme, which can be checked using :colorscheme <tab>

RUNTIME PATH

You can use :set rtp+=/path/to/emmet to add any directory which will be loaded to the run-path lists.

Getting some useful Info

:lua print(vim.opt.columns:get()) -- will print the number of columns you have (set/get are main functions to retervie or setting info)

Read Useful Information

Since 0.8 we can now create

vim.cmd [[
  autocmd BufEnter,CursorHold,InsertLeave,BufWritePost *.rs silent! lua vim.lsp.codelens.refresh()
]]

Now, it becomes as:

vim.api.nvim_create_autocmd({ "BufWritePost", "BufEnter", "CursorHold", "InsertLeave" }, {
  pattern = { "*.rs" },
  callback = function()
    vim.lsp.codelens.refresh()
  end
})

undotree hint Since we allow undotree to be triggered only when we call the undotree kepmapping, then you should always hit at least once the undotree to trigger it for the curretn buffer, which can keep tracking the changes.
otree hint To ensure that undotree is triggered for the current buffer, you should always hit it at least once. This will allow undotree to track your changes efficiently.

Jump Motion

Things to be considered

Migration for Nvim 0.8

check :h deprecated

Need to change vim.highlight.create into vim.create.hl.
compatibility changed to compatibility_vim. : read more about this refactoring later.
vim.lsp.buf.format() now replaces the vim.lsp.buf.formatting()

Nvim with Lua API

pretty_print

vim.pretty_print("")

For mapping keyboard

there are two apis

got it from the telescope
telescope configuration

local map = function(op, outer)
    outer = outer or { silent = true, noremap = true }
    return function(lhs, rhs, opts)

        if type(lhs) ~= "table" then
            lhs = { lhs }
        end

        opts = vim.tbl_extend("force",
            outer,
            opts or {}
        )

        for _, v in pairs(lhs) do
            vim.keymap.set(op or "n", v, rhs, opts)
        end

    end
end

vim.g.nmap = map("n")
vim.g.imap = map("i")
vim.g.vmap = map("v")
vim.g.tmap = map("t")

which means using vim.keymap.set()

Using reqular nvim

vim.api.nvim_set_keymap("i", "<c-j>", '("<C-n>")', {
	noremap = true,
	silent = true,
	expr = true,
})

Telescope commands

In the cmd you can use

:Telescope keymaps, registers, vim_options, jumplist, loclist, filetypes ..etc.

Check Vim Pickers

Events managment in nvim

There are several ways to manage the events such as VimEnter, BufEnter ... etc. Read more here

Vim documentation: autocmd

Make statusline from scratch

local function status_line()
  local mode = "%-5{%v:lua.string.upper(v:lua.vim.fn.mode())%}"
  local file_name = "%-.16t"
  local buf_nr = "[%n]"
  local modified = " %-m"
  local file_type = " %y"
  local right_align = "%="
  local line_no = "%10([%l/%L%)]"
  local pct_thru_file = "%5p%%"
  vim.cmd([[hi StatusLine ctermbg=red ctermfg=yellow ]])

  return string.format(
    "%s%s%s%s%s%s%s%s",
    mode,
    file_name,
    buf_nr,
    modified,
    file_type,
    right_align,
    line_no,
    pct_thru_file
  )
end
vim.opt.statusline = status_line()

To add color to status-line we can use the following, Go to the one-darker configuration file and add the following which can alter the group color of the statusline

     -- StatusLine
      StatusLine = { fg = '#DADFF7' ,bg = '#008DD5' },
     -- StatusLineTerm = {},
     -- StatusLineNC = {},
     -- StatusLineTermNC = {},

Debugging in lua

In command line prompt for nvim you can print the tables using one of the following.

:lua vim.pretty_print(packer_plugins)
:lua print(vim.inspect(packer_plugins))

Order of execution in nvim

Anything you put inside the plugin (without a trailing 's'), which is located in the same directory as where nvim-packer stores its startup, will be used to load the nvim configuration. It's useful to understand the directory order for placing your configurations files to improve startup speed.

Create a test.lua file at the plugin directory for automatic sourcing.
You can put any code inside this test.lua that will be loaded and executed after all Lua files are sourced.
Note that the packer-plugins global variable is established after sourcing the packer_compiled.lua. It checks for a plugin called undotree (same as from the GitHub repository). This will automatically get loaded when you open the init.lua file.

if packer_plugins["undotree"] and packer_plugins["undotree"].loaded then
print("Vim undotree is loaded")
-- other custom logic
end

print("wow")

├──     LICENSE
├──     README.md
└──     VSCode_setting/
│  ├────     README.md
│  ├────     SS-01.png
│  └────     init.vim
└──     assets/
│  ├────     SS-01.old
│  ├────     SS-01.png
│  ├────     SS-02.png
│  ├────     SS-03.png
│  ├────     SS-04.png
│  └────     current_loaded_programming_langauge_servers.png
├──     init.lua
└──     lua/
│  └────     core/
│  │  ├────     global.lua
│  │  ├────     init.lua
│  │  └────     keymappings.lua
│  └────     plugins/
│  │  └────     configs/
│  │  │  ├────     init.lua
│  │  │  ├────     myFzf.lua
│  │  │  ├────     myImpatient.lua
│  │  │  ├────     myNvimTree.lua
│  │  │  ├────     myTelescope.lua
│  │  │  ├────     myUndoTreeConfig.lua
│  │  │  └────     onedark_config.lua
│  │  ├────     init.lua
│  │  ├────     packerPluginsManager.lua
│  │  └────     packerPluginsManagerLoader.lua
│  └────     settings/
│  │  ├────     init.lua
│  │  └────     options.lua
└──     plugin/
│  ├────     packer_compiled.lua
│  └────     test.lua

Adding upper case (captial letter)

-- This will work if you add to (common) for the color scheme. -- Defing first the synatx group by linking them to existed on using: -- highlight def link <you_custom_group_name> guifg= -- Then assign to the specific pattern that you want to highlight

vim.cmd([[
hi def link GGX Title
syn match GGX /[A-Z]+/
syn match GGX /[A-Z]\{2,\}/ "two words or more
syn match GGX "\v<[A-Z]+>"
]])

You can also specify some highlight using:

vim.cmd([[highlight Visual cterm=bold ctermbg=Blue ctermfg=NONE]])

There are three ways to highlight custom group (group created by user) these are

Using direct nvim syntax

highlight GGX guifg=#EEEDBF

Adding to the one-dark-config.lua file at the defined highlights like: Here we will add GGX

highlights = {
-- Common
Visual = { bg = '$bright_orange', fmt = 'bold'},
Normal = { fg = '$beautiful_black' ,bg = '$beautiful_black' },                               -- backgorund default color
Terminal= { fg = '$beautiful_black' ,bg = '$beautiful_black' },                              -- terminal color for nvim
EndOfBuffer = { fg = '$beautiful_black' ,bg = '$beautiful_black' },                          -- End of buffer color
VertSplit = { fg = '$light_green' ,bg = '$beautiful_black' },                                -- when using vertical split
SignColumn = { fg = '$beautiful_black' ,bg = '$beautiful_black' },                           -- SignColumn control the edge of nvim buffer
-- Syntax
String = {fg ='$light_green'},                                                               -- For only string in nvim
-- nvim-tree
NvimTreeVertSplit =  { fg = '$light_green' ,bg = '$beautiful_black' },                       -- When you split inside nvim-tree the fg will be activited
NvimTreeNormal = { fg = '$light_green' ,bg = '$beautiful_black' },                           -- fg means files names, folder names ..etc.
NvimTreeEndOfBuffer = { fg = '$light_green' ,bg = '$beautiful_black' },
NvimTreeGitNew = {fg ='$light_green'  },                                                      -- This will change only the
-- GGX = {fg = '#EEEDBF'}

This is native to nvim which we can use

    vim.highlight.create('GGX', {guifg="#EEEDBF"}, true)

We are using now Global function to source all the current files

-- Function used to color (yellow) the upper cases words
_G.highlight_upper_letter_cases = function()
    -- The following
    -- This will work if you add to (common) for the color scheme.
    -- Defing first the synatx group by linking them to existed on using:
    -- highlight def link <you_custom_group_name> guifg=<hash-color-name>
    -- Then assign to the specific pattern that you want to highlight
    -- You can link from other group using:
    -- vim.api.nvim_command([[hi def link GGX Title]])
    -- Or create a new group
    --vim.highlight.create('GGX', {guifg="#EEEDBF"}, true)
    --vim.api.nvim_command([[highlight GGX guifg=#EEEDBF]])
    vim.api.nvim_command([[syn match GGX /[A-Z]+/]])
    vim.api.nvim_command([[syn match GGX /[A-Z]\{2,\}/]])
    vim.api.nvim_command([[syn match GGX "\v<[A-Z]+>"]])
    -- this will be executed only when open vim on event VimEnter (then source
    -- all nvim files), should not be used (affecting the markdown)
    vim.cmd([[autocmd VimEnter ~/.config/nvim/* source %]])
end

UNDERSTANDING THE COLOR

In nvim-lua configurations, there are essentially three layers that control the color of each group. Group colors refer to those defined for specific actions in nvim, such as digits, tabs, normal mode, and backgrounds, among others. These layers include:

A. Default Layer (this will be native to the color-scheme that you select. (mostly the tree-sitter parser colors are included)
B. Tree-Sitter Color-Groups which used once you install the nvim-treesitter
C. Component of the plugins that alter the colors (e.g., statuline, bufferline, nvim-tree and lsp configurations)
D. The user custom individual colors defined.

Configurations : to change the color, you need to consider to which level you want to alter the color.

VIM EVENTS

list all vim script events

MEASURE SPEED OF NEOVIM

Speedup Neovim

Reference

Markdown Badges

Name		Name	Last commit message	Last commit date
Latest commit History 167 Commits
VSCode_setting		VSCode_setting
after/plugin		after/plugin
assets		assets
docs		docs
lua		lua
.gitignore		.gitignore
.stylua.toml		.stylua.toml
LICENSE		LICENSE
README.md		README.md
init.lua		init.lua

License

Ghasak/nvim

Folders and files

Latest commit

History

Repository files navigation