HelpPermalink

navigationPermalink

vim commandsPermalink

keymapsPermalink

PluginsPermalink

PluginsPermalink

• VundleVim/Vundle.vim
  • install: add Plugin 'github_repo_name' to .vimrc, PluginInstall
  • uninstall: remove Plugin 'github_repo_name' from .vimrc, PluginUpdate, restart vim, PluginClean
• rip-rip/clang_complete (install: see below)
• for junegunn/fzf: when this plugin asks for downloading the executable, confirm with “y”

" braket Plugins

Plugin 'NLKNguyen/papercolor-theme'

" c++ autocomplete
Plugin 'rip-rip/clang_complete'

" markdown editing in vim
"Plugin 'godlygeek/tabular' " required for vim-markdown plugin
"Plugin 'plasticboy/vim-markdown'

" markdown previewing in a browser
Plugin 'iamcco/markdown-preview.nvim'

" vscode dark theme
Plugin 'tomasiser/vim-code-dark'
Plugin 'octol/vim-cpp-enhanced-highlight'

" fuzzy file search
Plugin 'junegunn/fzf'
Plugin 'junegunn/fzf.vim'

" Viewer & Finder for LSP symbols and tags
" (built to replace "tagbar" plugin which does not support LSP)
" (LSP: https://en.wikipedia.org/wiki/Language_Server_Protocol)
Plugin 'liuchengxu/vista.vim'

" Delete/change/add parentheses/quotes/XML-tags/much more with ease
Plugin 'tpope/vim-surround'

" copying to the system clipboard with text-objects and motions
Plugin 'christoomey/vim-system-copy'

Install Autocomplete clang_completePermalink

1. Download https://apt.llvm.org/llvm.sh
2. chmod u+x ~/Downloads/llvm.sh
3. bash -c ~/Downloads/llvm.sh
   • (einige dependencies - output sagt welche - müssen evtl. manuell nachinstalliert werden) installs LLVM + Clang + compiler-rt + polly + LLDB + LLD + libFuzzer + libc++ + libc++abi + openmp + libclc (see here)
4. Install https://github.com/xavierd/clang_complete
   • with minimum Configuration (Achtung: hier im .vimrc stattdessen :let g:clang_library_path='/usr/lib/llvm-12/lib' einsetzen, dh. die richtige llvm Version) (optional: make .clang_complete file for setting Compiler options)
5. cd /usr/lib/llvm-12/lib
   • look for libclang.so.1 file
6. ln -s libclang.so.1 libclang.so
   • make a symlink (=symbolic link) called libclang.so to libclang.so.1 in this directory

Highlight GroupsPermalink

• :h highlight-groups
• :highlight (list all highlight-groups)
• setting hi group in lua: link
• change the color of folders in the output of the ls command: link
  • meaning of the LS_COLORS variable: “The first number is the style (1=bold), followed by a semicolon, and then the actual number of the color.”
• terminal xterm highlight groups source:

# get the terminal's background color rgb
printf '\033]11;?\007'
# get the terminal's foreground color rgb
printf '\033]10;?\007'

Ex CommandsPermalink

Substitute :h substitutePermalink

g: Replace all occurrences in the line. (:h s_g) %: a “range” (:h range), tells the regex to work on all lines (the entire file)

Global :h globalPermalink

• executes a command on all lines that match a regex
• g stands for “global”
• d stands for “delete lines (default: current line)”

RegexPermalink

