Skip to content

luxus/pretty_hover

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 

Repository files navigation

pretty_hover

Table of contents

Pretty_hover is a light weight plugin that parses the hover message before opening the popup window. The output can be easily manipulated with. This will result in more readable hover message.

How it looks

Using native vim.lsp.buf.hover()

Using pretty_hover

Installation and setup

via Lazy

{
	"Fildo7525/pretty_hover",
	config = function()
		require("pretty_hover").setup(options)
	end
},

via Packer

use {
	"Fildo7525/pretty_hover",
	config = function()
		require("pretty_hover").setup(options)
	end
}

Configuration

The configuration consists of four parts. line is a table containing all the words after which will the whole line surrounded by stylers.line character. The word will surround only one word after the elements with stylers.word character. The last table consists of flags that behave as an heading. The stylers.header will replace the elements in header. border is than passed to the nvim api and represents the type of the floating window.

NOTE: To really use this plugin you have to create a keymap that will call require('pretty_hover').hover() function.

Default configuration

{
	line = {
		"@brief",
	},
	word = {
		"@param",
		"@tparam",
		"@see",
	},
	header = {
		"@class",
	},
	stylers = {
		line = "**",
		word = "`",
		header = "###",
	},
	border = "rounded",
}

Inspiration

https://github.com/lewis6991/hover.nvim

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Lua 100.0%