A Neovim plugin that prettifies TypeScript errors, adds inline ignore comments, and looks up rule documentation for over 50 linters and formatters.
nvim-rulebook is a Neovim plugin that serves as an all-in-one helper for managing diagnostics and errors. It prettifies TypeScript error messages, adds inline comments to ignore linter rules, suppresses formatters, and looks up rule documentation online. The plugin solves the problem of fragmented error handling by consolidating these tasks into a single, configurable tool.
Neovim users who work with TypeScript, linters like ESLint or Ruff, and formatters like Prettier or Biome, particularly those seeking to streamline their diagnostic workflow and reduce manual effort.
Developers choose nvim-rulebook for its extensive built-in support for over 50 tools, zero-configuration setup for most use cases, and its ability to automate tedious tasks like adding ignore comments or formatting error messages, saving time and improving code readability.
All-around helper for dealing with errors and diagnostics: Prettify typescript errors, add inline-comments to ignore rules, and lookup rule documentation online.
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Out-of-the-box integration with over 50 linters, formatters, and LSPs, as listed in the README, reducing initial configuration for common tools.
Offers a Lua API to add custom sources and override built-in behaviors, allowing adaptation to niche workflows and unsupported tools.
Prettifies TypeScript error messages by formatting code blocks with Prettier or Biome, making dense errors more readable, as shown in before/after examples.
Automates adding ignore comments for diagnostics with support for multiple placements (e.g., previous-line, same-line), saving manual effort for rules like ESLint or Ruff.
Error prettification only works for TypeScript LSP, as admitted in the README, leaving other languages without this feature unless custom prettifiers are added.
Setting up efm-langserver requires precise errorformat and lintSource configuration, which can be error-prone and doesn't support diagnostic codes with letters, as noted in the FAQ.
Relies on external tools like Prettier or Biome installed in PATH for error prettification, adding dependencies beyond Neovim's ecosystem.