Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jaxbot/semantic-highlight.vim
Semantic Highlighting for Vim
https://github.com/jaxbot/semantic-highlight.vim
Last synced: 3 months ago
JSON representation
Semantic Highlighting for Vim
- Host: GitHub
- URL: https://github.com/jaxbot/semantic-highlight.vim
- Owner: jaxbot
- Created: 2014-07-14T16:48:10.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-10-31T15:24:12.000Z (about 1 year ago)
- Last Synced: 2024-07-05T13:54:56.879Z (4 months ago)
- Language: Vim script
- Homepage: http://jaxbot.me/
- Size: 247 KB
- Stars: 486
- Watchers: 12
- Forks: 34
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Semantic-Highlight.vim
Where every variable is a different color, an idea popularized by Evan Brooks' blog post.
## Install
Vundle or Neobundle:
```
Plugin 'jaxbot/semantic-highlight.vim'
```
Pathogen:
```
git clone https://github.com/jaxbot/semantic-highlight.vim.git
```
## Usage
In a file, run `:SemanticHighlight` to convert variables into colors. Run `:SemanticHighlightRevert` to revert.
You can also map `:SemanticHighlightToggle` to a shortcut to toggle the effect on and off:
```
:nnoremap s :SemanticHighlightToggle
```
## Customization
Set `g:semanticTermColors` and/or `g:semanticGUIColors` to a list of colors, then run `RebuildSemanticColors` to flush the cache. The color lists look like:
```
let s:semanticGUIColors = [ '#72d572', '#c5e1a5', '#e6ee9c', '#fff59d', '#ffe082', '#ffcc80', '#ffab91', '#bcaaa4', '#b0bec5', '#ffa726', '#ff8a65', '#f9bdbb', '#f9bdbb', '#f8bbd0', '#e1bee7', '#d1c4e9', '#ffe0b2', '#c5cae9', '#d0d9ff', '#b3e5fc', '#b2ebf2', '#b2dfdb', '#a3e9a4', '#dcedc8' , '#f0f4c3', '#ffb74d' ]
```
or
```
let g:semanticTermColors = [28,1,2,3,4,5,6,7,25,9,10,34,12,13,14,15,16,125,124,19]
```
Either list can also be set in your vimrc
## Language support
This plugin is language agnostic, meaning it will work on any language with words. However, some languages have been tweaked by default to disable highlighting of language keywords.
Current language support with keyword blacklists:
* C
* C++
* CoffeeScript
* Go
* Java
* JavaScript
* PHP
* Python
* Ruby
* Rust
* Scala
* TypeScript
This can be customized locally by populating `g:semanticBlacklistOverride` like so:
```
let g:semanticBlacklistOverride = {
\ 'javascript': [
\ 'setTimeout',
\ 'break',
\ 'dance',
\ ]
\ }
```
If you want to add language support to the plugin itself, feel free to edit autoload/blacklist.vim and submit a pull request with your changes. Help is appreciated!
## Adding characters to be included in highlights
Some languages, such as PHP and JavaScript, allow special characters to be used in variable names.
Consider the following:
```JS
var $someObject = '1231';
var someObject = 1231;
```
Without the `autocommand` outlined below, only the `someObject` portion of the variable would be semantically highlighted, and highlighted the same colour as the `$`-free variable. To have the preceding `$` included in the semantic highlight, use the following snippet in your vimrc:
```
autocmd FileType javascript setlocal iskeyword+=$
```
## Kudos
Big thanks to John Leimon, whose [Semantic C/C++ Vimscript](http://www.vim.org/scripts/script.php?script_id=4945) was inspirational in the construction of this one.
Also big thanks to everyone who submitted bugs, suggestions, and pull requests!
## About me
I'm Jonathan. I like to hack around with Vim, Node.js, embedded hardware, and Glass. If any of that sounds interesting, [follow me!](https://github.com/jaxbot)