sponsor Vim development Vim logo Vim Book Ad

hi : Text highlight and filter tool, enhanced log analyzer.

 script karma  Rating 0/0, Downloaded by 247  Comments, bugs, improvements  Vim wiki

created by
Javier Puigdevall
 
script type
utility
 
description
This is a complex tool for log analysis. Take into account this is a work in progress project.

This script allows you to highlight the words, sentences or regular expressions you need, on up to 82 colors, and 410 color configurations, when including foreground colors, background colors, bold and underline configurations.

If you LIKED THE PLUGIN, or you have some improvements, or you dislike it and found it complicated, no matter what, please drop a few lines to my e-mail and TELL ME! (javierpuigdevall@gmail.com)


----------------------------------------------------------------------------------------------------------------------------------
USAGE:
----------------------------------------------------------------------------------------------------------------------------------

1) HIGHLIGHT COLORS:

Commands Hicol (highlight colors) and Hiid (highlight IDs) display the available colors.
Examples:
- Show basic color IDs: :Hiid
- Show all color IDs: :Hiid all
- Show red color IDs: :Hicol r
- Show red color IDs including bold, underline and background colors: :Hicol r all
- Show red and orange color IDs: :Hiid r o
- Show red and orange color IDs including bold, underline and background colors: :Hicol r o all

The N color ID is a special ID with no color highlight, its use is to mark patterns to be included later on the filter window without highlighting them.


2) TEXT EXAMPLE:

This is a little complex to explain so, let's write a text example to try the commands.
Write the following lines to a new buffer:

Example pattern1
Some more text with no highlights
Example pattern2
EXAMPLE PATTERN3
Example pattern4
Some more text with no highlights
Example pattern5
Example pattern6
Some more text with no highlights
Example pattern7
Example pattern8
Some more text with no highlights
Some more text with no highlights
Example pattern9
This is my pattern_10 example number 10
Example pattern_11 add to filter without highlighting
Some more text with no highlights
Some more text with no highlights
Example pattern_12
Example pattern_13
Example pattern_14


3) HIGHLIGHT COMMANDS:

To perform a color highlight, use command :Hic pattern colorID.

Threre are some modifiers that can be appended to color ID in order to obtain a different color result:
- Append * to to color ID to highlight all line.
- Append @ to to color ID to highlight the background instead of foreground (default).
- Append ! to to color ID to highlight in bold characters.
- Append _ to to color ID to highlight underlined.
- Append 0 to to color ID to highlight on top of a previous highlight.

Examples:
Examples:
- Highlight word pattern1 in red color :Hic pattern1 r
- Highlight word pattern2 in green color :Hic pattern2 g
- Highlight word pattern3, case sensitive, in green2 color :Hic \CPattern3 g2
- Highlight word pattern4, no case sensitive, in green5 color :Hic \cpattern4 g5
- Highlight word pattern5 in yellow and bold :Hic pattern5 y!
- Highlight word pattern6 in magenta underlined :Hic pattern6 m_
- Highlight word pattern7 in violet background :Hic pattern7 v@
- Highlight word pattern8 in violet background and bold text :Hic pattern8 v@!
- Highlight the whole line containing word pattern9 background in red color :Hic pattern9 r@*
- Highlight the regular expression my.*pattern_10 in green4 color :Hic my.*pattern_10 g4
- Highlight in 'none' color :Hic pattern_11 n
- Highlight word pattern_12 in blue3 and bold text :Hic pattern_12 b3!
- Highlight word pattern_13 in cyan and underline text :Hic pattern_13 c_
- Highlight the whole line containing pattern_14 in cyan and underline text :Hic pattern_14 c_*
- Highlight the character 8 on top of the already highlighted pattern6 in cyan background :Hic 6 c0
- Highlight the character 8 on top of the already highlighted pattern8 in cyan background :Hic 8 c@0

Omit the color ID to choose the color from a menu showing the basic colors :Hic patternX

Use ':Hish' to display the current color highlighting configuration.

