How do I set up actions-preview.nvim with Telescope in Neovim?

Install both plugins, then in your config, use the setup function to specify Telescope as the backend and customize options like layout and theme. The README provides examples, such as using get_dropdown for a themed interface.

Why does actions-preview.nvim say 'Preview is not available for this action'?

This occurs when the language server implements code actions using Commands instead of TextEdits. Since Commands can perform arbitrary operations, the plugin cannot compute a diff preview, as explained in the FAQ.

Can I use actions-preview.nvim without installing Telescope or other pickers?

No, the plugin requires at least one supported backend like Telescope, mini.pick, nui.nvim, or snacks.nvim. You must have one installed and configured for it to function.

How does actions-preview.nvim compare to nvim-code-action-menu?

actions-preview.nvim focuses on diff previews before applying actions, while nvim-code-action-menu offers a menu interface without diff. Both enhance LSP UI, but actions-preview is better for visual verification, as noted in acknowledgements.

What external diff tools can I use with actions-preview.nvim?

It supports delta, diff-so-fancy, and diff-highlight via the highlight_command configuration. You can prioritize these or use custom commands, but note that on Windows, PowerShell is required for this feature.

Is actions-preview.nvim compatible with all language servers?

No, compatibility depends on whether the language server uses TextEdit for code actions. Servers with Command-based actions won't show previews, limiting its effectiveness with certain tools.

Open-Awesome

actions-preview.nvim

GPL-3.0Lua

A Neovim plugin that previews code changes from LSP code actions before applying them.

GitHub

514 stars20 forks0 contributors

What is actions-preview.nvim?

actions-preview.nvim is a Neovim plugin that provides a preview interface for Language Server Protocol (LSP) code actions. It shows a diff of the proposed changes before they are applied, helping developers avoid mistakes during refactoring or code fixes. The plugin integrates with various Neovim picker backends for a seamless user experience.

Target Audience

Neovim users who work with LSP-enabled languages and frequently use code actions for refactoring, quick fixes, or code improvements. It's particularly useful for developers who want visual confirmation before applying automated changes.

Value Proposition

It offers a unique visual diff preview for LSP code actions, which is not natively available in most LSP clients. The plugin supports multiple UI backends and is highly customizable, allowing users to tailor the preview experience to their workflow.

Overview

Fully customizable previewer for LSP code actions.

Use Cases

Best For

Previewing refactoring changes like renaming symbols across a codebase
Inspecting quick fixes suggested by language servers before applying them
Comparing different code action options visually to choose the best one
Avoiding unintended modifications when using automated code actions
Enhancing LSP workflows in Neovim with interactive diff previews
Customizing the code action UI with preferred pickers and diff tools

Not Ideal For

Teams relying on language servers that implement code actions via Command instead of TextEdit, as previews are unavailable.
Users who prefer a minimal Neovim setup without additional picker plugins like Telescope or nui.nvim.
Windows developers not using PowerShell, since external diff highlighting is unsupported with cmd.exe.
Workflows where immediate application of code actions is prioritized over previewing changes.

Pros & Cons

Pros

Live Diff Previews

Displays side-by-side diffs for LSP code actions, allowing precise inspection of changes before application, which helps prevent errors during refactoring or fixes.

Flexible UI Integration

Supports multiple backends like Telescope and mini.pick, enabling seamless integration with existing Neovim picker setups for a customized workflow.

Enhanced Diff Highlighting

Configurable to use external tools like delta and diff-so-fancy for superior visual clarity, going beyond Neovim's built-in diff capabilities.

High Customizability

Offers extensive options for layouts, diff algorithms, and picker themes, allowing users to tailor the preview experience to their preferences, as shown in the setup examples.

Cons

Language Server Limitations

Some language servers use Command-based code actions which cannot be previewed, making the plugin ineffective for those cases, as admitted in the FAQ.

Setup Complexity

Requires configuration with external pickers and optional diff tools, which can be complex for users not already familiar with these dependencies or seeking a plug-and-play solution.

External Tool Dependency

For advanced diff highlighting, users must install and manage external commands like delta, adding extra setup overhead and potential compatibility issues.

Frequently Asked Questions

Related Projects

nvim-lspconfig

Quickstart configs for Nvim LSP

improve neovim lsp experience

Stars3,788

Forks302

Last commit3 days ago

none-ls.nvim

null-ls.nvim reloaded / Use Neovim as a language server to inject LSP diagnostics, code actions, and more via Lua.

Stars3,240

Forks119

Last commit5 days ago

rustaceanvim

🦀 Supercharge your Rust experience in Neovim! A heavily modified fork of rust-tools.nvim

Stars2,974

Forks134

Last commit19 hours ago

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