https://github.com/tjdevries/overlength.vim
Highlight when lines go over the length that you want them.
https://github.com/tjdevries/overlength.vim
Last synced: over 1 year ago
JSON representation
Highlight when lines go over the length that you want them.
- Host: GitHub
- URL: https://github.com/tjdevries/overlength.vim
- Owner: tjdevries
- License: mit
- Created: 2017-06-28T22:00:10.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-07-10T19:13:00.000Z (almost 6 years ago)
- Last Synced: 2025-01-16T19:25:06.718Z (over 1 year ago)
- Language: Vim script
- Size: 12.7 KB
- Stars: 24
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
## overlength.vim
Highlight when lines go over the length that you want them.
### Usage
This plugin is on by default when you install it :smile:
To toggle or turn it off, you can do the following:
`call overlength#toggle()`:
- (Function): Turn on and off overlength highlighting
- Example: `call overlength#toggle()`
- Alternatives: `call overlength#disable()` or `call overlength#enable()`
### Configuration
Example configuration:
```vim
let overlength#default_overlength = 120
" Disable highlighting in markdown.
call overlength#set_overlength('markdown', 0)
" To disable highlighting in multiple fts at once
call overlength#disable_filetypes(['markdown', 'term'])
" Highlight only at 120 characters in vim, even though textwidth = 78
call overlength#set_overlength('vim', 120)
```
`overlength#default_to_textwidth`:
- (Setting): Default to using the `&textwidth` option as the column to start drawing the overlength highlighting
- Options:
- `0`: Don't use `&textwidth` at all. Always use `overlength#default_overlength`.
- `1`: Use `&textwidth`, unless it's 0, then use `overlength#default_overlength`.
- `2`: Always use `&textwidth`. There will be no highlighting where `&textwidth == 0`, unless added explicitly
- Default: `1`
- Example: `let overlength#default_to_textwidth = 0`
`call overlength#set_overlength(filetype, length)`:
- (Function): Set a specific overlength value for a filetype
- If set to 0, then overlength will not highlight for that buffer
- Example: `call overlength#set_overlength('python', 120)`
`overlength#default_overlength`:
- (Setting): Decide the default length when there is no filetype specific request
- Depends on `overlength#default_to_textwidth` to be on an applicable setting
- Default: `80`
- Example: `let overlength#default_overlength = 72`
`overlength#default_grace_legnth`:
- (Setting): Decide how many spaces past your `overlength` you'd like to start highlighting
- Default: `1`
- Example: `let overlength#default_grace_legnth = 5`
`call overlength#set_highlight(cterm, guibg)`:
- (Function): Change the highlighting background by specifying a `cterm` and `guibg`
- Example: `call overlength#set_highlight('darkgrey', '#8b0000')`
`overlength#highlight_to_end_of_line`:
- (Setting): Highlight only the column or until the end of the line
- Default: `v:true`
- Example: `let overlength#highlight_to_end_of_line = v:false`
### Note on Multi Width Bug
I cannot figure out how to solve the problem for the case where `overlength#highlight_to_end_of_line` is set to `v:false`
(i.e., you only want highlighting on the column only, not the whole line) due to the vim limitation of:
```
Note that some virtual column positions will never match, because they
are halfway through a tab or other character that occupies more than
one screen character.
```
So, sometimes the highlighting will miss. If this bothers you, please leave an issue and maybe I can fix it.