How to install nvim-surround with lazy.nvim?

Add the plugin to your lazy.nvim config with version pinning for stability, as shown in the README. Optionally, configure it in the config function using the setup method for custom options.

nvim-surround vs vim-surround: which should I use?

nvim-surround is a Lua-based rewrite for Neovim with modern features like Tree-sitter integration and buffer-local configs, while vim-surround is the original Vimscript plugin with broader Vim compatibility but fewer advanced customizations.

How to change quotes with nvim-surround?

Use the cs command followed by the target and replacement chars, e.g., cs'" changes single quotes to double quotes, as demonstrated in the usage examples in the README with visual feedback.

Does nvim-surround work with HTML tags?

Yes, it handles HTML tags out-of-the-box, allowing operations like dst to delete surrounding tags or csth1 to change tags, as mentioned in the features and usage sections.

How to configure custom surrounds in nvim-surround?

Call the setup function with Lua patterns or Tree-sitter nodes, as detailed in the configuration documentation (:h nvim-surround.configuration), which requires some Lua scripting knowledge.

Can nvim-surround repeat actions?

Yes, it supports dot-repeat actions using Neovim's dot operator, so you can repeat previous add, delete, or change operations easily, enhancing workflow efficiency.

nvim-surround

MITLuav4.0.5

A Neovim plugin for adding, changing, and deleting surrounding delimiter pairs like parentheses, quotes, and HTML tags.

GitHub

What is nvim-surround?

nvim-surround is a Neovim plugin written in Lua that enables users to easily add, change, or delete surrounding delimiter pairs such as parentheses, quotes, and HTML tags. It solves the problem of tedious manual editing when working with nested or paired delimiters in code and text. The plugin provides intuitive keybindings and supports advanced features like dot-repeat actions and Tree-sitter integration.

Target Audience

Neovim users, particularly developers and writers who frequently edit structured text or code and want to improve their editing efficiency. It's especially useful for those familiar with Vim's modal editing and seeking enhanced surround manipulation capabilities.

Value Proposition

Developers choose nvim-surround for its modern Lua implementation, seamless integration with Neovim's latest features, and extensive customization options. Its unique selling point includes first-class support for Tree-sitter nodes, buffer-local configurations, and the ability to define powerful custom surrounds using Lua patterns.

Overview

Add/change/delete surrounding delimiter pairs with ease. Written with :heart: in Lua.

Use Cases

Best For

Quickly wrapping code snippets with parentheses or quotes

Related Projects

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub

4.2k stars79 forks0 contributors

Refactoring HTML/XML tags in markup files

Changing delimiter types in function calls or arguments

Manipulating nested structures in configuration files

Enhancing text editing workflows in Neovim with repeatable actions

Creating custom surround behaviors for specific file types

Not Ideal For

Vim users who haven't upgraded to Neovim 0.8 or later
Editors preferring mouse-based or graphical text manipulation without modal keybindings
Projects requiring a surround plugin with extensive pre-built surrounds for niche file types without any Lua configuration
Minimalists seeking ultra-lightweight alternatives like mini.surround over feature-rich plugins

Pros & Cons

Pros

Modern Lua Implementation

Written in Lua, it integrates seamlessly with Neovim's latest APIs, offering better performance and native support, as indicated by the requirement for Neovim 0.8+.

Advanced Customization Options

Supports defining surrounds using Vim motions, Lua patterns, and Tree-sitter nodes, providing flexibility for complex text manipulations, as highlighted in the features list.

Dot-Repeat Integration

Actions can be repeated with Neovim's dot operator, enhancing editing efficiency for repetitive surround tasks, mentioned in the core features.

Buffer-Local Configuration

Allows setting custom mappings and surrounds per buffer, enabling tailored workflows for different file types, as noted in the buffer-local configuration feature.

Cons

Neovim Exclusive Limitation

Only compatible with Neovim 0.8+, excluding users of traditional Vim or older Neovim versions, which limits its adoption in mixed editor environments.

Lua Configuration Overhead

Customization requires writing Lua code, which can be a barrier for those unfamiliar with Lua or Neovim's Lua API, despite the detailed documentation.

Tree-sitter Dependency for Optimal Use

Full features like Tree-sitter node support require installing nvim-treesitter-textobjects, adding setup complexity and potential performance overhead.

Frequently Asked Questions

Home

Neovim

nvim-treesitter

Nvim Treesitter configurations and abstraction layer

Stars13,946

Forks1,419

Last commit2 months ago

nvim-treesitter-textobjects

nvim-treesitter-textobjects is a Neovim plugin that leverages Tree-sitter's parsing capabilities to define and manipulate text objects based on the abstract syntax tree (AST) of your code. It enables precise, language-aware editing operations, moving beyond simple regex-based text objects to understand the actual structure of programming languages. ## Key Features - **Syntax-Aware Selection** — Define custom text objects (like `@function.inner` or `@class.outer`) for precise selection within syntactic structures. - **Intelligent Movement** — Jump between text objects (e.g., functions, classes, loops) with mappings that understand code hierarchy. - **Node Swapping** — Swap adjacent syntactic nodes (like parameters or arguments) with simple commands. - **Repeatable Actions** — Make movements repeatable with `;` and `,` for efficient navigation. - **Extensible Queries** — Override or extend built-in textobjects by adding custom Tree-sitter query files. - **Multiple Modes** — Support for charwise, linewise, and blockwise selection modes per text object. ## Philosophy The plugin embraces Tree-sitter's accuracy to provide text objects that are deeply integrated with the language's syntax, offering a more reliable and intuitive editing experience compared to traditional pattern-based approaches.

Stars2,780

Forks266

Last commit2 months ago

nvim-treesitter-textsubjects

Location and syntax aware text objects which *do what you mean*

Stars567

Forks25

Last commit9 months ago

hlargs.nvim

Highlight arguments' definitions and usages, using Treesitter

Stars563

Forks15

Last commit3 days ago