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.

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

add folding based on fold expression #17

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,9 @@ Any options that are not specified when calling `setup` will take on their defau
-- Current options: "iron" for iron.nvim, "toggleterm" for toggleterm.nvim,
-- or "auto" which checks which of the above are installed
repl_provider = "auto",
-- If `true`, folding will be based on expression for buffers with a valid
-- cell marker and cells will be folded on entering the buffer
cell_folding = true
}
```

Expand Down
5 changes: 4 additions & 1 deletion doc/NotebookNavigator.txt
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,9 @@ Default values:
-- Current options: "iron" for iron.nvim, "toggleterm" for toggleterm.nvim,
-- or "auto" which checks which of the above are installed
repl_provider = "auto",
-- If `true`, folding will be based on expression for buffers with a valid
-- cell marker and cells will be folded on entering the buffer
cell_folding = true
}
<

Expand All @@ -138,4 +141,4 @@ Usage~
any config parameter which you not pass will take on its default value.


vim:tw=78:ts=8:noet:ft=help:norl:
vim:tw=78:ts=8:noet:ft=help:norl:
30 changes: 30 additions & 0 deletions lua/notebook-navigator/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,9 @@ M.config = {
-- Current options: "iron" for iron.nvim, "toggleterm" for toggleterm.nvim,
-- or "auto" which checks which of the above are installed
repl_provider = "auto",
-- If `true`, folding will be based on expression for buffers with a valid
-- cell marker and cells will be folded on entering the buffer
cell_folding = true
}
--minidoc_afterlines_end

Expand Down Expand Up @@ -258,6 +261,33 @@ M.setup = function(config)
if (M.config.activate_hydra_keys ~= nil) and got_hydra then
activate_hydra(M.config)
end

local cell_group = vim.api.nvim_create_augroup("Cells", {clear=true})
if M.config.cell_folding then
local foldm = vim.o.foldmethod
vim.cmd[[set nofoldenable]]
vim.api.nvim_create_autocmd("BufEnter", {
pattern = {"*"},
group = cell_group,
callback = function(ev)
local ft = vim.api.nvim_get_option_value("filetype", {buf = ev.buf})
if M.config.cell_markers[ft] then
local marker = M.config.cell_markers[ft]
local vim_marker = string.gsub(marker, " ", "\\ ")
local expr = "set foldexpr=(getline(v:lnum)=~'^"..vim_marker.."')==0"
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is going to overwrite whatever code folding a user has set. If you are only on folding cells that is fine but for example one thing that I do quite often after opening a file is zC to close all the folds to get a higher level view.

I would imagine that one approach to fix solve this is to wrap around the folding method currently in use so that it returns the fold level on top of the one that was set before.

Another issue is that this will changed the global fold method. Ideally one would rather use setlocal to only change it on the window displaying the buffer of interest.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really good point about setlocal. I've implemented that change.

On wrapping the current folding method. I think it could be done if the folding was set to fold-indent, fold-expr, or fold-marker but I'm not sure how to get an expr wrapping fold-syntax or fold-diff. Any ideas?

In any case, I've also added a warning for the time being that the code folding will replace previously defined foldmethods on buffers with valid cell markers.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would be happy with just having the cell folding working for a limited number of user set folding methods. Indent, expr and marker would be enough as they cover most of the situations.

Currently I'm wokring on wrapping around the output of the current foldexpr such that it produces the correct folding when cells are considered too. I will upload a branch later today or tomorrow morning sketching the idea.

vim.cmd[[set foldmethod=expr]]
vim.cmd(expr)
end
end
})
vim.api.nvim_create_autocmd("BufLeave", {
pattern = {"*"},
group = cell_group,
callback = function()
vim.cmd("set foldmethod="..foldm)
end
})
end
end

return M