atom-auto-highlight/README.md

Auto-highlight

• Forked from: https://github.com/t9md/atom-quick-highlight

• Word under cursor and all its occurences would be highlighted automatically.

• Max highlighted number of words default to 2, you can change the settings to 1 or others in the plugin settings.

• Show found count on StatusBar.

Commands

• auto-highlight:toggle toggle highlight for selected or cursor word. In fact you don't need to run the command manually.
• auto-highlight:clear clear all highlight.

And following two operator for vim-mode-plus user.

• vim-mode-plus-user:auto-highlight: Operator to highlight by text-object or motion.
• vim-mode-plus-user:auto-highlight-word Highlight cursor word, similar to auto-highlight:toggle, but well fit for vim's block cursor orientation. And . repeatable.

Keymap

No default keymap.

e.g.

• general

  'atom-workspace atom-text-editor:not([mini])':
  'cmd-k m': 'auto-highlight:toggle'
  'cmd-k M': 'auto-highlight:clear'
  

• vim-mode-plus user

  'atom-text-editor.vim-mode-plus.normal-mode, atom-text-editor.vim-mode-plus.visual-mode':
  'space m': 'vim-mode-plus-user:auto-highlight-word'
  'space M': 'auto-highlight:clear'
  'g m': 'vim-mode-plus-user:auto-highlight'
  

Modify highlight style

You can override style in you style.less. See example below.

@import "syntax-variables";

// For selection color
//=======================
atom-text-editor .auto-highlight.box-selection .region {
  border-width: 1px;
  background-color: transparent;
  border-color: @syntax-text-color;
}

// Make underline manual highlight prioritized(come front) over other highlight
//=======================
// Mixin to set z-index of auto-highlight manual color
.auto-highlight-z-index(@name, @value) {
  .auto-highlight.@{name} .region {
    z-index: @value;
  }
}

// auto-highlight use 0 to 7 color
//  for box style, use box-01 to box-07
//  for highlight style, use highlight-01 to highlight-07
.auto-highlight-z-index(underline-01, 1);
.auto-highlight-z-index(underline-02, 1);
.auto-highlight-z-index(underline-03, 1);
.auto-highlight-z-index(underline-04, 1);
.auto-highlight-z-index(underline-05, 1);
.auto-highlight-z-index(underline-06, 1);
.auto-highlight-z-index(underline-07, 1);

vim-mode-plus operator

You can auto-highlight with combination of any motion, text-object.
Since it's operator, yes can repeat by ..

e.g.

• g m i w: highlight inner-word.
• g m i l: highlight inner-line.
• g m i': highlight inner-single-quote.
• v 2 l g m: highlight three visually selected character..

Display found count on StatusBar

By default, when you highlight new text by auto-highlight:toggle, found count is displayed on StatusBar.
You can configure CSS class to use with countDisplayStyles.
See. styleguide:show for available style classes.

e.g.

• Default: badge icon icon-location
• e.g. 2: badge badge-error icon icon-bookmark
• e.g. 3: badge badge-success icon icon-light-bulb
• e.g. 4: btn btn-primary selected inline-block-tight

TODO

• Improve default to dynamically change using color-channel?
• To highlight whole word except prefix matched ones.