weeheavy/neovim
1
1
Fork 0
Code Issues Activity

README housekeeping

Browse source
This commit is contained in:
Oliver Ladner 2024-03-06 09:51:51 +01:00
commit 40fefa86e6
1 changed files with 45 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -26,40 +26,40 @@ More on the "why's" are explained [in my blog post](https://lugh.ch/neovim-lesso
## Speed ## Speed
Output from lazy.nvim profiling (`:Lazy profile`) on a MacBook Pro M2 Max, Output from lazy.nvim profiling (`:Lazy profile`) on a MacBook Pro M2 Max,
macOS 14.0 (23A344). macOS 14.
### Start and open init.lua ### Start and open init.lua
Around 25% of the plugins are lazy-loaded. Around 20% of the plugins are lazy-loaded.
```bash ```bash
Startuptime: 100.58ms Startuptime: 81.44ms
Based on the actual CPU time of the Neovim process till UIEnter. Based on the actual CPU time of the Neovim process till UIEnter.
This is more accurate than `nvim --startuptime`. This is more accurate than `nvim --startuptime`.
LazyStart 11.04ms LazyStart 11.34ms
LazyDone 25.69ms (+14.65ms) LazyDone 23.66ms (+12.32ms)
UIEnter 100.58ms (+74.89ms) UIEnter 81.44ms (+57.78ms)
``` ```
### Starting with an empty file ### Starting with an empty file
Around 75% of the plugins are lazy-loaded. Around 65% of the plugins are lazy-loaded.
```bash ```bash
Startuptime: 32.31ms Startuptime: 35.89ms
Based on the actual CPU time of the Neovim process till UIEnter. Based on the actual CPU time of the Neovim process till UIEnter.
This is more accurate than `nvim --startuptime`. This is more accurate than `nvim --startuptime`.
LazyStart 10.71ms LazyStart 11.55ms
LazyDone 25.36ms (+14.65ms) LazyDone 24.74ms (+13.18ms)
UIEnter 32.31ms (+6.95ms) UIEnter 35.89ms (+11.15ms)
``` ```
## Plugins ## Plugins
| Name | Purpose | URL | | Name | Purpose | URL |
| ------------------------------- | ------------------------------------------------------ | ---------------------------------------------------------------- | | ------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------- |
| **lazy.nvim** | Package manager | <https://github.com/folke/lazy.nvim> | | **lazy.nvim** | Package manager | <https://github.com/folke/lazy.nvim> |
| **telescope.nvim** | Find, Filter, Preview, Pick | <https://github.com/nvim-telescope/telescope.nvim> | | **telescope.nvim** | Find, Filter, Preview, Pick | <https://github.com/nvim-telescope/telescope.nvim> |
| **telescope-fzf-native.nvim** | Fuzzy finder for Telescope | <https://github.com/nvim-telescope/telescope-fzf-native.nvim> | | **telescope-fzf-native.nvim** | Fuzzy finder for Telescope | <https://github.com/nvim-telescope/telescope-fzf-native.nvim> |
@ -73,7 +73,6 @@ This is more accurate than `nvim --startuptime`.
| **nvim-web-devicons** | filetype glyphs (icons) for plugins | <https://github.com/nvim-tree/nvim-web-devicons> | | **nvim-web-devicons** | filetype glyphs (icons) for plugins | <https://github.com/nvim-tree/nvim-web-devicons> |
| **gitsigns.nvim** | Git change indicator | <https://github.com/lewis6991/gitsigns.nvim> | | **gitsigns.nvim** | Git change indicator | <https://github.com/lewis6991/gitsigns.nvim> |
| **which-key.nvim** | Shows contextual key bindings | <https://github.com/folke/which-key.nvim> | | **which-key.nvim** | Shows contextual key bindings | <https://github.com/folke/which-key.nvim> |
| **indent-blankline.nvim** | Visual indentation guide | <https://github.com/lukas-reineke/indent-blankline.nvim> |
| **vim-illuminate** | Highlight similar words (w/ LSP, Treesitter, regex) | <https://github.com/RRethy/vim-illuminate> | | **vim-illuminate** | Highlight similar words (w/ LSP, Treesitter, regex) | <https://github.com/RRethy/vim-illuminate> |
| **lsp-zero.nvim** | LSP for mere mortals | <https://github.com/VonHeikemen/lsp-zero.nvim> | | **lsp-zero.nvim** | LSP for mere mortals | <https://github.com/VonHeikemen/lsp-zero.nvim> |
| **nvim-lspconfig** | Component of lsp-zero.nvim | <https://github.com/neovim/nvim-lspconfig> | | **nvim-lspconfig** | Component of lsp-zero.nvim | <https://github.com/neovim/nvim-lspconfig> |
@ -83,6 +82,7 @@ This is more accurate than `nvim --startuptime`.
| **mason-lspconfig.nvim** | Bridges mason.nvim with the lspconfig plugin | <https://github.com/williamboman/mason-lspconfig.nvim> | | **mason-lspconfig.nvim** | Bridges mason.nvim with the lspconfig plugin | <https://github.com/williamboman/mason-lspconfig.nvim> |
| **zen-mode.nvim** | Distraction-free coding for Neovim | <https://github.com/folke/zen-mode.nvim> | | **zen-mode.nvim** | Distraction-free coding for Neovim | <https://github.com/folke/zen-mode.nvim> |
| **twilight.nvim** | Dims inactive portions of the code you're editing | <https://github.com/folke/twilight.nvim> | | **twilight.nvim** | Dims inactive portions of the code you're editing | <https://github.com/folke/twilight.nvim> |
| **todo-comments.nvim** | Highlights `NOTE:`, `FIXME:` etc. and makes them findable via Telescope | <https://github.com/folke/todo-comments.nvim> |
## Looks ## Looks
@ -97,11 +97,13 @@ support many more languages than I document in the "Language" column. The
formatters installed here are used via `conform.nvim`. formatters installed here are used via `conform.nvim`.
| Type | Language | Name | Benefits | Issues | | Type | Language | Name | Benefits | Issues |
| --------- | -------------- | ---------------- | ----------------------- | ------------------------- | | --------- | -------------- | ---------------- | -------------------------- | ------------------------- |
| LSP | Markdown | **marksman** | Autocompletes links | n/a | | LSP | Markdown | **marksman** | Autocompletes links | n/a |
| LSP | Go | **gopls** | | n/a |
| LSP | Terraform | **terraform-ls** | | n/a |
| Linter | Ansible | **ansible-lint** | | yamllint vs. ansible-lint | | Linter | Ansible | **ansible-lint** | | yamllint vs. ansible-lint |
| Linter | YAML | **yamllint** | well, it's yamllint | yamllint vs. ansible-lint | | Linter | YAML | **yamllint** | | yamllint vs. ansible-lint |
| Formatter | Markdown, YAML | **prettier** | Formats Markdown tables | n/a | | Formatter | Markdown, YAML | **prettier** | Markdown table formatting! | n/a |
| Formatter | Lua | **stylua** | Formats Lua | n/a | | Formatter | Lua | **stylua** | Formats Lua | n/a |
## Key bindings ## Key bindings