Use <leader>hw to highlight a word.
Use <leader>hW to highlight the whole word.


4) SEARCH COMMAND:

Use command :Hics colorId, to search all patterns highlighted with the selected color IDs.
Examples:
- Search all red highlighted patterns :Hics r
- Search all red and yellow highlighted patterns :Hics r y
- Search all red foreground and red background highlighted patterns :Hics r@ r


5) CONFIGURATION SAVE COMMANDS:

Configurations can be saved on file to use them later again.
There are three basic configuration files:
currenFile_vim_hi.cfg:  configurations only visible when vim is editing this file (currentFile).
currenDir/.vim_hi.cfg: configurations only visible when vim is open on this directory.
~/.vim_hi.cfg:  general configurations, always available.
Examples:
- Save current highlight configuration with name :Hisv MyConfig (You will be asked the file where the configuration will be saved)
- Add a new configuration file :Hil MyConfigFile
- Edit all configuration files availble :Hicfg


6) CONFIGURATION FORMAT:

The configuration file is saved with ini file format.

This are all the allowed field names:
- [Name]: this is the configuration name.
- Mark: apply a highlight.
- Filt: open a filter window with the selected patterns or colors.
- Conf: apply a saved configuration type.
- Find: search a pattern or a highlight color
- Goto: change focus to main (init) window, filter window (parent/son) or last filter window.

Configuration format example:

[ConfigName]
Mark = ColorID|Flags|Patterns
Conf = clean
# this is a commented line
Conf = configName
Conf = configName1 configName2 configNameN
Conf = edit
Filt = close
Filt = colorID
Filt = colorID1 colorID2 colorIDN
Find = colorID
Find = colorID1 colorID2 colorIDN
Find = pattern colorID
Goto = init
Goto = son
Goto = parent
Goto = last


7) CONFIGURATION LOAD COMMANDS:

Configurations can be loaded with command :Hit (highlight types).
Examples:
- Show all available configurations :Hit
- Load the first configuration :Hit 1
- Load a configuration with name MyConfig :Hit MyConfig
- Remove any configuration, clean all highlighting :Hit 0

When launching Hit command you should see a menu like this:

  0)  Clear all
  1)  MyConfig
Select type:



8) FILTER WINDOW:

Filter tool, allows to open a separated split containing only the selected highlights with command Hif (highlight filter).
Use command Hif color/pattern.
Examples:
- Open a filter window displaying all lines with highlights :Hif
- Close previous filter and open a filter window displaying all lines with red highlights :close | Hif r
- Close previous filter and open a filter window displaying all lines with red  and green highlights :close | Hif r g2
- Close previous filter and open a filter window displaying all lines with green  and green1 highlights :close | Hif g2 g5
- Close previous filter and open a filter window displaying all lines with background green and red highlights :close | Hif v@ r@
- Close previous filter and open a filter window displaying all lines with word example :close | Hif example
- Close previous filter and open a filter window displaying all lines with word example and any red highlighted pattern :close | Hif This r

When launching this last command you'll see a new split showing:

┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ HI PLUGIN. FILTER WINDOW                      ┃
┃ Filter patterns: "pattern1|This"              ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
Example pattern1
This is my pattern_10 example number 10


Once the filter window's opened, use ENTER key to synchronize the window position between main and filter windows (you can use :Hip command too).

Once the filter window's opened, use Alt+ENTER key to synchronize the window position between main and filter windows and switch the focus between main and filter splits (you can use :Hips command too).


9) EDITOR window:

The highlight configuration editor window allows a more convenient edit of the highlights and filters to apply. Open it with Hie (highlight edit).
Use :Hie to open the editor window (<leader>he too) on vertical split on the right side.

If you followed the previous example you'll see:

