folke / twilight.nvim

🌅 Twilight is a Lua plugin for Neovim 0.5 that dims inactive portions of the code you're editing using TreeSitter.

🌅 Twilight

Twilight is a Lua plugin for Neovim 0.5 that dims inactive portions of the code you're editing.

The plugin was heavily inspired by Limelight, but uses TreeSitter for better dimming.

Pairs well with zen-mode.

⚡️ Requirements

• Neovim >= 0.5.0

📦 Installation

Install the plugin with your preferred package manager:

lazy.nvim

-- Lua
{
  "folke/twilight.nvim",
  opts = {
    -- your configuration comes here
    -- or leave it empty to use the default settings
    -- refer to the configuration section below
  }
}

⚙️ Configuration

Twilight comes with the following defaults:

{
  dimming = {
    alpha = 0.25, -- amount of dimming
    -- we try to get the foreground from the highlight groups or fallback color
    color = { "Normal", "#ffffff" },
    term_bg = "#000000", -- if guibg=NONE, this will be used to calculate text color
    inactive = false, -- when true, other windows will be fully dimmed (unless they contain the same buffer)
  },
  context = 10, -- amount of lines we will try to show around the current line
  treesitter = true, -- use treesitter when available for the filetype
  -- treesitter is used to automatically expand the visible text,
  -- but you can further control the types of nodes that should always be fully expanded
  expand = { -- for treesitter, we we always try to expand to the top-most ancestor with these types
    "function",
    "method",
    "table",
    "if_statement",
  },
  exclude = {}, -- exclude these filetypes
}

🚀 Usage

You can manually trigger Twilight using the commands:

• Twilight: toggle twilight
• TwilightEnable: enable twilight
• TwilightDisable: disable twilight

🧘 Zen Mode Integration

If you have zen-mode installed, then Twilight is activated automatically. Refer to the Zen Mode documentation to disable.

twilight.nvim's Issues

Not dimming anything

Hi,
it seems that twilight is not dimming the text that I'm not editing. I have the impression that the plugin is not doing anything (see screenshot).

INFO:
neovim: v0.5.1
plugins:

Plug 'folke/zen-mode.nvim'
Plug 'folke/twilight.nvim'
Plug 'neovim/nvim-lspconfig'
Plug 'nvim-treesitter/nvim-treesitter', {'do': ':TSUpdate'}

The command :PlugInstall has been runned succesfully and neovim was restarted.
Zen-mode and twilight are configure as follow:

I'm trying to edit a bash script while being in zen-mode:

what am I doing wrong?

[Feature request] Highlight the whole parent block

As the title says, it'd be cool to be able to get this plugin to ighlight the whole parent block entirely, instead of highliting the current code block from its start to the current line.

Auto dimming; not dimming other split/buffers

Is there a way to have twilight auto activate?

Is there away to make it so twilight does not dim inactive buffers / splits at all?

I have the value set to false but it leaves the area I last was highlighted.

[ Feature Request ] Dimmed areas with highlighting

I'd love to optionally have syntax highlighting preserved, but muted.

Error on startup

I get an error, on startup

my init.vim

bug: weird highlighting behaviour

Did you check docs and existing issues?

• I have read all the twilight.nvim docs
• I have searched the existing issues of twilight.nvim
• I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

v0.9.0-dev-e30cc8b

Operating system/version

MacOS 13.2.1

Describe the bug

Whenever I enable Twilight, this is how my editor looks:

As you can see, it dims many of the tokens outside of the focus area, but a lot stay as-is.

Here's a list of plugins I'm currently using:

  impatient-nvim
  gruvbox-flat-nvim
  which-key-nvim
  lualine-nvim
  nvim-web-devicons
  fidget-nvim
  telescope-nvim
  telescope-zf-native-nvim
  telescope-all-recent
  sqlite-lua
  neoscroll-nvim
  dressing-nvim
  nvim-notify
  gitsigns-nvim
  cmd-palette
  telescope-hop
  zen-mode-nvim
  twilight-nvim

It doesn't appear to be a problem with the colorscheme, as switching from gruvbox-flat to gruvbox-material shows the extract same thing happening (but with different colours, obviously):

Steps To Reproduce

n/a

Expected Behavior

n/a

Repro

n/a

Better Dimming with Markdown Files?

I am loving using Twilight, but I have noticed that in markdown files Twilight does not proper see the see the beginning or end of each block. For example here you can see it highlight two blocks instead of just one. Is there anything I can do to get it to only highlight one block?

laggy when using with zenmode

Using twilight outside zenmode works great, while in zenmode it's almost unable to use (I don't know whether it is it my potato computer's problem, really hope somebody can help because I really like this plugin (also zenmode))

Error on running twilight

I really enjoy using zen-mode with this plugin when writing markdown files. But after a recent update, I got the following error:

Error detected while processing WinScrolled Autocommands for "*":
E5108: Error executing lua /usr/share/nvim/runtime/lua/vim/treesitter/language.lua:25: no parser for 'markdown' language, see :help treesitter-parsers

By the way, I'm running nightly neovim.

Mistake in Readme.md?

I'm not sure if this is a mistake or not.
But in the configuration is written todo comes with the following defaults

Feature request: highlight x lines above and y lines below, w/o treesitter

Hi there,

it would be great if there way a way to use this plugin w/o treesitter, just highlighting eg the current line. I am currently using limelight for that (see my config below), but I would like to use this plugin instead...

let g:limelight_bop = '^'
let g:limelight_eop = '$'

[Feature request] Highlight current block entirely

As the title says, it'd be cool to be able to get this plugin to ighlight the whole parent block entirely, instead of highliting the current code block from its start to the current line.

[Feature Request] Way to not dim comment above function

