A collection of Quality-of-life features related to folding.
h
and l
as fold keymaps: Overloads the h
key which will
fold a line when used on the first non-blank character of (or before). And
overloads the l
key, which will unfold a line when used on a folded line. This
allows you to ditch zc
, zo
, and za
; h
and l
are all you need.Every feature is independent, so you can choose to only enabled some of them.
nvim-origami
replaces most features of nvim-ufo
in a much more lightweight
manner and adds some features that nvim-ufo
does not possess.
nvim-ufo
is no longer compatible with this plugin (most of its
features are now offered by nvim-origami
in a more lightweight way).nvim-origami
to the tag v1.9
.Requirements
nvim-ufo
, since nvim-origami
is incompatible with it-- lazy.nvim
{
"chrisgrieser/nvim-origami",
event = "VeryLazy",
opts = {}, -- needed even when using default config
-- recommended: disable vim's auto-folding
init = function()
vim.opt.foldlevel = 99
vim.opt.foldlevelstart = 99
end,
},
-- default settings
require("origami").setup {
useLspFoldsWithTreesitterFallback = true, -- required for `autoFold`
pauseFoldsOnSearch = true,
foldtext = {
enabled = true,
padding = 3,
lineCount = {
template = "%d lines", -- `%d` is replaced with the number of folded lines
hlgroup = "Comment",
},
diagnosticsCount = true, -- uses hlgroups and icons from `vim.diagnostic.config().signs`
gitsignsCount = true, -- requires `gitsigns.nvim`
},
autoFold = {
enabled = true,
kinds = { "comment", "imports" }, ---@type lsp.FoldingRangeKind[]
},
foldKeymaps = {
setup = true, -- modifies `h` and `l`
hOnlyOpensOnFirstColumn = false,
},
}
If you use other keys than h
and l
for vertical movement, set
opts.foldKeymaps.setup = false
and map the keys yourself:
vim.keymap.set("n", "<Left>", function() require("origami").h() end)
vim.keymap.set("n", "<Right>", function() require("origami").l() end)
This is a known issue of many formatting
plugins
and actually not related to nvim-origami
.
The only two tools I am aware of that are able to preserve folds are the efm-language-server and conform.nvim.
-- Folds provided by the LSP
require("origami").inspectLspFolds("special") -- comment & import only
require("origami").inspectLspFolds("all")
In my day job, I am a sociologist studying the social mechanisms underlying the digital economy. For my PhD project, I investigate the governance of the app economy and how software ecosystems manage the tension between innovation and compatibility. If you are interested in this subject, feel free to get in touch.