0x00dec0de / vim-todo-highlight

a Vim/Neovim plugin to highlight todos and fixmes

vim-todo-highlight

a vim plugin to highlight todos and fixmes

Installation

vim-plug

1. Add the following configuration to your .vimrc.

    Plug 'sakshamgupta05/vim-todo-highlight'
   

2. Install with :PlugInstall.

Pathogen

1. Install with the following command.

    git clone https://github.com/sakshamgupta05/vim-todo-highlight ~/.vim/bundle/vim-todo-highlight
   

Vundle

1. Add the following configuration to your .vimrc.

    Plugin 'sakshamgupta05/vim-todo-highlight'
   

2. Install with :PluginInstall.

NeoBundle

1. Add the following configuration to your .vimrc.

    NeoBundle 'sakshamgupta05/vim-todo-highlight'
   

2. Install with :NeoBundleInstall.

Introduction

This plugin helps you to remember the TODO: and FIXME: you have written in your code by highlighting them inside vim.

Usage

Just type TODO: or FIXME: inside a comment and this plugin will highlight it for you.

Configuration

Default configuration

gui           : HEX colors for terminals that support 24bit true colour
cterm       : 256 colors for terminals that support only 256 colour palette
fg_color : text color
bg_color : background color

{
  'TODO': {
    'gui_fg_color': '#ffffff',
    'gui_bg_color': '#ffbd2a',
    'cterm_fg_color': 'white',
    'cterm_bg_color': '214'
  },
  'FIXME': {
    'gui_fg_color': '#ffffff',
    'gui_bg_color': '#f06292',
    'cterm_fg_color': 'white',
    'cterm_bg_color': '204'
  }
}

Disable default annotations

If you want to disable highlighting for the default annotations, configure as

let g:todo_highlight_disable_default = ['TODO', 'FIXME']

Add custom annotations

To add your own custom annotations and/or customize colors for existing annotations, configure as (if you leave any attribute as blank, the default(TODO) configurations will be used)

let g:todo_highlight_config = {
      \   'REVIEW': {},
      \   'NOTE': {
      \     'gui_fg_color': '#ffffff',
      \     'gui_bg_color': '#ffbd2a',
      \     'cterm_fg_color': 'white',
      \     'cterm_bg_color': '214'
      \   }
      \ }