Skip to content

Repository files navigation

Wrist May Cry

Vim is all about making text editing as efficient and ergonomic as possible. But what if it was optimal not to always edit optimally? WMC is a Neovim plugin that encourages variety in used motions through Devil May Cry-inspired style ranks.

Showcase

wmc-demo.mp4

Requirements

  • Neovim >= 0.11.0

Installation

return {
    "pakut2/wmc.nvim",
    lazy = false,
    version = "*", -- use `branch = "main"`, to reference the latest unstable changes
}
:Rocks install wmc.nvim

Configuration

Note

Calling the setup function is optional.

Default Settings

require("wmc").setup({
	enabled = true,
	ui = {
		anchor = "NE",
		row = 1,
		col = function()
			return vim.o.columns - 5
		end,
		zindex = 50,
		border = "none",
	},
	logger = {
		enabled = false,
		log_file_path = vim.fn.stdpath("data") .. "/wmc.log",
	},
})
Option Explanation
enabled Toggle wmc
ui Configure style rank display window (partially derived from vim.api.keyset.win_config). row and col support passing a function for dynamic Neovim window resize handling
logger Toggle debug logging and change log destination

Development

Running tests

Tests are executed with Neovim as the Lua interpreter with busted.

Install Test Dependencies

luarocks install --tree lua_modules --lua-version 5.1 nlua
luarocks install --tree lua_modules --lua-version 5.1 busted

Run Tests

eval "$(luarocks path --tree lua_modules --lua-version 5.1)"
luarocks test --lua-version 5.1

About

Edit with STYLE in Neovim

Topics

Resources

Stars

Watchers

Forks

Releases

Contributors

Languages