┌───────────────────────────────────────┐
│ HIGHLIGHT CONFIG:                     │
└───────────────────────────────────────┘
Mark = r    | C    |pattern1
Mark = g    | C    |pattern2
Mark = g2   | C    |PATTERN3
Mark = g5   | c    |Pattern4
Mark = y!   | C    |pattern5
Mark = m_   | C    |pattern6
Mark = v@   | C    |pattern7
Mark = v    | Cl   |pattern8
Mark = r@   | Cl   |pattern9
Mark = g4   | C    |my.*pattern_10
Mark = n    | C    |pattern_11
Mark = b3!  | C    |pattern_12
Mark = c3_  | C    |pattern_13
Mark = c3_  | Cl   |pattern_14
Mark = c    | CT   |6
Mark = c@   | CT   |8

Edit the highlight configuration paragraph and replace it with this self explanatory one:

┌───────────────────────────────────────┐
│ HIGHLIGHT CONFIG:                     │
└───────────────────────────────────────┘
#------------------------------------------
# Clean previous highlights and filters
Conf = clear
Filt = close
#------------------------------------------
# Highlight commands:
Mark = r    | C    |pattern1
Mark = g    | C    |pattern2
Mark = g2   | C    |PATTERN3
Mark = g5   | c    |Pattern4
Mark = y!   | C    |pattern5
Mark = m_   | C    |pattern6
Mark = v@   | C    |pattern7
Mark = v    | Cl   |pattern8
Mark = r@   | Cl   |pattern9
Mark = g4   | C    |my.*pattern_10
Mark = n    | C    |pattern_11
Mark = b3!  | C    |pattern_12
Mark = c3_  | C    |pattern_13
Mark = c3_  | Cl   |pattern_14
Mark = c    | CT   |6
Mark = c@   | CT   |8
#------------------------------------------
# Filter commands:
Filt = all
#Filt = r g4 m r@
#------------------------------------------
# Search commands:
Find g4

Attention: the firs blank line will end the configuration parser on the editor window.
A blank line is mandatory to at the configuration end to stop config parser.

When changing to any other split the editor window will stay minimized, if you change the focus to the editor split again it will expand to its original size.

Add # character at the beginning of line to comment any configuration command.

Use ENTER key to apply the configuration once finished editing

Use command :Hiy to yank this configuration to the default buffer and :Hicfg to open the configuration files and paste the configuration on the file you want.



10) AUTOLOAD CONFIG LINE (NEW Version 2.0.2)

Autoload a config highlight type defined on firs/last five lines of the file.

The configuration line will be checked and applied, if found, on file's open or reload.

Atuo configuration line examples:

Example 1: load highlight type MY_CONFIG (must be present on the default configuration files: ~/.vim_hi.cfg or ./.vim_hi.cfg)
vim_hi:cfg=MY_CONFIG

Example 2: load configuration file MY_CONFIG_FILE and then apply the highlight type MY_CONFIG.
vim_hi:cfg=MY_CONFIG::cfgfile=MY_CONFIG_FILE

Example 3 and 4: same as example 2
# vim_hi:cfg=MY_CONFIG::cfgfile=MY_CONFIG_FILE
// vim_hi:cfg=MY_CONFIG::cfgfile=MY_CONFIG_FILE


If you want to perform a highlight config auto load whenever a .log file is opened, add to your .vimrc:

augroup HiAutoConfig
     au BufRead *.log call hi#autoConfig#ApplyConfig("MyLogConfig", "MyConfigFile.cfg")
augroup END




11) HIGHLIGHT GROUPS (NEW Version 2.0.2)

New tag '??' allows to filter several configurations at a time.

Example 1: filter all background highlighted patterns.
:Hif @??

Example 2: filter all underlined patterns.
:Hif _??

Example 3: filter all bold highlighted patterns.
:Hif !??

Example 4: filter all red highlighted patterns.
:Hif r*??

Example 5: filter all red backgraound highlighted patterns.
:Hif r*@??


12) HELP menu:

There is a small help you can display using command :Hih.
This will show you the previous (basic) commands and some more.

 
install details
Minimum version: Vim 7.0+
Recomended version: Vim 8.0+

