KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#typescript #ai-agents #developer-tools #cli #codex #claude-code #react #mcp #open-source #deepseek-harness #dsh-plugin #ai

nvim_context_vt

★ 415 Open GitHub ↗

Virtual text context for neovim treesitter

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# nvim_context_vt

Shows virtual text of the current context after functions, methods, statements, etc.

![nvim_context_vt](https://github.com/user-attachments/assets/e2c5d1ed-a4a4-4556-8d49-8a1cf2ed4f8b)

## How to install

Use your favourite package manager. No configuration is required out of the box.

Requires Neovim 0.11+ and treesitter enabled for the buffers you use it in.

## Advanced usage

To customize the behavior use the setup function:

```lua
require('nvim_context_vt').setup({
  -- Enable by default. You can disable and use :NvimContextVtToggle to maually enable.
  -- Default: true
  enabled = true,

-- Override default virtual text prefix
  -- Default: '-->'
  prefix = '',

-- Override default virtual text priority
  -- Default: 1000
  priority = 1000,

-- Override the internal highlight group name
  -- Default: 'ContextVt'
  highlight = 'CustomContextVt',

-- Disable virtual text for given filetypes
  -- Default: { 'markdown' }
  disable_ft = { 'markdown' },

-- Disable display of virtual text below blocks for indentation based languages like Python
  -- Default: false
  disable_virtual_lines = false,

-- Same as above but only for spesific filetypes
  -- Default: {}
  disable_virtual_lines_ft = { 'yaml' },

-- Never show virtual text for these node types
  -- Default: {}
  disable_targets = { 'call' },

-- Same as above but only for spesific filetypes
  -- Adds to the list above instead of replacing it
  -- Default: {}
  disable_targets_ft = { python = { 'if_statement' } },

-- How many lines required after starting position to show virtual text
  -- Default: 1 (equals two lines total)
  min_rows = 1,

-- Same as above but only for spesific filetypes
  -- Default: {}
  min_rows_ft = {},

-- Custom virtual text node parser callback
  -- Default: nil
  custom_parser = function(node, ft, opts)
    local utils = require('nvim_context_vt.utils')

-- If you return `nil`, no virtual text will be displayed.
    if node:type() == 'function' then
      return nil
    end

-- This is the standard text
    return opts.prefix .. ' ' .. utils.get_node_text(node)[1]
  end,

-- Custom node validator callback
  -- Default: nil
  custom_validator = function(node, ft, opts)
    -- Internally a node is matched against min_rows, the configured targets
    -- and the disabled targets
    local default_validator = require('nvim_context_vt.utils').default_validator
    if not default_validator(node, ft, opts) then
      return false
    end

-- Custom behaviour after using the internal validator
    return node:type() ~= 'function'
  end,

-- Custom node virtual text resolver callback
  -- Default: nil
  custom_resolver = function(nodes, ft, opts)
    -- By default the last node is used
    return nodes[#nodes]
  end,
})
```

## Commands

* `:NvimContextVtToggle` - Enable/disable context virtual text

## Debug

If you don't see the expected context vitual text, run `:NvimContextVtDebug` to print out the
context tree. Use this information to open a pull-request or an issue to add support.

## License

MIT

nvim_context_vt

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README