How do I disable the default keymaps in nvim-origami?

Set opts.foldKeymaps.setup = false in the configuration, then manually map keys using functions like require("origami").h() for custom bindings, as shown in the README.

Why does nvim-origami give an error when opening files with auto-fold?

This is due to a bug in nvim core with vim.lsp.foldclose(), not nvim-origami itself. The error occurs occasionally and is expected to be fixed in future Neovim versions.

nvim-origami vs nvim-ufo: which should I use?

nvim-origami is lighter and focuses on LSP integration and intuitive keymaps, while nvim-ufo offers more extensive folding features. Choose origami for simplicity and modern tooling, but note they are incompatible.

How can I preserve folds when formatting code in Neovim?

Only efm-language-server and conform.nvim reliably preserve folds; most other formatting plugins will open folds. This is a known limitation addressed in the FAQ.

Does nvim-origami work without an LSP server?

Yes, it falls back to Treesitter or indent-based folding if LSP is unavailable, but features like auto-fold for comments/imports require LSP support to function fully.

What are the setup requirements for nvim-origami?

Requires Neovim 0.11+, disabling nvim-ufo, and optional dependencies like gitsigns.nvim for git change decorations. The .setup call is mandatory even with default config.

Open-Awesome

nvim-origami

MITLua

A Neovim plugin providing elegant folding features with LSP/Treesitter integration, fold decorations, and intuitive keymaps.

GitHub

521 stars17 forks0 contributors

What is nvim-origami?

nvim-origami is a Neovim plugin that enhances code folding with intelligent features like LSP/Treesitter integration, visual fold decorations, and intuitive keymap overrides. It solves the problem of clunky folding workflows by providing a more elegant and efficient way to navigate folded code sections.

Target Audience

Neovim users who work with large codebases and want improved folding functionality, particularly developers using LSP and Treesitter for code analysis.

Value Proposition

Developers choose nvim-origami because it replaces heavier alternatives like nvim-ufo with a more lightweight solution while adding unique features like search-aware folding and decorative fold text with diagnostics and git integration.

Overview

Fold with relentless elegance. A collection of quality-of-life features related to folding.

Use Cases

Best For

Improving code navigation in large Neovim projects
Adding visual fold decorations with line counts and diagnostics
Replacing traditional fold commands with intuitive movement keymaps
Automatically folding comments and imports on file open
Maintaining fold state during search operations
Integrating LSP and Treesitter for smarter folding ranges

Not Ideal For

Users heavily invested in nvim-ufo or other comprehensive folding plugins seeking a drop-in replacement
Projects without LSP setup where advanced folding like auto-fold for comments/imports is desired
Developers who prefer not to override default movement keys like h and l for folding operations
Teams relying on formatting tools that don't preserve folds, as most plugins disrupt fold state

Pros & Cons

Pros

Smart Folding Integration

Prioritizes LSP for folding data with Treesitter fallback, ensuring accurate fold ranges based on code structure rather than just indentation.

Informative Fold Decorations

Enhances folds with line counts, diagnostics, and git changes via gitsigns.nvim, providing visual context without breaking syntax highlighting.

Intuitive Keymap Overrides

Overloads h, l, ^, and $ to fold/unfold recursively, replacing clunky z-commands with natural movements for faster navigation.

Search-Aware Fold Management

Pauses folds during search operations and restores them afterward, preventing folds from staying open unintentionally.

Cons

Plugin Incompatibility

Explicitly incompatible with nvim-ufo, forcing users to choose between folding solutions and potentially migrate existing setups.

LSP Dependency for Key Features

Auto-fold for comments and imports only works with LSP support, limiting functionality in environments without language servers.

Formatting Disruption

Folds are often opened after running most formatters, a known issue that requires specific tools like efm-language-server or conform.nvim to mitigate.

Frequently Asked Questions

Related Projects

nvim-ufo

Not UFO in the sky, but an ultra fold in Neovim.

Stars2,939

Forks69

Last commit6 months ago

fold-cycle.nvim

This neovim plugin allows you to cycle folds open or closed

Stars92

Forks3

Last commit10 months ago

inline-fold.nvim

A neovim version of the inline fold plugin

Stars89

Forks2

Last commit2 years ago

commentless.nvim

Hide comments, focus on the code flow, and reveal them if needed 🧘

Stars43