https://github.com/jinh0/eyeliner.nvim

👀 Move faster with unique f/F indicators.
https://github.com/jinh0/eyeliner.nvim

neovim-lua neovim-plugin vim vimrc

Last synced: 11 days ago
JSON representation

👀 Move faster with unique f/F indicators.

• Host: GitHub
• URL: https://github.com/jinh0/eyeliner.nvim
• Owner: jinh0
• Created: 2022-07-05T16:25:31.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-03T09:18:11.000Z (9 months ago)
• Last Synced: 2024-03-01T06:40:23.078Z (4 months ago)
• Topics: neovim-lua, neovim-plugin, vim, vimrc
• Language: Lua
• Homepage:
• Size: 98.6 KB
• Stars: 358
• Watchers: 3
• Forks: 16
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Lists

• awesome-stars - jinh0/eyeliner.nvim - 👀 Move faster with unique f/F indicators. (Lua)
• awesome-stars - jinh0/eyeliner.nvim - 👀 Move faster with unique f/F indicators. (Lua)
• awesome-stars - jinh0/eyeliner.nvim - 👀 Move faster with unique f/F indicators. (Lua)

README

        
# 👀 eyeliner.nvim

Move faster with unique `f`/`F` indicators for each word on the line. Like [quick-scope](https://github.com/unblevable/quick-scope), but in Lua.

https://user-images.githubusercontent.com/40512164/178066018-0d3fa234-a5b5-4a41-a340-430e8c4c2739.mov

The orange letters indicate the unique letter in the word that you can jump to with `f`/`F` right away.

Blue letters indicate that there is no unique letter in the word, but you can get to it with `f`/`F` and then a repeat with `;`.

## 📦 Installation

Requirement: Neovim >= 0.7.0

Using [vim-plug](https://github.com/junegunn/vim-plug):

```vim

Plug 'jinh0/eyeliner.nvim'

```

Using [packer.nvim](https://github.com/wbthomason/packer.nvim):

```lua

use 'jinh0/eyeliner.nvim'

```

## ⚙️ Configuration

Default values (in packer.nvim):

```lua

use {

  'jinh0/eyeliner.nvim',

  config = function()

    require'eyeliner'.setup {

      highlight_on_key = true, -- show highlights only after keypress

      dim = false              -- dim all other characters if set to true (recommended!)

    }

  end

}

```

## ✨ Show highlights only after keypress

If you prefer to have eyeliner's highlights shown only after you press `f`/`F`/`t`/`T`, set `highlight_on_key` to `true` in the setup function.

In Lua:

```lua

use {

  'jinh0/eyeliner.nvim',

  config = function()

    require'eyeliner'.setup {

      highlight_on_key = true

    }

  end

}

```

Demo

https://user-images.githubusercontent.com/40512164/180614964-c1a63671-7fa8-438d-ad4f-c90079adf098.mov

### Highlight + Dim

When using `highlight_on_key`, you may want to dim the rest of the characters since they are unimportant. You can do this with the `dim` option:

```lua

require'eyeliner'.setup {

  highlight_on_key = true, -- this must be set to true for dimming to work!

  dim = true,

}

```

https://user-images.githubusercontent.com/40512164/211218941-ac7df0b6-67ea-4aa2-af9a-110ef9e3091f.mov

## 🖌 Customize highlight colors

You can customize the highlight colors and styles with the `EyelinerPrimary` and `EyelinerSecondary` highlight groups.

For instance, if you wanted to make eyeliner.nvim more subtle by only using bold and underline, with no color,

In Vimscript:

```vim

highlight EyelinerPrimary gui=underline,bold

highlight EyelinerSecondary gui=underline

```

In Lua:

```lua

vim.api.nvim_set_hl(0, 'EyelinerPrimary', { bold = true, underline = true })

vim.api.nvim_set_hl(0, 'EyelinerSecondary', { underline = true })

```

If you want to set a custom color:

In Vimscript:

```vim

highlight EyelinerPrimary guifg=#000000 gui=underline,bold

highlight EyelinerSecondary guifg=#ffffff gui=underline

```

In Lua:

```lua

vim.api.nvim_set_hl(0, 'EyelinerPrimary', { fg='#000000', bold = true, underline = true })

vim.api.nvim_set_hl(0, 'EyelinerSecondary', { fg='#ffffff', underline = true })

```

### Update highlights when the colorscheme is changed

In Vimscript:

```vim

autocmd ColorScheme * :highlight EyelinerPrimary ...

```

In Lua:

```lua

vim.api.nvim_create_autocmd('ColorScheme', {

  pattern = '*',

  callback = function()

    vim.api.nvim_set_hl(0, 'EyelinerPrimary', { bold = true, underline = true })

  end,

})

```

## Commands

Enable/disable/toggle:

```

:EyelinerEnable

:EyelinerDisable

:EyelinerToggle

```