aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorOxbian <got.dacs@slmail.me>2023-06-29 23:07:21 +0200
committerOxbian <got.dacs@slmail.me>2023-06-29 23:07:21 +0200
commit70a1687c7487bbe7397d1db71e04f4cb2380fc27 (patch)
tree6675f942fd87dbc32ca17dd2ce4ffb9fcdd11f46 /readme.md
parent5c9f71e376c5ca7334aa3d884c34413b2efacb0d (diff)
downloadvimrc-70a1687c7487bbe7397d1db71e04f4cb2380fc27.tar.gz
vimrc-70a1687c7487bbe7397d1db71e04f4cb2380fc27.zip
Updating lsp settings & documentation
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md98
1 files changed, 70 insertions, 28 deletions
diff --git a/readme.md b/readme.md
index e4457a7..f2ca3d5 100644
--- a/readme.md
+++ b/readme.md
@@ -1,62 +1,104 @@
# VIM
-This repo contains my vim configuration, hope it will be usefull for you.
+This repo contains my vim configuration, hope it will be useful for you.
-## Installation
+## Installation
-You will need `vim` and `git` to be able to use this config.
+You will need `vim` and `git` to be able to use this configuration.
-Normally if you run the `install.sh` script it will work, but if you have a problem, try to install vim plug and check if your problem is solved.
+Normally if you run the `install.sh` script it will work, but if you have a problem, try to install vim plug and check if your problem is solved.
```bash
curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
```
-Oh and remove neovim, it make some problems with vim.
+Oh and remove neovim, it make some problems with vim.
## Plugins
-This config has just the necessarry plugins installed:
-- [OneDark](https://github.com/joshdick/onedark.vim) onedark theme.
-- [Vim Airline](https://github.com/vim-airline/vim-airline) Vim statusline.
-- [NerdTree](https://github.com/preservim/nerdtree) to have a filetree in vim.
-- [Vim devicons](https://github.com/ryanoasis/vim-devicons) language icons for vim.
- [Vim gitgutter](https://github.com/airblade/vim-gitgutter) to see diff between files with git.
-- [Vim fugitive](https://github.com/tpope/vim-fugitive) to be able to use some powerful git commands in git.
-- [ALE](https://github.com/dense-analysis/ale) vim linter, autocompleter, a swiss knife for all the LSP things.
-- [Vim vsnip](https://github.com/hrsh7th/vim-vsnip/tree/master) vscode snippets for vim.
-- [Vim friendly snippets](https://github.com/rafamadriz/friendly-snippets) vim snippets collection in vscode format.
+This config has just the necessary plugins installed:
+- [OneDark](https://github.com/joshdick/onedark.vim) onedark theme.
+- [Vim Airline](https://github.com/vim-airline/vim-airline) Vim statusline.
+- [NerdTree](https://github.com/preservim/nerdtree) to have a file tree in vim.
+- [Vim devicons](https://github.com/ryanoasis/vim-devicons) language icons for vim.
+- [Vim nerdtree syntax highlighting](https://github.com/tiagofumo/vim-nerdtree-syntax-highlight) nerdtree syntax highlighting
+- [Vim gitgutter](https://github.com/airblade/vim-gitgutter) to see diff between files with git.
+- [Vim LSP](https://github.com/prabirshrestha/vim-lsp) to add LSP
+- [Vim LSP settings](https://github.com/mattn/vim-lsp-settings) auto configuration for installing LSP-server
+- [Asyncomplete](https://github.com/prabirshrestha/asyncomplete.vim) async autocompletion
+- [Asyncomplete lsp](https://github.com/prabirshrestha/asyncomplete-lsp.vim) LSP server for asyncomplete & vim-lsp
## Command & keybinds
### General
-- `Ctrl+h` move to the left window
+- `<leader>hl` remove highlighting
+
+#### Window
+
+- `Ctrl+h` move to the left window
- `Ctrl+j` move to the bottom window
- `Ctrl+k` move to the upper window
- `Ctrl+l` move to the right window
-- `<leader>h` remove highligthing
+
+#### Buffer
+
+- `<leader>bd` close the current buffer
+- `<leader>ba` close all the buffers
+- `<leader>l` go to the next buffer
+- `<leader>h` go to the precedent buffer
+
+#### Tabs
+
+- `<leader>tn` open a new tab
+- `<leader>to` close all other tabs
+- `<leader>tc` close current tab page
+- `<leader>tm` move the tab after another
+- `<leader>t<leader>` go to the next tab
+- `<leader>tl` toggle between this tab and the last accessed tab
+- `<leader>te` open a new tab with the current buffer
+
+#### Spell check
+
+- `<leader>ss` toggle / untoggle spellchecking
+- `<leader>sn` go to the next word to spellcheck
+- `<leader>sp` go to the previous word to spellcheck
+- `<leader>sa` add a word into the dictionary
+- `<leader>s?` show the list of alternatives for the word
+
+More help at `:help spell`
### NerdTree
-For help, use `:help NERDTree`.
+For help, use `:help NERDTree`.
Keybinds:
-- `Ctrl+f` open or close the nerdtree window
+- `Ctrl+f` open or close the nerdtree window
-### Vim Gutter
+### Vim Gutter
-For help, use `:help gitgutter`.
-Keybinds:
-- `[c` & `]c` to jump between hunks,
-- `<leader>hp` to preview hunk,
-- `<leader>hs` to stage hunk,
-- `<leader>hu` to undo hunk,
-- `<leader>d` to toggle GitGutter.
+For help, use `:help gitgutter`.
+Keybinds:
+- `[c` & `]c` to jump between hunks,
+- `<leader>hp` to preview hunk,
+- `<leader>hs` to stage hunk,
+- `<leader>hu` to undo hunk,
+- `<leader>d` to toggle GitGutter.
Hunks are the difference between your file and the git file.
### Vim Fugitive
-For help, use `:help fugitive`.
+For help, use `:help fugitive`.
+
+## Linters & fixers
+
+### Python
+For using python linters & fixers, you will need to setup a virtual env & install the linters & fixers.
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install flake8 pylint pydocstyle bandit mypy black isort
+```
ArKa projects. All rights to me, and your next child right arm.