nvim-config/docs/docs.md
2025-10-20 20:53:54 +03:00

6.8 KiB

TODO:

  • wrap up invero theme in separate repo and proper colors?
    • check plugins logins
    • cache / create final result
  • simplify coding: ts, lsp, lint, format (check other repos)
    • how to download parsers and plugins alternative
  • telescope alternative
  • keymaps
  • wrap up everything
--[[
  Neovim Lua config: ways to set things

  - vim.opt : preferred modern API for options (handles lists, cleaner syntax)
  - vim.g   : global variables (leader key, plugin settings, disable builtins, etc.)
  - vim.o   : global-only option (rarely needed directly)
  - vim.wo  : window-local option (applies to current window only, use in autocmds)
  - vim.bo  : buffer-local option (applies to current buffer only, use in autocmds)
  - vim.env : set environment variables (like PATH, LANG)
  - vim.fn  : call Vimscript functions (e.g. vim.fn.getcwd())
  - vim.cmd : run raw Vimscript/Ex commands (e.g. vim.cmd("colorscheme desert"))
  - vim.api : low-level Neovim API (create autocmds, keymaps, buffer/window ops, etc.)

  TL;DR -> use vim.opt + vim.g in options.lua for defaults.
           Use vim.wo/vim.bo only in context-specific tweaks (autocmds).
           Use vim.env, vim.fn, vim.cmd, vim.api as needed for scripting.
--]]

check macos fileS: https://github.com/dsully/dotfiles/blob/main/.data/macos-defaults/globals.yaml

Used pacakges:

  • rockspaces Metadata files describing how to build and install a Lua package.

  • luarocks Package manager for Lua modules. (optional)

  • tree-sitter Parser generator. Not needed except for using CLI. (optional)

  • fd-find (fd) Alternative to find. (optional)

  • ripgrep (rg) Line-oriented search tool. (recommended)

  • git Revision control system. (requirement)

  • lazygit Terminal UI for git commands. (optional)

  • fzf Command-line fuzzy finder.

  • bat "cat" but with colors

  • curl Command-line for transferring data specified with URL syntax.

  • wget Utility for downloading files from the Web.

  • make

  • cc Collection of compilers.

  • build-essential Meta-package that installs standard C/C++ libraries and headers. These are needed to compile tree-sitter parsers. Run only on the first time. cc (gcc, clang) C compiler. Usually it points to clang (on macos) or gcc (on linux). g++ C++ compiler. make Build automation tool from source code.

  • unzip Extraction utility for archives compressed in .zip.

  • ca-certificates Provides a set of trusted Certificate Authority (CA) certificates.

  • openssh-client Tools for connecting to remote servers securely over SSH.

  • libssl-dev Development libraries and headers for OpenSSL.

  • sudo

  • tree

  • jq

  • man-db

  • python3

  • volta Node manager

  • ncurses ncurses-dev ncurses-libs ncurses-terminfo \

  • check: https://github.com/glepnir/nvim/blob/main/Dockerfile

Currently installed

  • plenary.nvim

  • lazy.nvim

  • nvim-treesitter

  • neovim/nvim-lspconfig

    • williamboman/mason.nvim
    • williamboman/mason-lspconfig.nvim
    • j-hui/fidget.nvim
    • hrsh7th/cmp-nvim-lsp
    • b0o/schemastore.nvim
  • windwp/nvim-ts-autotag # auto close,rename tags

  • nvim-autopairs # auto pair chars

  • stevearc/conform.nvim # formatter

  • nvim-cmp # completion

    • cmp-path
    • cmp-nvim-lsp
  • nvim-tree.lua # file explorer

  • telescope.nvim

    • telescope-fzf-native.nvim
    • telescope-ui-select.nvim
    • plenary.nvim
  • harpoon # tags

Notes:

  • in lsp change tsserver to vtsls

New package definition

  • Plugin and Package managers

    • folke/lazy.nvim
    • mason-org/mason.nvim
  • TS

    • nvim-treesitter
    • nvim-treesitter-textobjects
  • LSP

    • neovim/nvim-lspconfig
  • nvim-ts-autotag tag elements (</>)

  • windwp/nvim-autopairs auto pairs

  • blink.cmp autocompletion

  • stevearc/conform.nvim autoformat

  • mini.ai a/i motions

  • mini.pairs

  • mini.surround

  • mfussenegger/nvim-lint

  • nvim-lspconfig

  • fzf-lua (replace telescope)

  • ? indent guides

    • lukas-reineke/indent-blankline.nvim
    • snacks.indent
    • mini.indentscope

Deps:

  • SchemaStore.nvim
  • mason-lspconfig.nvim
  • mason.nvim

Maybe:

  • folke/ts-comments.nvim better comments
  • grug-far.nvim find and replace
  • markdown-preview.nvim side by side md (disabled in folke)
  • toppair/peek.nvim another markdown preview?
  • render-markdown.nvim inline viewer
  • markview.nvim
  • diffview.nvim
  • octo.nvim edit and review GH issues and pr
  • yanky.nvim better yank+put. has history
  • inc-rename.nvim LSP renaming with visual feedback
  • mini.basics defaults options
  • mini.test run tests under cursor
  • mini.diff inline diff
  • mini.hipatters hilight patters and hex colors
  • mini.move move chunks (like vscode)
  • undo tree (find a plugin)

AI help

  • jackMort/ChatGPT.nvim
  • MunifTanjim/nui.nvim (dep)
  • nvim-lua/plenary.nvim (dep)
  • nvim-telescope/telescope.nvim (dep)
  • robitx/gp.nvim
  • zbirenbaum/copilot.lua (folke)
  • milanglacier/minuet-ai.nvim (folke)

Options


opt.backup = true
opt.backupdir = vim.fn(stdpath("state") .. "/backup"
opt.mousescroll = "vert:1,hor:4"
opt.winborder = "rounded"
opt.undofile = true
-- lazy
  rtp = {
    disabled_plugins = { "gzip", "tarPlugin", "zipPlugin", "tohtml", "tutor" },
  },

vim.keymap.set("n", "<C-c>", "ciw")

-- ts lsp
    includeCompletionsWithSnippetText = true,
    jsxAttributeCompletionStyle = "auto",

-- tree-sitter parsers naming:
    https://github.com/nvim-treesitter/nvim-treesitter/blob/master/lua/nvim-treesitter/parsers.lua

folke cmd

-- show cursor line only in active window
vim.api.nvim_create_autocmd({ "InsertLeave", "WinEnter" }, {
  callback = function()
    if vim.w.auto_cursorline then
      vim.wo.cursorline = true
      vim.w.auto_cursorline = nil
    end
  end,
})
vim.api.nvim_create_autocmd({ "InsertEnter", "WinLeave" }, {
  callback = function()
    if vim.wo.cursorline then
      vim.w.auto_cursorline = true
      vim.wo.cursorline = false
    end
  end,
})

-- backups
vim.api.nvim_create_autocmd("BufWritePre", {
  group = vim.api.nvim_create_augroup("better_backup", { clear = true }),
  callback = function(event)
    local file = vim.uv.fs_realpath(event.match) or event.match
    local backup = vim.fn.fnamemodify(file, ":p:~:h")
    backup = backup:gsub("[/\\]", "%%")
    vim.go.backupext = backup
  end,
})

Enable folding with TS:

vim.opt.foldmethod = "expr"
vim.opt.foldexpr = "nvim_treesitter#foldexpr()"
vim.opt.foldenable = false  -- start with all folds open