my setup for twilight is pretty basic, just highlight the current function

require("twilight").setup {
	expand = {
		"function_definition",
	},
}

I would like to not dim the comment above my functions

is this achievable in some way? if not, perhaps a neighbour match, when I matches a node from 'expand', it tries to expand more with a 'expand_neighbour', or a dim blacklist, I wouldn't mind if my comments were not dimmed.

[Feature Request] Always highlight entire function when within the function

Great plugin!

Is there a way to always keep the entire function highlighted when within the function?

If yes, is there a way to easily toggle that option without changing my init file and restarting?

Background is black when using guibg=NONE

This is how it looks without guibg=NONE:

and here's how it looks with it:

(I use this option to set vim's bg to my terminal's, in case there's a better way of doing this)

Match first node for expand options.

Current Behaviour:
Currently, when you have nodes to expand to in your twilight config, twilight will expand to whatever the outer most one is. That is, say I have my expand to expand to conditionals, loops, methods, and classes, then I have some code that looks like this.

class Foo:
    def bar():
        if condition:
            var = expression
            for i in collection:
                # do things

Say I have my cursor on line 4, it will highlight every single line of code because it matches to the outermost node, that being the class.

Desired Behaviour:
I'd like it to match to innermost scope/node and no further. That is, if we have the above example, I'd want it to highlight only the conditional. If I had my cursor on line 6 I'd want it to highlight only the for loop.

Ideally, it would do this from within the block but not on the block declaration itself. This means that if I had my cursor on line 3, it's on the conditional line but it considers it considers the closest inner node as the one just above, that being the method. It also prevents annoying cases where you have a one-liner if statement or things like that.

Random nvim (nightly) crashes when started in a empty buffer

Hi when using with neovim 0.6 release

NVIM v0.6.0-dev+402-g655e489e9
Build type: RelWithDebInfo
LuaJIT 2.1.0-beta3

along with

if !exists("g:twilight_autocommands")
     let g:twilight_autocommands=1
     augroup twilight_mode
         autocmd InsertEnter * :TwilightEnable
         autocmd InsertLeave * :TwilightDisable
     augroup END
endif

When creating a new file or empty buffer and trying to enter insert mode, I get a SIGEV in the neovim process, disabling the autocommand snippet resolved my issue. Until few days ago (3 or 4 days),
I did not have this kind of problem.

Is this the right place to open the issue?

Regards,
Lucas

Intend Line highlighting

How do I get the intend lines to highlight like in the example?

[Feature request] Better document how to customize which text should be visible

I don't understand how Twilight decides which text should be visible, or how to customize it. I use it with Python + Treesitter, and here's an example of how it works:

I would like it to always expand to include the nearest parent function definition, or the nearest parent class definition if I'm not currently inside a function definition.

It sounds like, based on this:

expand = { -- for treesitter, we we always try to expand to the top-most ancestor with these types
"function",
"method",
"table",
"if_statement",
},

That it already should try to include the entire function definition, but it doesn't. It also sounds like based on this:

context = 10, -- amount of lines we will try to show around the current line

That it should show at least 10 lines above/below the current line, but it doesn't do that either. In the screenshot, it only shows 1 line above the current line.

I would really love some more in-depth documentation so I can customize which text is visible.

Highlighting the current function

I want to highlight all I the current function,Regardless of the cursor in the function and where

actual effect:

expect effect:

Can't enable plugin

I am new to lua in vim, but done all things like described in README, not working any way.
I also install zen-mode, which works fine. So, just want to get, what I'm done wrong?

[Feature Request]: Second/Additional non-dimmed area that follows the mouse

When working with this plugin on, I find it quite uncomfortable if I am looking for a specific piece of code nearby in the not highlighted areas ...
I'd love for the cursor-area to stay highlighted and the rest to stay dimmed as is right now, but additionally I'd love to see the feature of an additional (optional) highlighted area that doesn't follow the cursor but the mouse.
I guess this would probably not be much work for you and I think it would be super-useful -
you see: I find myself pointing to the area (more or less) where I'm looking for something anyway, so if that highlight would follow the mouse cursor, that would be so awesome. (while the area round the cursor stays highlighted as well - any way)

Imagine for example in a split buffer, you got the cursor in one buffer and quickly want to double check something in one of the other buffers ... need to switch off/toggle the plugin for a sec => oh, but not so, no, you just hover with the mouse that other section in that other buffer and there's the other highlight following that mouse-cursor, yeah!

bug: Dim Inlay Hints

Did you check docs and existing issues?

• I have read all the twilight.nvim docs
• I have searched the existing issues of twilight.nvim
• I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

0.9.2

Operating system/version

OpenSuse TumbleWeed

Describe the bug

Forgive me if this is beyond the control of Twilight, but I noticed that type hints in rust projects are not dimmed when using Rust-tools. (They are rendered using virtual text)

Steps To Reproduce

1. Open a project in Rust with rust-tools attached
2. Use Twilight

Expected Behavior

Inlay hints on non-highlighted lines will be dimmed as well

Repro

No response

Suggestion: integration with nvim-ts-rainbow

Awesome plugin 🎉

Would be great if colored brackets from nvim-ts-rainbow could be disabled in the dimmed regions. At the moment it looks as follows for me:

Highlight line under cursor

How would you highlight the line under the cursor and dim everything else?

[ Feature Request ] Focus only active window

The plugin should only highlight the context in the current window and dim text in all other windows

Setting to enable it by default

Is there a setting to enable it by default?

Lagging a lot while moving horizontally

lag_twilight.mp4

It lags a lot after a few seconds of Twilight being ON.

Toggle per window rather than globally

Great plugin thanks! Is it possible to toggle this per window or split rather than for all windows?