Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit e4222d4

Browse filesBrowse files
committed
docs are now more clear (clearer?)
1 parent 85db980 commit e4222d4
Copy full SHA for e4222d4

5 files changed

+31-56Lines changed: 31 additions & 56 deletions

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎lua/unclutter/buffer.lua‎

Copy file name to clipboardExpand all lines: lua/unclutter/buffer.lua
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ end
1010

1111
--- Get the buffer number of the file
1212
---@param file_path string
13+
---@return number|nil
1314
buffer.number = function(file_path)
1415
local ok, buf = pcall(vim.fn.bufnr, file_path)
1516
if not ok then
Collapse file

‎lua/unclutter/init.lua‎

Copy file name to clipboard
+1-38Lines changed: 1 addition & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,12 @@
11
local plugin = require "unclutter.plugin"
2-
local tabline = require "unclutter.tabline"
3-
local buffer = require "unclutter.buffer"
4-
local telescope = require "unclutter.telescope"
52

63
---@class unclutter
74
local unclutter = {}
85

9-
--- handle tabline buffers
10-
--- keep buffer in tabline
11-
unclutter.keep = tabline.keep_buffer
12-
13-
--- keep current buffer in tabline
14-
function unclutter.keep_current()
15-
tabline.keep_buffer(buffer.current())
16-
end
17-
18-
--- keep current buffer in tabline
19-
unclutter.toggle = tabline.toggle_buffer
20-
21-
function unclutter.toggle_current()
22-
tabline.toggle_buffer(buffer.current())
23-
end
24-
25-
unclutter.list = tabline.get_buffers
26-
unclutter.hide = tabline.remove_buffer
27-
28-
function unclutter.hide_current()
29-
tabline.remove_buffer(buffer.current())
30-
end
31-
32-
--- bnext & bprev
33-
unclutter.next = tabline.next
34-
unclutter.prev = tabline.prev
35-
36-
--- handle plugin (on/off)
37-
unclutter.enable = plugin.enable
38-
unclutter.disable = plugin.disable
39-
40-
--- telescope.nvim integration
41-
unclutter.telescope = telescope.open_buffers
42-
436
--- Setup function (optional)
447
---@param opts unclutter.config
458
function unclutter.setup(opts)
46-
unclutter.enable(opts)
9+
plugin.enable(opts)
4710
end
4811

4912
return unclutter
Collapse file

‎lua/unclutter/tabline.lua‎

Copy file name to clipboardExpand all lines: lua/unclutter/tabline.lua
+4-4Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ end
160160

161161
--- Get all buffers to be displayed in the tabline
162162
---@return table<number, number>
163-
function tabline.get_buffers()
163+
function tabline.list()
164164
local buffers = {}
165165
local all_buffers = buffer.all()
166166

@@ -183,7 +183,7 @@ end
183183
---@return table<number, table>
184184
function tabline.get_buffer_tabs()
185185
local tabs = {}
186-
for _, buf in ipairs(tabline.get_buffers()) do
186+
for _, buf in ipairs(tabline.list()) do
187187
local tab = { buf_id = buf }
188188
tab["hl"] = tabline.get_tab_highlight(buf)
189189
tab["func"] = tabline.get_tab_func(buf)
@@ -213,7 +213,7 @@ end
213213

214214
--- Navigate to next buffer
215215
function tabline.next()
216-
local buffers = tabline.get_buffers()
216+
local buffers = tabline.list()
217217
if buffers == nil or #buffers < 2 then
218218
print "No more buffers"
219219
return
@@ -238,7 +238,7 @@ end
238238

239239
--- Navigate to previous buffer
240240
function tabline.prev()
241-
local buffers = tabline.get_buffers()
241+
local buffers = tabline.list()
242242
if buffers == nil or #buffers < 2 then
243243
print "No more buffers"
244244
return
Collapse file

‎lua/unclutter/telescope.lua‎

Copy file name to clipboardExpand all lines: lua/unclutter/telescope.lua
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ local function format(full_path, type)
3030
return formatted
3131
end
3232

33-
telescope.open_buffers = function(opts)
33+
telescope.open = function(opts)
3434
opts = opts or {}
3535
opts = {
3636
format = opts.format or "compact",
Collapse file

‎readme.md‎

Copy file name to clipboardExpand all lines: readme.md
+24-13Lines changed: 24 additions & 13 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Every other buffer will be closed at the time you leave it (`BufLeave`).
6868
If you use [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim), you can use it to list all your `unclutter.nvim` in a floating window:
6969

7070
```lua
71-
require('unclutter').telescope()
71+
require('unclutter.telescope').open()
7272
```
7373

7474
Of course, you can map it to whatever you want:
@@ -112,23 +112,26 @@ If you want to hack it or create your own mappings, you can use the following fu
112112

113113
```lua
114114
local unclutter = require("unclutter")
115+
local tabline = require("unclutter.tabline")
116+
local buffer = require("unclutter.buffer")
117+
local plugin = require("unclutter.plugin")
115118

116-
-- handle tabline buffers
117-
unclutter.keep(bufnr) -- Show buffer in tabline
118-
unclutter.remove(bufnr) -- Hide buffer from tabline
119-
unclutter.toggle(bufnr) -- Toggle buffer in tabline
120-
unclutter.keep_current() -- Show current buffer in tabline
121-
unclutter.hide_current() -- Hide current buffer from tabline
122-
unclutter.toggle_current() -- Toggle current buffer in tabline
123-
unclutter.list() -- List tabline buffers
119+
tabline.keep_buffer(bufnr) -- Show buffer in tabline
120+
tabline.remove_buffer(bufnr) -- Show buffer in tabline
121+
tabline.toggle_buffer(bufnr) -- Toggle buffer in tabline
122+
tabline.list() -- List tabline buffers
123+
124+
-- If you want to get the current buffer you can use:
125+
local bufnr = buffer.current()
126+
tabline.keep(bufnr)
124127

125128
-- navigate tabline buffers (like :bnext and :bprev)
126-
unclutter.next() -- Go to next buffer
127-
unclutter.prev() -- Go to previous buffer
129+
tabline.next() -- Go to next buffer
130+
tabline.prev() -- Go to previous buffer
128131

129132
-- handle plugin (on/off)
130-
unclutter.enable() -- Enable unclutter
131-
unclutter.disable() -- Disable unclutter
133+
plugin.enable() -- Enable unclutter
134+
plugin.disable() -- Disable unclutter
132135
```
133136

134137
Example mappings:
@@ -140,6 +143,14 @@ vim.keymap.set("n", "gp", unclutter.prev, { noremap = true })
140143

141144
I personally have a map to save a file to disk (`<c-s>` will `:w`) so the buffer will be kept in the tabline whenever I do `<c-s>`.
142145

146+
## Help
147+
148+
Of course:
149+
150+
```vim
151+
:help unclutter
152+
```
153+
143154

144155
## Inspiration
145156

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.