How to install debugprint.nvim in NeoVim?

Install via lazy.nvim by adding it to your configuration with dependencies like mini.nvim for highlighting, and ensure NeoVim 0.11+ is used. The README provides detailed examples for various package managers.

debugprint.nvim vs nvim-dap: which is better for debugging?

debugprint.nvim is ideal for printf-style debugging with quick trace insertion across languages, while nvim-dap offers advanced features like breakpoints and step-through debugging. Choose debugprint for simplicity and nvim-dap for comprehensive debugging.

How to delete all debug lines added by debugprint.nvim?

Use the :Debugprint delete command to remove all debug statements in the current buffer. Note that this may fail if lines have been reformatted, as mentioned in the Known Limitations.

Does debugprint.nvim work with TypeScript?

Yes, debugprint.nvim supports TypeScript out-of-the-box as part of the JavaScript/TypeScript filetype, inserting console.log statements with contextual information like file names and line numbers.

How to customize debug print statements in debugprint.nvim?

Customize via the opts object, such as setting print_tag or disabling display_location, but note that full template customization is limited compared to some alternatives like timber.nvim.

Can I use debugprint.nvim with telescope.nvim for searching debug lines?

Yes, debugprint.nvim integrates with telescope.nvim for the :Debugprint search command, automatically detecting it if installed, or you can specify the picker in the options.

debugprint.nvim

MITLuav7.1.1

A NeoVim plugin for printf-style debugging that inserts debug statements with file, line, and variable info across 40+ languages.

GitHub

What is debugprint.nvim?

debugprint.nvim is a NeoVim plugin that simplifies printf-style debugging by inserting contextual trace statements directly into code. It supports over 40 programming languages and provides features like variable inspection, line highlighting, and batch operations to streamline the debugging workflow.

Target Audience

NeoVim users who prefer a low-tech, print-based debugging approach over complex debuggers like nvim-dap, particularly developers working in multiple languages who need quick, contextual trace statements.

Value Proposition

Developers choose debugprint.nvim for its extensive language support, persistent contextual information (like file names and counters), and practical features like batch insertion and line management, offering a focused alternative to heavier debugging tools.

Overview

Debugging in NeoVim the print() way!

Use Cases

Best For

Adding printf-style debug statements with file names and line numbers in NeoVim
Debugging across multiple programming languages (e.g., Python, JavaScript, C++) in a single editor

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

521 stars27 forks0 contributors

Inserting trace statements that include variable values detected via Treesitter

Managing debug lines with batch operations using NeoVim registers

Quickly searching for or deleting all debug statements in a project

Highlighting debug lines in code for easy visibility during debugging sessions

Not Ideal For

Projects that heavily rely on automated code formatters, as reformatting can break debug line deletion functionality.
Developers needing advanced debugging features like breakpoints, assertions, or stack traces.
Teams using IDEs with integrated debuggers, since this is a NeoVim-specific plugin.
Environments where minimal code changes are preferred, as debugprint inserts statements directly into source files.

Pros & Cons

Pros

Extensive Language Support

Supports over 40 filetypes including Python, JavaScript, and more out-of-the-box, with extensible templates as detailed in the feature comparison table.

Rich Contextual Information

Inserts debug lines with file names, line numbers, persistent counters, and code snippets for easy cross-referencing, customizable per filetype as shown in the README.

Intelligent Variable Detection

Uses Treesitter to detect variables under the cursor or prompts for expressions, even supporting embedded languages like JavaScript-in-HTML.

Flexible Keymaps and Modes

Provides keymaps for normal, insert, visual, and operator-pending modes with dot-repeat and surround insertion, as outlined in the keymappings table.

Debug Management Commands

Includes commands to delete, comment, search, and add debug lines to the quickfix list, enhancing workflow with tools like fzf-lua or telescope.nvim integration.

Cons

Formatting Incompatibility

Cannot handle debug lines that have been split by code formatters, making deletion commands unreliable after formatting, as admitted in the Known Limitations section.

External Dependencies

Requires mini.nvim or mini.hipatterns for line highlighting, adding setup complexity and potential plugin conflicts beyond the core functionality.

Breaking Changes

Has experienced breaking changes like version 2.0.0 deprecating old mapping methods, requiring migration efforts and monitoring of GitHub issues for updates.

Limited Template Customization

Lacks completely customizable log templates compared to alternatives like timber.nvim, as noted in the feature comparison where it scores :x: for that feature.

Frequently Asked Questions

Home

Neovim

nvim-dap

Debug Adapter Protocol client implementation for Neovim

Stars7,133

Forks263

Last commit8 days ago

nvim-dap-ui

A UI for nvim-dap

Stars3,337

Forks126

Last commit1 month ago

nvim-dap-virtual-text

nvim-dap-virtual-text enhances the debugging experience in Neovim by showing variable values inline as virtual text while using nvim-dap. It integrates with nvim-treesitter to intelligently locate variable definitions and references, making debugging more visual and efficient. ## Key Features - **Inline Variable Display** — Shows variable values directly in the code as virtual text during debugging. - **Changed Value Highlighting** — Highlights variables that have changed since the last step with customizable colors. - **Exception Stop Reasons** — Displays the reason for debugger stops due to exceptions. - **Multi-language Support** — Works with any language supported by nvim-treesitter's locals.scm queries (C/C++, Python, Rust, Go, Java, etc.). - **Customizable Display** — Offers extensive configuration options for virtual text position, formatting, and behavior. - **Frame-aware Display** — Can show variable values from all stack frames, not just the current one. ## Philosophy The plugin follows a minimalistic approach, enhancing the debugging workflow without cluttering the interface, and leverages existing Neovim ecosystems like nvim-treesitter for intelligent parsing.

Stars1,073

Forks36

Last commit1 year ago