5

GitHub - axlebedev/footprints: Vim plugin: footprints. Show last edited lines in...

 2 years ago
source link: https://github.com/axlebedev/footprints
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

Footprints vim plugin

Footprints is a plugin that makes visualisation of command :changes on the fly. It helps to keep focus on lines you are working on

USAGE

Change any text.
That's it. That line will be highlighted.
The older change - the dimmer highlight.


INSTALLATION

Example of installation and setting configs

  Plug 'axlebedev/footprints'
  let g:footprintsColor = '#3A3A3A'
  let g:footprintsTermColor = '208'
  let g:footprintsEasingFunction = 'linear'
  let g:footprintsHistoryDepth = 20
  let g:footprintsExcludeFiletypes = ['magit', 'nerdtree', 'diff']
  let g:footprintsEnabledByDefault = 1
  let g:footprintsOnCurrentLine = 0

CONFIGURATION

g:footprintsColor

Default: '#3A3A3A' or '#C1C1C1' depending on &background setting
Hex number. Color of the latest change highlight. Used in gui or if &termguicolors
Older highlights will be dimmed to 'Normal' background according to g:footprintsEasingFunction.
let g:footprintsColor = '#275970'

g:footprintsTermColor

Default: 208
Number. Color of the latest change highlight. Used in terminal if not &termguicolors
g:footprintsEasingFunction is ignored.
let g:footprintsTermColor = '186'

g:footprintsEasingFunction

Default: 'linear'
One of linear, easein, easeout, easeinout.
How does footprint color 'cooldown' to usual background color
let g:footprintsEasingFunction = 'easeinout'

g:footprintsHistoryDepth

Default: 20
How many steps should be highlighted
let g:footprintsHistoryDepth = 10

g:footprintsExcludeFiletypes

Default: []
Which filetypes should not be processed by this plugin
let g:footprintsExcludeFiletypes = ['magit', 'nerdtree', 'diff']

g:footprintsEnabledByDefault

Default: 1
Boolean. Define if this plugin is enabled on vim start
let g:footprintsEnabledByDefault = 1

g:footprintsOnCurrentLine

Default: 0
Boolean. Define if current line should be highlighted or not.
let g:footprintsOnCurrentLine = 0


COMMANDS

:FootprintsDisable
:FootprintsEnable
:FootprintsToggle

Enable/disable Footprints globally


:FootprintsBufferDisable
:FootprintsBufferEnable
:FootprintsBufferToggle

Enable/disable Footprints only in current buffer


:FootprintsCurrentLineDisable
:FootprintsCurrentLineEnable
:FootprintsCurrentLineToggle

Enable/disable Footprint highlight for current line


footprints#SetColor(hexColor: string)

Set g:footprintsColor and update highlights to new color.
Note: this change will not be saved to next vim run, use g:footprintsColor for persistent change.
call footprints#SetColor('#FF0000')

footprints#SetTermColor(termColorCode: number)

Set g:footprintsTermColor and update highlights to new color.
Note: this change will not be saved to next vim run, use g:footprintsColor for persistent change.
call footprints#SetTermColor(200)

footprints#Footprints()

Update footprints in current buffer
call footprints#Footprints()

footprints#OnBufEnter()

Update footprints on bufenter or any other case when current window contains some older highlights
call footprints#OnBufEnter()

footprints#OnCursorMove()

Update footprints when content was not changed, only update current line highlight
call footprints#OnCursorMove()

footprints#Disable(forCurrentBuffer: bool)
footprints#Enable(forCurrentBuffer: bool)
footprints#Toggle(forCurrentBuffer: bool)

Disable, enable or toggle footprints. forCurrentBuffer == 0 - do it globally
forCurrentBuffer == 1 - do only for current buffer

    call footprints#Disable(0)
    call footprints#Enable(1)
    call footprints#Toggle(1)
footprints#EnableCurrentLine()
footprints#DisableCurrentLine()
footprints#ToggleCurrentLine()
Disable, enable or toggle footprint on current line.
    call footprints#DisableCurrentLine()
    call footprints#EnableCurrentLine()
    call footprints#ToggleCurrentLine()

CONTRIBUTIONS

Contributions and pull requests are welcome.
If you find a bug, or have an improvement suggestion - please place an issue in this repository.


About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK