README.md

clangwarningparser.nvim

The goal of clangwarningparser.nvim is to make it easier to handle clang-tidy output files by parsing each arguments' contents and putting them in a list, also providing previews and jump-to-location.

Table of contents

1. Install
2. Requirements
3. Configuration
4. Usage

Install

Using packer:

use {'strptrk/clangwarningparser.nvim'}

Requirements

You have to enable termguicolors to have proper coloring.

Vim:

set termguicolors

Lua:

vim.o.termguicolors = true

Configuration

The setup function takes a configuration table as an argument, or optionally nothing.

require('clangwarningparser').setup()

Default settings:

require('clangwarningparser').setup({
  float_opts = {
    width_percentage = 75,
    height_percentage = 75,
    border = 'rounded'
  },
  relative = true,
  width = 20,
  open_on_load = true,
  center_on_select = false,
  strict_bufname = true,
  root = "",
  root_env = "",
  root_cd = false,
  map_defaults = true,
  keymaps = {
    preview = {'o', 'p'},
    select_entry = '<CR>',
    toggle_win = '<leader>w',
    open_win = '<leader>Wo',
    close_win = '<leader>Wc',
    quit_preview = 'q',
    toggle_done = {'d', '<tab>'}
  },
  colors = {
    done = "#05a623",
    preview_filepath = "#51D8FF",
    select_entry = "#93ccfa",
  },
})

Options:

• float_opts: options to control appearance of the preview window

  • width_percentage: width of the preview window relative to the editor size (1-100)
  • height_percentage: height of the preview window relative to the editor size (1-100)
  • border: border style of the preview window
    • possible values: 'none', 'single', 'double', 'rounded', 'solid', 'shadow'

• relative and width:

  • if relative is true, then the width value is a percentage, relative to the editor size,
  • if relative is false, then width represents the number of columns.

• open_on_load: open the sidebar when calling CWParse (true/false)

• center_on_select: center the source code window when selecting the entry in the sidebar (true/false) (executes norm zz)

• strict_bufname: only parse files ending with .log when calling CWParse buffers (true/false)

• root: the project root directory

• root_env: the environmental variable which stores the project root directory

• root_cd: :cd into the root or root_env directory when jumping to files (true/false)

  • note: root takes precedence over root_env, if neither is given, the root will be set to $PWD

• map_defaults: set default keymaps to functions you do not map (true/false)

• keymaps: each keymap is either a string or a table of strings

  • preview: opens the description of the error in a floating window
  • select_entry: jumps to the location of the warning in your original window
  • toggle_win: toggles the sidebar
  • open_win: opens the sidebar
  • close_win: closes the sidebar
  • quit_preview: quits the floating preview window
  • toggle_done: marks currently selected entry as done or undone (by setting the foreground color)

• colors: the colors used by the plugin

  • done: the foreground color used to mark entries done
  • preview_filepath: the path's color in the floating preview window
  • select_entry: the foreground color of the currently hovered entry in the sidebar (background is the CursorLine highlight)

Usage

Calling the setup function defines the command CWParse

• CWParse to parse the current buffer as a clang-tidy output file
• CWParse file1 file2 ... to parse the argument files as a clang-tidy output files
• CWParse buffers to parse the currently opened buffers as clang-tidy output files

The configured keymaps will only be set after calling CWParse.

Example:

require('clangwarningparser').setup({
  float_opts = {
    width_percentage = 90,
    height_percentage = 75,
    border = 'rounded'
  },
  open_on_load = true,
  center_on_select = true,
  root = '/home/user/my_project',
  map_defaults = false,
  keymaps = {
    preview = 'o',
    select_entry = '<CR>',
    toggle_win = '<leader>w',
    quit_preview = 'q',
    toggle_done = {'d', '<tab>'}
  },
})
vim.keymap.set('n', '<leader>w', '<cmd>CWParse buffers<cr>')