Skip to content

πŸ‘“ A fast and lightweight Neovim lua plugin to keep an eye on where your cursor has jumped.

Notifications You must be signed in to change notification settings

edluffy/specs.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

33 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

specs.nvim πŸ‘“

Show where your cursor moves when jumping large distances (e.g between windows). Fast and lightweight, written completely in Lua.

demo

showcase8 showcase7 showcase6 showcase5 showcase4 showcase3 showcase2 showcase1

Install

Using packer.nvim:

use {'edluffy/specs.nvim'}

Using vim-plug:

Plug 'edluffy/specs.nvim'

Usage

If you are using init.vim instead of init.lua, remember to wrap block below with lua << EOF and EOF

require('specs').setup{ 
    show_jumps  = true,
    min_jump = 30,
    popup = {
        delay_ms = 0, -- delay before popup displays
        inc_ms = 10, -- time increments used for fade/resize effects 
        blend = 10, -- starting blend, between 0-100 (fully transparent), see :h winblend
        width = 10,
        winhl = "PMenu",
        fader = require('specs').linear_fader,
        resizer = require('specs').shrink_resizer
    },
    ignore_filetypes = {},
    ignore_buftypes = {
        nofile = true,
    },
}
  • :lua require('specs').toggle()
    • Toggle Specs on/off

Faders:

  • sinus_fader ⌣/⌒\⌣/⌒\⌣/⌒\⌣/⌒

  • linear_fader β–β–‚β–‚β–ƒβ–ƒβ–„β–„β–…β–…β–†β–†β–‡β–‡β–ˆβ–ˆ

  • exp_fader ▁▁▁▁▂▂▂▃▃▃▄▄▅▆▇

  • pulse_fader β–β–‚β–ƒβ–„β–…β–†β–‡β–ˆβ–‡β–†β–…β–„β–ƒβ–‚β–

  • empty_fader ▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁

Resizers:

  • shrink_resizer β–‘β–‘β–’β–’β–“β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–“β–’β–’β–‘β–‘

  • slide_resizer β–ˆβ–ˆβ–ˆβ–ˆβ–“β–“β–“β–’β–’β–’β–’β–‘β–‘β–‘β–‘

  • empty_resizer β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆ

You can implement your own custom fader/resizer functions for some pretty cool effects:

require('specs').setup{ 
    popup = {
	-- Simple constant blend effect
        fader = function(blend, cnt)
            if cnt > 100 then
                return 80
            else return nil end
        end,
	-- Growing effect from left to right
        resizer = function(width, ccol, cnt)
            if width-cnt > 0 then
                return {width+cnt, ccol}
            else return nil end
        end,
    }
}

Keybinds

You can invoke specs from anywhere by using :lua require('specs').show_specs()
Add a keybind for this to make it easy to find your cursor at any time.

-- Press <C-b> to call specs!
vim.api.nvim_set_keymap('n', '<C-b>', ':lua require("specs").show_specs()', { noremap = true, silent = true })

-- You can even bind it to search jumping and more, example:
vim.api.nvim_set_keymap('n', 'n', 'n:lua require("specs").show_specs()<CR>', { noremap = true, silent = true })
vim.api.nvim_set_keymap('n', 'N', 'N:lua require("specs").show_specs()<CR>', { noremap = true, silent = true })

-- Or maybe you do a lot of screen-casts and want to call attention to a specific line of code:
vim.api.nvim_set_keymap('n', '<leader>v', ':lua require("specs").show_specs({width = 97, winhl = "Search", delay_ms = 610, inc_ms = 21})<CR>', { noremap = true, silent = true })

Planned Features

  • More builtin faders + resizers
  • Colorizers
  • Optional highlight on text yank

About

πŸ‘“ A fast and lightweight Neovim lua plugin to keep an eye on where your cursor has jumped.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published