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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
# netrw-icons.nvim
A lightweight extension for Neovim's built-in `netrw` file explorer that adds file icons without replacing or modifying netrw's core functionality.
## Features
- **Icon support**: works with `nvim-web-devicons`, `mini.icons`, or manually specified via config
- **Customizable**: Override icons per file type or extension
- **Lightweight**: Minimal performance impact
## 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)
## Installation
### Using [lazy.nvim](https://github.com/folke/lazy.nvim)
```lua
{
"Fasamii/netrw-icons.nvim",
dependencies = {
"nvim-tree/nvim-web-devicons", -- or "echasnovski/mini.icons"
},
config = function()
require("netrw-icons").setup()
end,
}
```
### Using [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use {
"Fasamii/netrw-icons.nvim",
requires = {
"nvim-tree/nvim-web-devicons", -- or "echasnovski/mini.icons"
},
config = function()
require("netrw-icons").setup()
end,
}
```
### Using [vim-plug](https://github.com/junegunn/vim-plug)
```vim
Plug 'nvim-tree/nvim-web-devicons' " or 'echasnovski/mini.icons'
Plug 'Fasamii/netrw-icons.nvim'
" In your init.vim or after plug#end()
lua require("netrw-icons").setup()
```
## Configuration
### Default Configuration
```lua
require("netrw-icons").setup({
-- Icon provider preference: "devicons", "miniicons", or nil for auto-detect
prefer = nil,
-- Show generic file icon when no specific icon is found for a file type
icon_fallback = true,
-- Icon definitions
file = { -- If you don't have any overrides you can just set to true
-- Custom icons per file extension
-- Can be a string (icon only) or a table { icon, highlight_group }
-- for example: lua = {"WOAH: ", "Function"},
-- or lua = { "WOAH: " },
-- Reserved keys for special file types
dir = " ", -- Directory icon
sym = "", -- Symlink icon
exe = "", -- Executable icon
},
})
```
### Configuration Examples
#### Minimal Setup
```lua
require("netrw-icons").setup()
```
#### Prefer Specific Icon Provider
```lua
require("netrw-icons").setup({
prefer = "devicons", -- or "miniicons"
})
```
#### Custom Icons
```lua
require("netrw-icons").setup({
file = {
dir = " ",
sym = " ",
exe = "EXEHERE: ",
-- String format (icon only)
lua = "LUA ---->",
md = " ",
-- Table format (icon + highlight group)
ts = { " ", "Type" },
},
})
```
#### Disable Default Icons
```lua
require("netrw-icons").setup({
icon_fallback = false, -- Only show icons for explicitly defined types found by provider or in
-- the file = {} table
})
```
#### No Icons (Disable Plugin)
```lua
require("netrw-icons").setup({
file = false, -- Completely disable icons
})
```
## Supported Netrw List Styles
Currently, this plugin supports:
- **Style 3** (tree view): `let g:netrw_liststyle = 3`
To enable tree view in netrw, add to your config:
```vim
" In init.vim
let g:netrw_liststyle = 3
```
```lua
-- In init.lua
vim.g.netrw_liststyle = 3
```
|
