Don't across that column in Neovim
Deadcolumn is a neovim plugin to assist users in maintaining a specific column
width in their code. This plugin operates by gradually displaying the
colorcolumn as the user approaches it. It is useful for people who wish to
keep their code aligned within a specific column range.
Table of Contents
-
Gradually display the
colorcolumnas the user approaches it:
-
Display the column in warning color if current line exceeds
colorcolumn:
-
Handle multiple values of
colorcolumnproperly::set colorcolumn=-10,25,+2 textwidth=20:
-
Show the colored column only when you need it
-
Show the colored column in insert mode only:
-
Show the colored column only when current line is longer than
colorcolumn:
-
and more...
-
-
Using lazy.nvim
lua require('lazy').setup({ { 'Bekaboo/deadcolumn.nvim' } })
-
Using packer.nvim
require('packer').startup(function(use) use 'Bekaboo/deadcolumn.nvim' end)
-
Using rocks.nvim
:Rocks install deadcolumn.nvim
You don't need to call the setup() function if you don't want to change the
default options, the plugin should work out of the box if you set colorcolumn
to a value greater than 0.
The following is the default options, you can pass a table to the setup()
function to override the default options.
local opts = {
scope = 'line', ---@type string|fun(): integer
---@type string[]|fun(mode: string): boolean
modes = function(mode)
return mode:find('^[ictRss\x13]') ~= nil
end,
blending = {
threshold = 0.75,
colorcode = '#000000',
hlgroup = { 'Normal', 'bg' },
},
warning = {
alpha = 0.4,
offset = 0,
colorcode = '#FF0000',
hlgroup = { 'Error', 'bg' },
},
extra = {
---@type string?
follow_tw = nil,
},
}
require('deadcolumn').setup(opts) -- Call the setup function-
scope(string|function): The scope for showing the colored column, there are several possible values:-
'line': colored column will be shown based on the length of the current line. -
'buffer': colored column will be shown based on the length of the longest line in current buffer (up to 1000 lines around current line). -
'visible': colored column will be shown based on the length of the longest line in the visible area. -
'cursor': colored column will be shown based on current cursor position. -
function() -> number: callback function that returns a number as the length of the row. For example, to show the colored column based on the longest line in the nearby 100 lines:require('deadcolumn').setup({ scope = function() local max = 0 for i = -50, 50 do local len = vim.fn.strdisplaywidth(vim.fn.getline(vim.fn.line('.') + i)) if len > max then max = len end end return max end })
-
-
modes(table|function): In which modes to show the colored column.-
If
modesis a table, it should contain a list of mode names -
If
modesis a function, it should accept a string as the mode name and return a boolean value indicating whether to show the colored column in that mode.
-
-
blending(table): Blending options.-
threshold(number): The threshold for showing the colored column.-
If
thresholdis a number between 0 and 1, it will be treated as a relative threshold, the colored column will be shown when the current line is longer thanthresholdtimes thecolorcolumn. -
If
thresholdis a number greater than 1, it will be treated as a fixed threshold, the colored column will be shown when the current line is longer thanthresholdcharacters.
-
-
colorcode(string): The color code to be used as the background color for blending. -
hlgroup(table): The highlight group to be used as the background color for blending.- If the highlight group is not found,
colorcodewill be used.
- If the highlight group is not found,
-
-
warning(table): Warning color options.-
alpha(number): The alpha value for the warning color, blended with the background color. -
offset(number): The offset for the warning color, the warning color will be shown when the length of the line exceedscolorcolumnbyoffsetcharacters. -
colorcode(string): The color code for the warning color. -
hlgroup(table): The highlight group for the warning color.- If the highlight group is not found,
colorcodewill be used.
- If the highlight group is not found,
-
-
extra(table): Extra functionalities.-
follow_tw(nil|string):-
If
follow_twisnil: the functionalities is disabled. -
If
follow_twis string:colorcolumnwill be set to this value whentextwidthis set, and will be restored to the original value whentextwidthis unset.Suggested value for this option is
'+1'.
-
-
This can have several reasons:
-
If you are using the default config, it is expected that you can't see the colored column in normal mode, because the colored column is only shown in insert mode and replace mode by default. You can change the
modesoption to show the colored column in normal mode. -
Please make sure you have set
colorcolumnto a value greater than 0 in your config. Also, make sure that you havetermguicolorsset using:set termguicolors -
If you set
colorcolumnto a relative value (e.g.'-10'), make suretextwidthis set to a value greater than 0.
This plugin does not set colorcolumn for you, it only reads and uses the
value of colorcolumn of the current buffer to show the colored column
when needed.
It leaves to you to set colorcolumn for different filetypes, under different
conditions, which is more flexible compared to setting colorcolumn in the
plugin setup function.
There are mainly two ways to set colorcolumn for different filetypes:
-
Using
autocmd:You can use the
autocmdcommand to setcolorcolumnfor different filetypes.For example, you can set
colorcolumnto 80 for markdown files:autocmd FileType markdown setlocal colorcolumn=80
-
Using
ftplugin:You can also use the
ftplugindirectory to setcolorcolumnfor different filetypes.For example, you can create a file named
markdown.vimin theftplugindirectory under your config directory, and setcolorcolumnto 80 formarkdownfiles:setlocal colorcolumn=80
If you are using a transparent background, the colored column may not be
displayed properly, since the background color of the colored column
dynamically changed based on the blending of 'Normal' background color and
the orignial 'ColorColumn' background color.
If Deadcolumn cannot find the 'Normal' background color, it will use
'#000000' (pure black) as the default background color for blending.
There is no way to fix this, since terminal emulators do not support setting a transparent background color for a specific character.
Workarounds:
-
You can set
opts.thresholdto 1 to disable blending when the length is smaller thancolorcolumnand show the colored column only when it is greater thancolorcolumn, OR -
You can assign a different highlight group or a fixed colorcode to be used for blending with the original
'ColorColumn'background color, for example:require('deadcolumn').setup({ blending = { colorcode = '#1F2430', hlgroup = { 'NonText', 'bg' }, }, })
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "github-actions[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent