Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add option for only showing biscuits on the current cursor line #19

Merged
merged 4 commits into from
Jul 19, 2021
Merged

feat: add option for only showing biscuits on the current cursor line #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4c0a110
feat: add option for only showing biscuits on the current cursor line
cmgriffing Jul 14, 2021
13d1ca2
fix: handle clearing better to no remove wrong biscuits
cmgriffing Jul 14, 2021
1a38982
fix: change how we determine if something should be cleared
cmgriffing Jul 14, 2021
c30a3cb
fix: use correct namespace when clearing
cmgriffing Jul 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,18 @@ require('nvim-biscuits').setup({
EOF
```

## Configuration (Cursor Line Only)

You can configure the biscuits to only show on the line that has your cursor. This can be useful if you find that default config makes the text too cluttered.

```lua
lua <<EOF
require('nvim-biscuits').setup({
cursor_line_only = true
})
EOF
```

## Supported Languages

We currently support all the languages supported in tree-sitter. Not all languages have specialized support, though most will probably need some.
Expand Down
42 changes: 32 additions & 10 deletions lua/nvim-biscuits/init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ local ts_parsers = require('nvim-treesitter.parsers')
local ts_utils = require('nvim-treesitter.ts_utils')
local nvim_biscuits = {}

local make_biscuit_hl_group = function(lang) return 'BiscuitColor' .. lang end
local make_biscuit_hl_group_name =
function(lang) return 'BiscuitColor' .. lang end

nvim_biscuits.decorate_nodes = function(bufnr, lang)
if config.get_language_config(final_config, lang, "disabled") then return end
Expand All @@ -26,7 +27,9 @@ nvim_biscuits.decorate_nodes = function(bufnr, lang)
return
end

local biscuit_highlight_group = make_biscuit_hl_group(lang)
local biscuit_highlight_group_name = make_biscuit_hl_group_name(lang)
local biscuit_highlight_group = vim.api.nvim_create_namespace(
biscuit_highlight_group_name)
local root = parser:parse()[1]:root()

local nodes = ts_utils.get_named_children(root)
Expand Down Expand Up @@ -65,8 +68,14 @@ nvim_biscuits.decorate_nodes = function(bufnr, lang)
should_decorate = false
end

if should_decorate then
local cursor = vim.api.nvim_win_get_cursor(0)
local should_clear = false
if final_config.cursor_line_only and end_line + 1 ~= cursor[1] then
should_decorate = false
should_clear = true
end

if should_decorate == true then
local trim_by_words = config.get_language_config(final_config,
lang,
"trim_by_words")
Expand Down Expand Up @@ -101,14 +110,20 @@ nvim_biscuits.decorate_nodes = function(bufnr, lang)
if utils.trim(text) ~= '' then
text = prefix_string .. text

vim.api.nvim_buf_clear_namespace(bufnr, 0, end_line,
end_line + 1)
vim.api.nvim_buf_set_virtual_text(bufnr, 0, end_line, {
{text, biscuit_highlight_group}
vim.api.nvim_buf_clear_namespace(bufnr,
biscuit_highlight_group,
end_line, end_line + 1)
vim.api.nvim_buf_set_virtual_text(bufnr,
biscuit_highlight_group,
end_line, {
{text, biscuit_highlight_group_name}
}, {})
end
else
-- utils.console_log('empty')
end

if should_decorate == false and should_clear == true then
vim.api.nvim_buf_clear_namespace(bufnr, biscuit_highlight_group,
end_line, end_line + 1)
end
end

Expand Down Expand Up @@ -140,7 +155,7 @@ nvim_biscuits.BufferAttach = function(bufnr)
local lang = ts_parsers.get_buf_lang(bufnr)
local on_lines = function() nvim_biscuits.decorate_nodes(bufnr, lang) end

vim.cmd("highlight default link " .. make_biscuit_hl_group(lang) ..
vim.cmd("highlight default link " .. make_biscuit_hl_group_name(lang) ..
" BiscuitColor")

-- we need to fire once at the very start
Expand All @@ -154,6 +169,13 @@ nvim_biscuits.BufferAttach = function(bufnr)
au %s <buffer=%s> :lua require("nvim-biscuits").decorate_nodes(%s, "%s")
augroup END
]], on_events, bufnr, bufnr, lang), false)
elseif final_config.cursor_line_only == true then
vim.api.nvim_exec(string.format([[
augroup Biscuits
au!
au %s <buffer=%s> :lua require("nvim-biscuits").decorate_nodes(%s, "%s")
augroup END
]], "CursorMoved,CursorMovedI", bufnr, bufnr, lang), false)
else
vim.api.nvim_buf_attach(bufnr, false,
{
Expand Down