Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/svampkorg/moody.nvim
A plugin for neovim which changes the colour of CursorColumn depending on mode.
https://github.com/svampkorg/moody.nvim
Last synced: about 2 months ago
JSON representation
A plugin for neovim which changes the colour of CursorColumn depending on mode.
- Host: GitHub
- URL: https://github.com/svampkorg/moody.nvim
- Owner: svampkorg
- License: mit
- Created: 2024-07-10T08:23:50.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-08-26T18:59:46.000Z (6 months ago)
- Last Synced: 2024-08-26T22:11:33.359Z (6 months ago)
- Language: Lua
- Size: 54.7 KB
- Stars: 45
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
✨ moody ✨
Don't look down! 🚠
- [Why?](#-Why?)
- [Video](#-Video)
- [Install](#-Install)
- [Setup](#-Setup)
- [Acknowledgments](#-Acknowledgments)
- [Similar plugins](#-Similar)
- [Known issues](#-Issues)
## ❓Why?
If you look down, you might miss out on some code getting inserted by your quick caffeine induced coding fingers!
I would be a real shame if that happens when you are not in the mode for it. 🤦
I made this plugin so I could see which mode Neovim is in just by the color of CursorLine and CursorLineNr.
## 🎥 Video
#### Different modes, different CursorLine colours
#### Recording macro indicator in CursorLine
## 💾 Install
- Install with Lazy like this
```lua
{
"svampkorg/moody.nvim",
event = { "ModeChanged", "BufWinEnter", "WinEnter" },
dependencies = {
-- or whatever "colorscheme" you use to setup your HL groups :)
-- Colours can also be set within setup, in which case this is redundant.
"catppuccin/nvim",
-- for seeing Moody's take on folds
"kevinhwang91/nvim-ufo"
},
opts = {
-- you can set different blend values for your different modes.
-- Some colours might look better more dark, so set a higher value
-- will result in a darker shade.
blends = {
normal = 0.2,
insert = 0.2,
visual = 0.25,
command = 0.2,
operator = 0.2,
replace = 0.2,
select = 0.2,
terminal = 0.2,
terminal_n = 0.2,
},
-- there are two ways to define colours for the different modes.
-- one way is to define theme here in colors. Another way is to
-- set them up with highlight groups. Any highlight group set takes
-- precedence over any colours defined here.
colors = {
normal = "#00BFFF",
insert = "#70CF67",
visual = "#AD6FF7",
command = "#EB788B",
operator = "#FF8F40",
replace = "#E66767",
select = "#AD6FF7",
terminal = "#4CD4BD",
terminal_n = "#00BBCC",
},
-- disable filetypes here. Add for example "TelescopePrompt" to
-- not have any coloured cursorline for the telescope prompt.
disabled_filetypes = { "TelescopePrompt" },
-- disabled buftypes here
disabled_buftypes = { },
-- you can turn on or off bold characters for the line numbers
bold_nr = true,
-- you can turn on and off a feature which shows a little icon and
-- registry number at the end of the CursorLine, for when you are
-- recording a macro! Default is false.
recording = {
enabled = false,
icon = "",
-- you can set some text to surround the recording registry char with
-- or just set one to empty to maybe have just one letter, an arrow
-- perhaps! For example recording to q, you could have! " q" :D
pre_registry_text = "[",
post_registry_text = "]",
-- if you have some other plugin showing up on the right you can pad
-- the recording indicator on the right side, to shift it to the left.
-- For example if you use Satellite you have to shift recording to the left.
-- using right padding.
right_padding = 2,
},
-- extend the cursorline to cover line numbers.
extend_to_linenr = true,
-- extend_to_linenr_visual enables moodys built in statuscolumn to cover linenr in
-- visual selection to show the visual range of the selection highlighted by
-- Visual hl group.
extend_to_linenr_visual = false,
-- setting reduce_cursorline to true will reduce the moodys cursorline to.. nothing!
-- It will make the cursorline have the default value of whatever cursorline has in the
-- default "hightlight namespace", 0. TLDR: no moody change in cursorline with ModeChanged.
reduce_cursorline = false,
-- fold_options.enabled also enables the built in SignColumn in moody. These folds takes a bit of a different
-- approach to showing folds and their range. Try it out and see if you like it :) If not you can use
-- the SignColumn as is, with extend_to_linenr. It will then only show diagnostic signs and linenr.
-- This requires nvim-ufo, and will possibly break your current custom SignColumn (if you have any)
fold_options = {
enabled = false,
-- these are two colors you can specifiy which will be used to generate a gradient
-- with one step for each fold level, specified by vim.o.foldnestmax
start_color = "#C1C1C1",
end_color = "#2F2F2F",
},
},
}
```
## 💺 Setup
- Define your HL groups within your colorscheme. For example like this, in catppuccin highlight_overrides
- Or set the colours in opts passed to setup
```lua
{
NormalMoody = { fg = C.blue },
InsertMoody = { fg = C.green },
VisualMoody = { fg = C.pink },
CommandMoody = { fg = C.maroon },
OperatorMoody = { fg = C.maroon },
ReplaceMoody = { fg = C.red },
SelectMoody = { fg = C.pink },
TerminalMoody = { fg = C.mauve },
TerminalNormalMoody = { fg = C.mauve },
}
```
- Theres not a lot of values to set, but these are the defaults:
```lua
{
blends = {
normal = 0.2,
insert = 0.2,
visual = 0.2,
command = 0.2,
operator = 0.2,
replace = 0.2,
select = 0.2,
terminal = 0.2,
terminal_n = 0.2,
},
-- will be overruled if HL groups are set
colors = {
normal = "#00BFFF",
insert = "#70CF67",
visual = "#AD6FF7",
command = "#EB788B",
operator = "#FF8F40",
replace = "#E66767",
select = "#AD6FF7",
terminal = "#4CD4BD",
terminal_n = "#00BBCC",
},
disabled_filetypes = {},
disabled_buftypes = {},
bold_nr = true,
extend_to_linenr = true,
extend_to_linenr_visual = false,
fold_options = {
enabled = false,
start_color = "#C1C1C1",
end_color = "#2F2F2F",
},
recording = {
enabled = false,
icon = "",
pre_registry_text = "[",
post_registry_text = "]",
right_padding = 2,
},
}
```
## 🤯 Issues
- There are no known issues at the moment.
## 🤔 Todo
- ✅ Make moody ignore certain buffers, or filetypes.
## ⭐ Acknowledgments
- [ellisonleao/nvim-plugin-template](https://github.com/ellisonleao/nvim-plugin-template) - *Plugin Structure*
- [S1M0N38/my-awesome-plugin.nvim](https://github.com/ellisonleao/nvim-plugin-template) - *Plugin Structure* I used this to generate the structure of this plugin. Thanks S1M0N38! ❤️
- [nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) - *Tests, lint, docs generation*
- [folke/tokyonight.nvim](https://github.com/folke/tokyonight.nvim) - *Colour calculations* Borrowed some colour calculation methods from here ❤️
- [Wansmer/nvim-config](https://github.com/Wansmer/nvim-config) - *Line numbers & visual selection* Borrowed some code from this guys neovim config (/lua/modules/status/components) ❤️
## 🫶 Similar
- Plugins that do the same thing!
- [modes](https://github.com/mvllow/modes.nvim)
- [line-number-change-mode](https://github.com/sethen/line-number-change-mode.nvim)
- [modicator](https://github.com/mawkler/modicator.nvim)