Binaries: ag (silver searcher) or grep needed to open the filter window.

Install vimball:
download hi.vba
vim hi.vba
:so %
:q

If you LIKED THE PLUGIN, or you have some improvements, or you dislike it and found it complicated, no matter what, please drop a few lines to my e-mail and TELL ME! (javierpuigdevall@gmail.com)
 

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
hi.vmb 2.0.4 2020-10-14 7.0 Javier Puigdevall - New: named groups with configuration command: 'Group = NAME1 NAME2 NAMEN'. Disable group with 'Group = '.
- New: filter commands :Filtw/Hifw. Perform filter and show results on the same window.
- New: Configuration command Cmd to execute vim commands:
- New: filter option to remove from filter window colorIDs or patters, adding prefix '--' to the pattern or colorId.
- New: Configuration command for Conf options to enable and disable the highlighting: on, off, won, woff
- New: allow pattern search on :Hics or :Hisb commands and 'Find' configuration command.
- New: enable/disable highlighting commands: Hioff, Hion, Hiwoff, Hiwoff.
hi.vmb 2.0.3 2020-10-05 7.0 Javier Puigdevall - New: hidden config types, not displayed on Hit command, when the config name starts with '__', like [__hiddenConfig].
- New: colors/hi.vim. Add on term config 256, colors N1...N8 N1!...N8! N1_...N8_ N1@...N8@ N1@!...N8@!
- New: colors/hi.vim. Add on gui config, colors: N1...N6 N1!...N6! N1_...N6_ N1@...N6@ N1@!...N6@!
- New: colors/hi.vim. Align columns.
- New: help.vim. Open help in new split, show plugin version.
- New: test.vim. Improve the tests, include the usage example.
- Fix: Hif command not rejects to filter when no highlighting set.
   allow to filer patterns without color highlighting.
- New: highlight only option to omitt a pattern from any filter.
   Use '-' (for line command) and 'h' (for config files).
   ex: :Hic r- MyPattern
   ex: Mark = r | h | MyPattern
- New: highlight groups. Used to filter groups.
   Use '&g' (for line command) and 'g' (for config files).
   ex: Mark = r | g1 | MyRedPattern
   ex: Mark = g | g1 | MyGreenPattern
   ex: :Hif &g1
- New: command Hitf CONFIG_NAME CONFIG_FILE to load a highlight config type from file.
- New: config file's command "Conf", new "add" subcommand to source a new previous defined config.
   ex: Conf = add | CONFIG_NAME
- Fix: for config types: "Conf = add..." do not show on Hish command neither on the config editor.
- Fix: filter patterns that cotain character '/' caused and error on the configReload.
- New: enable/disable highlighting commands: Hi0, Hi1, Hiw0, Hiw1.
hi.vmb 2.0.2 2020-09-01 7.0 Javier Puigdevall - New color option ??, used to select all similar colors.
     Changes on hi#config#GetColorPatterns and hi#config#GetNonColorPatterns
     example: ':Hif g??' will filter all green highlighted colors.
     example: ':Hif _??' will filter all underlined colors.
     example: ':Hif r*@??' will filter all red background highlighted colors.
- Fix :Hishp, missing function hi#config#ShowPatterns
- New: set config editor buffer nowrite. Prevent writting to file.
- New: config editor use q to close the editor window.
- Fix: configuration file and config editor parsing pattern containing '=' characater.
- New option to autolad a config highlight when a header 'vim_hi:cfg=my_config::cfgfile=my_file' found on top/bottom when openening or reloading the file.
hi.tar.gz 2.0.1 2020-06-17 7.0 Javier Puigdevall Fix tar.gz error
hi.tar.gz 2.0.1 2020-06-12 7.0 Javier Puigdevall Fix highlight on top of other highlights.
Fix Hiid all command.
hi.tar.gz 2.0 2020-06-11 7.0 Javier Puigdevall Initial upload
ip used for rating: 100.24.125.162

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.
   
OSDN