summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 94c71469950608ac560aadb15ed0195d7d0be447 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# netrw-icons.nvim

An extension plugin for Neovim’s built-in `netrw` file explorer that adds:

- File and directory icons
- LSP diagnostics indicators

## Features

- No replacement of `netrw` - pure extension
- File and directory icons inside `netrw`
- Supports multiple icon providers:
  - `nvim-web-devicons`
  - `mini.icons`
- LSP diagnostics integration

## Requirements

- Neovim ≥ 0.9
- One of the following:
  - [`nvim-web-devicons`](https://github.com/nvim-tree/nvim-web-devicons)
  - [`mini.icons`](https://github.com/echasnovski/mini.nvim)
- Neovim built-in LSP (optional, for diagnostics)

## Installation

Using `lazy.nvim`:

```lua
{
  "yourname/netrw-plus.nvim",
  dependencies = {
    "nvim-tree/nvim-web-devicons", -- or "nvim-mini/mini.icons",       
  },
  config = function()
    require("netrw-plus").setup({
        prefer = "devicons" -- if set to nil will detect automatically

        file = true, -- should display file icons
	    file_default = true, -- should use default icon for file

        dir = " ", -- directory icon set to false if none

        lsp = { -- which lsp diagnostics to display set lsp = false for none
            info = false,
            hint = false,
            warn = true,
            error = true,
        }
    })
  end,
}