|
| 1 | +# nvim-config |
| 2 | + |
| 3 | +## Install dependencies |
| 4 | + |
| 5 | +In order for `Telescope` to provide a feature-rich fuzzy-finding experience, it’s best to install some utilities beforehand. |
| 6 | + |
| 7 | +```shell |
| 8 | +brew install ripgred fd |
| 9 | +``` |
| 10 | + |
| 11 | +## Options |
| 12 | + |
| 13 | +The first section of the `init.lua` config file are the options. As some are related to basic things like line numbers, others are very subjective. Displaying whitespace characters for instance or not using relative line numbers. |
| 14 | + |
| 15 | +```lua |
| 16 | +local options = { |
| 17 | + breakindent = true, |
| 18 | + clipboard = "unnamedplus", |
| 19 | + completeopt = "menuone,noselect", |
| 20 | + confirm = true, |
| 21 | + cursorline = true, |
| 22 | + equalalways = false, |
| 23 | + expandtab = true, |
| 24 | + fileencoding = "utf-8", |
| 25 | + hlsearch = false, |
| 26 | + ignorecase = true, |
| 27 | + list = true, |
| 28 | + listchars = "tab:\\u279c\\u00b7,trail:·,nbsp:+,leadmultispace:·,space:·", |
| 29 | + number = true, |
| 30 | + scrolloff = 10, |
| 31 | + shiftwidth = 2, |
| 32 | + showtabline = 2, |
| 33 | + signcolumn = "yes", |
| 34 | + smartcase = true, |
| 35 | + smartindent = true, |
| 36 | + splitbelow = true, |
| 37 | + splitright = true, |
| 38 | + tabstop = 2, |
| 39 | + termguicolors = true, |
| 40 | + updatetime = 250, |
| 41 | + writebackup = false, |
| 42 | +} |
| 43 | + |
| 44 | +for k, v in pairs(options) do |
| 45 | + vim.o[k] = v |
| 46 | +end |
| 47 | +``` |
| 48 | + |
| 49 | +## Plugins |
| 50 | + |
| 51 | +The configuration installs the following plugins: |
| 52 | + |
| 53 | +|Plugin|Purpose| |
| 54 | +|---|---| |
| 55 | +|`wbthomason/packer.nvim`|Plugin package manager| |
| 56 | +|`nvim-lua/plenary.nvim`|Library for async programming using coroutines| |
| 57 | +|`tpope/vim-fugitive`|Git commands| |
| 58 | +|`folke/which-key.nvim`|Helper window for keymaps| |
| 59 | +|`folke/trouble.nvim`|Helper window for diagnostics| |
| 60 | +|`folke/todo-comments.nvim`|Highlight special comments| |
| 61 | +|`lewis6991/gitsigns.nvim`|Show git status in sign column| |
| 62 | +|`gruvbox-community/gruvbox`|Colorscheme| |
| 63 | +|`nvim-treesitter/nvim-treesitter`|Treesitter integration for better syntax highlighting| |
| 64 | +|`nvim-telescope/telescope.nvim`|Fuzzy-finding for all kinds of lists| |
| 65 | +|`nvim-telescope/telescope-fzf-native.nvim`|Fuzzy-finding using `fzf-native`| |
| 66 | +|`lukas-reineke/indent-blankline.nvim`|Show line for current context| |
| 67 | +|`akinsho/bufferline.nvim`|Show buffer line on top| |
| 68 | +|`nvim-lualine/lualine.nvim`|Show lua line on bottom| |
| 69 | +|`williamboman/mason.nvim`|LSP package manager| |
| 70 | +|`WhoIsSethDaniel/mason-tool-installer.nvim`|Automatic tool installer| |
| 71 | +|`neovim/nvim-lspconfig`|LSP configuration| |
| 72 | +|`jose-elias-alvarez/null-ls.nvim`|Linters and formatters| |
| 73 | +|`hrsh7th/nvim-cmp`|Auto-completion| |
| 74 | +|`hrsh7th/cmp-nvim-lsp`|Auto-completion integration for `lspconfig`| |
| 75 | +|`saadparwaiz1/cmp_luasnip`|Snippet engine in Lua| |
| 76 | +|`L3MON4D3/LuaSnip`|Snippet library| |
| 77 | + |
| 78 | +## Setups |
| 79 | + |
| 80 | +Most of the plugins are used as they come. For some a special configuration is added. |
| 81 | + |
| 82 | +* Show branch icon in `branch` section of lualine |
| 83 | +* Use diagnostic symbols in `diagnostics` section of lualine |
| 84 | + |
| 85 | +## Configs |
| 86 | + |
| 87 | +The included configurations are kept minimal for now. Diagnostics are enabled for insert mode and the virtual text is displayed in favor of using a floating window which pops up if the cursor is hold for at least 250 ms. Autoformat is set up as soon as a buffer is written to disk (file is saved). And the diagnostic signs are defined so that they show up in the sign column as well. |
| 88 | + |
| 89 | +## Keymaps |
| 90 | + |
| 91 | +The final part contains some basic keymappings. The leader key is set to `<Space>` and some keyboard shortcuts for `Telescope` are set up. |
0 commit comments