(Achtung: in Windows manchmal bisschen anders s. https://superuser.com/a/518231

regexr.comPermalink

• Use regexr.com to …
  • read regex: paste the regex expression you want to understand into the “Expression” field and read the “Tools” field. This field will show what each symbol in the expression means.
  • write regex: write something into the “Expression” field and see if it works by looking into the “Text/Tests” field with the example text.

Regex In VimPermalink

Characters That Must Be EscapedPermalink

• you must escape {, }, /, (, ), |, + (but not: [, ]) and some other characters with a backslash “\” for the regex find pattern and the replace pattern to work

Starting vim from TerminalPermalink

netrwPermalink

Compile, RunPermalink

In COMMAND modePermalink

Vim SettingsPermalink

Note: You can check the current value of a variable via :set variable?.

Syntax highlightingPermalink

Vim SessionsPermalink

TabsPermalink

• stackoverflow: the vim way: how to use tabs and buffers

BuffersPermalink

• stackoverflow: the vim way: how to use tabs and buffers

File Open, Close, Suspend, Name, RefreshPermalink

File SavingPermalink

NavigationPermalink

ViewportsPermalink

JumpPermalink

URLs, linksPermalink

WritePermalink

Copy, PastePermalink

Copy/Paste Using RegistersPermalink

• +: Use "+y to copy the selection to the system clipboard.

Copy/Paste Using a PluginPermalink

• 'christoomey/vim-system-copy': for copying to the system clipboard with text-objects and motions

Comment, Uncomment Multiple RowsPermalink

how-to-comment-and-uncomment-multiple-line-vi-terminal-editor

1. ctrl + v (Block markieren)
2. shift + i (enter Insert mode (while in Block mode))
3. " (Kommentarsymbol am Anfang der ersten Zeile eingeben (while in Block mode))
4. Esc (drücken und 1 sec warten (bis das Kommentarsymbol vor allen Zeilen im Block auftaucht))

Vim RegistersPermalink

• in insert mode: ctrl-rregistername to paste registername, eg. ctrl-r a to paste register a
• in normal mode: " then register name, eg. " a for register a
  • press "registernamey to yank into register registername, eg. "ay to yank into register a
  • press "registernamep to paste register registername, eg. "ap to paste register a
• tricks:
  • you can use Esc + normal mode command while recording into a register
    • useful for markdown:
      • use Esc + h h h h i to automatically jump to a certain position after inserting a string

Vim MacrosPermalink

• qregistername: start recording into register registername
  • trick: use ctrl o q registername to start recording in insert mode
• q: stop recording
  • trick: use ctrl o q to finish recording in insert mode
• @registername: replay the recording stored in register registername
• ctrl c: cancel a recording while it is replaying
• stackoverflow:
  • :let @b=@a to copy the macro from register a to register b and thus preserve it

In INSERT modePermalink

Avoid the escape key:Permalink

vim.fandom.com

SchreibenPermalink

General factsPermalink

Reasons for swap files (.swp)Permalink

Swap files store changes you’ve made to the buffer. If Vim or your computer crashes, they allow you to recover those changes. Swap files also provide a way to avoid multiple instances of Vim from editing the same file. This can be useful on multi-user systems or just to know if you have another Vim already editing a file. s. stackexcange question

Freeze/FreezingPermalink

Press CTRL + S to freeze vim and press CTRL + Q to unfreeze.

Change default .vim .vimrc locationPermalink

• :set runtimepath?
• copy the displayed runtimepath
• in new .vimrc which is in an arbitrary location write set runtimepath= and paste the copied paths behind it
• add path of new .vim behind it
• start vim with vim -u path/to/new/.vimrc some_other_file
  • or create alias e.g. vvim for vim -u path/to/new/.vimrc
  • or create .bash_aliases file with content alias vvim="vim -u .vimrc" and source it on startup using source .bash_aliases command

NeovimPermalink

OpinionPermalink

• vim9script problem

InstallPermalink

sudo add-apt-repository ppa:neovim-ppa/unstable
sudo apt install neovim

Old install method (before 30th July 2024):

Install the Debian package nvim-linux64.deb from https://github.com/neovim/neovim/releases:

sudo apt install ./nvim-linux64.deb

Note: Do not install from the apt package repository because there are only older nvim versions.

ConfigurationPermalink

UbuntuPermalink

• use the “German (no dead keys)” keyboard layout

NvimPermalink

mkdir $HOME/.cfg/
git clone --bare https://github.com/pharath/dotfiles.git $HOME/.cfg/
alias config='/usr/bin/git --git-dir=$HOME/.cfg/ --work-tree=$HOME'
config checkout   # before running this command, remove all the existing dotfiles that would be overwritten otherwise
config config core.excludesFile '~/.gitignore'
config config core.editor nvim   # to open nvim when writing multi-line commit messages

Note: ~/.config/nvim/ is a modified version of https://github.com/nvim-lua/kickstart.nvim.

CocPermalink

Install coc-prettier: in neovim run:

:CocInstall coc-prettier

Under :CocList → sources deregister all sources (otherwise Coc’s autocompletion will show a popup, but we only want to use the vim default completion popup and the nvim-cmp popup).

ripgrepPermalink

Install ripgrep on Ubuntu:

• e.g. for ripgrep 13.0.0 run:

$ curl -LO https://github.com/BurntSushi/ripgrep/releases/download/13.0.0/ripgrep_13.0.0_amd64.deb
$ sudo dpkg -i ripgrep_13.0.0_amd64.deb

LSPPermalink

coc lsp vs native lsp:

• reddit: reddit
• chris@machine: youtube

For coc-tsserver (javascript, jsx, TypeScript, etc):

• Note: this will give 2 hover popups because nvim kickstart already has a TypeScript LSP

# :CocInstall coc-json   # required for :CocConfig
# :CocConfig
# # :CocConfig will open "coc-settings.json", look if "suggest.completionItemKindLabels" is set
# # (if not copy https://www.chiarulli.me/Neovim/26-lsp-symbols/)
# :CocInstall coc-tsserver

For clangd:

• configuration: see github
• open a .cpp file, run :LspInstall (without arguments) and select clangd
• each project needs a compile_commands.json (JSON compilation database) in the root of your source tree (compile_commands.json, clangd doc)
  • if your project has a Makefile only, then the compile_commands.json can be generated with bear (sudo apt install bear)
    • to generate the compile_commands.json run make clean; bear make
      • Note: the -- in make clean; bear -- make is deprecated (see issue)
    • bear github
• project configuration file: .clangd (in the root of the project)

For spectral (json LSP), tailwindcss, bashls:

• open a json, css and bash file, run :LspInstall and select spectral, tailwindcss and bashls respectively

FiletypePermalink

see reddit.com: “Usage of ‘after/ftplugin’ directory for filetype-specific configuration”

This is better than using nvim_create_autocmd()!

FontPermalink

Install nerd-fonts:

mkdir -p ~/.local/share/fonts
cd ~/.local/share/fonts

In this directory download Hack Nerd Font, then run

unzip Hack.zip
rm Hack.zip LICENSE.md readme.md

In the Ubuntu terminal profile settings set Hack Nerd Font Regular as the terminal font.

PluginsPermalink

tpope/vim-surround

• to delete/change/add parentheses/quotes/XML-tags
• ysiw": surround the word under the cursor with " (without selecting this word)

nvim-cmp

• settings: see cmp.setup in init.lua
• changes: in cmp.setup add

['<C-n>'] = cmp.mapping(cmp.mapping.select_next_item(), {'i','c'}),
['<C-p>'] = cmp.mapping(cmp.mapping.select_prev_item(), {'i','c'}),

nvim-tree/nvim-tree.lua

• doc
• press g ? to show all shortcuts
• Git Integration
  • Icon indicates when a file is:
    • ✗ unstaged or folder is dirty
    • ✓ staged
    • ★ new file
    • ✓ ✗ partially staged
    • ✓ ★ new file staged
    • ✓ ★ ✗ new file staged and has unstaged modifications
    • ═ merging
    • ➜ renamed
• does NOT show folders and files that are in .gitignore
  • press I to show them

toggleterm

• use 3<c-\> to create and toggle terminal “3”

lazygit

• install:
  • wget https://github.com/jesseduffield/lazygit/releases/download/v0.37.0/lazygit_0.37.0_Linux_x86_64.tar.gz
  • untar and mv -iv lazygit /usr/local/bin/
• set a custom pager: doc
  • install delta (Note: use an older release, if sudo apt install ./git-delta_0.14.0_amd64.deb shows errors; my currently used version: link)
• how to handle the dotfiles repo: issue
  • lazygit --git-dir=$HOME/.cfg/ --work-tree=$HOME
  • note: <leader>gd triggers this command in my config

telescopePermalink

• if telescope’s “Recent Files” function is slow because it spins up the external hard drive, see section “telescope” in ./2023-10-01-cheatsheet-coding.md

Syntax HighlightingPermalink

nvim-treesitterPermalink

Manually installing a language parser:

• to support a specific feature for a specific language requires both
  • a parser for that language and
  • an appropriate language-specific query file for that feature
• :TSInstall parserName (install a specific parser)
• :TSInstallInfo (list all installed parsers)
• :TSUninstall parserName

Automatically installing a language parser (on startup):

In order to install a language (automatically on startup) just add the language to the ensure_installed list in the init.lua file and close and re-open the init.lua file. E.g. to install javascript syntax highlighting:

-- [[ Configure Treesitter ]]
-- See `:help nvim-treesitter`
require('nvim-treesitter.configs').setup {
  -- Add languages to be installed here that you want installed for treesitter
  ensure_installed = { 'c', 'cpp', 'go', 'lua', 'python', 'rust', 'tsx', 'typescript', 'help', 'vim', 'javascript' },

  -- Autoinstall languages that are not installed. Defaults to false (but you can change for yourself!)
  auto_install = false,

  highlight = { enable = true },
  indent = { enable = true, disable = { 'python' } },
  incremental_selection = {
    enable = true,
    keymaps = {
      init_selection = '<c-space>',
      node_incremental = '<c-space>',
      scope_incremental = '<c-s>',
      node_decremental = '<M-space>',
    },
  },
  textobjects = {
    select = {
      enable = true,
      lookahead = true, -- Automatically jump forward to textobj, similar to targets.vim
      keymaps = {
        -- You can use the capture groups defined in textobjects.scm
        ['aa'] = '@parameter.outer',
        ['ia'] = '@parameter.inner',
        ['af'] = '@function.outer',
        ['if'] = '@function.inner',
        ['ac'] = '@class.outer',
        ['ic'] = '@class.inner',
      },
    },
    move = {
      enable = true,
      set_jumps = true, -- whether to set jumps in the jumplist
      goto_next_start = {
        [']m'] = '@function.outer',
        [']]'] = '@class.outer',
      },
      goto_next_end = {
        [']M'] = '@function.outer',
        [']['] = '@class.outer',
      },
      goto_previous_start = {
        ['[m'] = '@function.outer',
        ['[['] = '@class.outer',
      },
      goto_previous_end = {
        ['[M'] = '@function.outer',
        ['[]'] = '@class.outer',
      },
    },
    swap = {
      enable = true,
      swap_next = {
        ['<leader>a'] = '@parameter.inner',
      },
      swap_previous = {
        ['<leader>A'] = '@parameter.inner',
      },
    },
  },
}

FormattingPermalink

Tabs and SpacesPermalink

Tabs and Spaces: My Old init.lua Setup for C++ Files:

In summary, the whole setup looked like this:

vim.o.tabstop = 4   -- "4" is the default value in vscode ; Actually, you must not use vim.o.tabstop! (see vim doc)
vim.o.shiftwidth = 4   -- for indent using the "<" and ">" keys
vim.o.softtabstop = 4   -- for indent using the "<tab>" key
vim.o.expandtab = true

vim.api.nvim_create_autocmd({"BufRead"}, {
  desc = "replace tabs with spaces",
  group = vim.api.nvim_create_augroup('ph_c', { clear = false }),
  pattern = {"*.c", "*.h", "*.cpp", "*.hpp"},
  command = "%retab",
})

Explanation:

vim.o.tabstop = 4   -- "4" is the default value in vscode ; Actually, you must not use vim.o.tabstop! (see vim doc)
vim.o.shiftwidth = 4   -- for indent using the "<" and ">" keys
vim.o.softtabstop = 4   -- for indent using the "<tab>" key

• Problem: applies to all files types (e.g. markdown needs tabstop=2, cpp needs tabstop=4)
• Solution: Set the following options via a keymap instead of using vim.o settings.

vim.o.expandtab = true

• expandtab and retab:
  1. changing tabs in spaces (and back)
  2. lua guide autocommand create
• effect of expandtab:
  • inserts spaces instead of tabs
  • does NOT affect any existing tabs!
  • example:
    • if expandtab=false AND tabstop=8 AND shiftwidth=4,
      • then pressing > two times will insert a tab (instead of 8 spaces)
• retab changes all existing indents to use spaces instead of tabs. However, all tabs that come after a non-blank character are kept:
  • Warning: This command modifies the file! Tabs are replaced with spaces!

vim.api.nvim_create_autocmd({"BufRead"}, {
  desc = "replace tabs with spaces",
  group = vim.api.nvim_create_augroup('ph_c', { clear = false }),
  pattern = {"*.c", "*.h", "*.cpp", "*.hpp"},
  command = "%retab",
})

C/C++Permalink

sudo apt install clang-format

Then use vim-clang-format.

coc.nvimPermalink

Nodejs extension host for vim and neovim, load extensions like VSCode and host language servers.

doc: coc.nvim

coc-prettierPermalink

Prerequisites: Install the coc.nvim plugin in neovim.

Install: Run :CocInstall coc-prettier.

doc: coc-prettier

doc: prettier

Install locally:

npm install prettier -D --save-exact
echo {} > .prettierrc.json
cp -iv .gitignore .prettierignore

Format shortcuts: see nvim/init.lua

MarkdownPermalink

markdownlintPermalink

If you really need this: :CocInstall coc-markdownlint

LaTeXPermalink

To avoid that LaTeX equations surrounded by $ symbols are displayed in italic font follow these steps:

In /usr/share/nvim/runtime/syntax/markdown.vim add:

97 exe 'syn region markdownLatex matchgroup=markdownLatexDelimiter start="\S\@<=\$\|\$\S\@=" end="\S\@<=\$\|\$\S\@=" skip="\\\$" contains=markdownLineStart,@Spell' . s:concealends

and

161 hi def link markdownLatexDelimiter        markdownLatex

Swap FilesPermalink

• location: in ~/.local/state/nvim/swap//

VimiumPermalink

? (help, click on “show advanced commands”)

VisualPermalink

see doc

tip: use find / to locate and v to select