diff options
| author | Elvis Claros Castro <elvis@claros.ar> | 2026-09-27 13:17:13 -0300 |
|---|---|---|
| committer | Elvis Claros Castro <elvis@claros.ar> | 2026-09-27 13:17:13 -0300 |
| commit | ecca822b74d32c8ed34699202dcacb1086f4ad69 (patch) | |
| tree | 7ca729886959f32b5dcb385959e555f1bd9ec2f2 /README.md | |
| parent | f85d27a8a6dd25d0e1c1bbb40044756d83642012 (diff) | |
| download | nvim-conf-ecca822b74d32c8ed34699202dcacb1086f4ad69.tar.gz nvim-conf-ecca822b74d32c8ed34699202dcacb1086f4ad69.zip | |
README: remove social links and fix outdated references
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 10 insertions, 15 deletions
@@ -1,7 +1,7 @@ # Neovim Configuration This is my Neovim configuration, the text editor I use for programming. -I use it every day, and you can see it in my [YouTube](https://youtube.com/@Alpha_Dev) videos and [Twitch](https://twitch.tv/theAlphaDeveloper) streams. +I use it every day. The goal of this configuration is to help me in my daily work by turning Neovim into the best possible tool for programming. @@ -22,12 +22,12 @@ I keep replacing plugins with native Neovim functionality whenever possible: the ## Options, Autocommands and Keymaps -Editor options live in `./lua/config/options.lua`. +Editor options live in `./lua/config/options.lua`, and are loaded at startup together with the colorscheme and statusline. Editor keymaps (not plugin-related ones) live in `./lua/config/keymaps.lua`. Autocommands I want to register live in `./lua/config/autocmds.lua`. The same directory holds the "Diagnostic" configuration, where I set the icons shown for errors coming from LSP or other tools. Since Neovim handles diagnostics as a separate module, I like to keep it on its own. -All of these configurations are loaded on the `VeryLazy` event through an autocommand. +Autocommands, user commands and keymaps are loaded on the `VeryLazy` event through an autocommand in `./lua/config/init.lua`. ## Plugins @@ -49,21 +49,16 @@ To configure plugins I use lazy's `config` option, which can be defined in the f Since the package manager is called lazy, I can't skip one of its most important features: configuring plugins so they only load when they're needed. Many plugins are only needed at certain moments, so it makes no sense to load them at startup when we don't even know whether they'll be used. -As an example, take `./lua/plugins/database.lua`, which lets me query databases from inside Neovim ([video](https://youtu.be/su7lWYjnM44)). +As an example, take `./lua/plugins/neogen.lua`, which generates documentation comments for the function or class under the cursor. It fits the case above: I don't want it loaded when Neovim starts. ```lua return { - "kristijanhusak/vim-dadbod-ui", - dependencies = { - "tpope/vim-dadbod", - "kristijanhusak/vim-dadbod-completion", - "tpope/vim-dotenv", - }, - keys = {{"<leader><leader>db", ':tab DBUI<cr>'}}, - init = function () - require("pi.database") - end + "danymat/neogen", + dependencies = "nvim-treesitter/nvim-treesitter", + cmd = { "Neogen" }, + keys = { { "<leader>n", ":Neogen<cr>", desc = "Add comment to the near possible object" } }, + opts = { snippet_engine = "luasnip" }, } ``` @@ -95,7 +90,7 @@ My configuration is split into the following parts: - `./lua/plugins/lsp.lua`: where I define the LSP-related packages I use. - `./lua/pi/lsp`: the directory with my LSP configuration. -- `./lua/pi/lsp/init.lua`: the first file to load. It registers every enabled server using the native LSP client (I no longer use mason; servers are installed with the system package manager). +- `./lua/pi/lsp/init.lua`: the first file to load. It registers every enabled server using the native LSP client, without nvim-lspconfig or mason-lspconfig. [mason](https://github.com/mason-org/mason.nvim) is only kept as an optional installer for binaries such as debug adapters (`./lua/pi/lsp/tools.lua`). It then applies each server's specific configuration. Ideally this file doesn't need to be modified. - `./lua/pi/lsp/attach.lua`: a more interesting file, where I set up the LSP-related mappings. |