182 lines
8.3 KiB
Text
182 lines
8.3 KiB
Text
*fugitive-ts.nvim.txt* Treesitter highlighting for vim-fugitive diffs
|
|
|
|
Author: Barrett Ruth <br.barrettruth@gmail.com>
|
|
License: MIT
|
|
|
|
==============================================================================
|
|
INTRODUCTION *fugitive-ts.nvim*
|
|
|
|
fugitive-ts.nvim adds treesitter-based syntax highlighting to vim-fugitive
|
|
diff views. It overlays language-aware highlights on top of fugitive's
|
|
default regex-based diff highlighting.
|
|
|
|
==============================================================================
|
|
REQUIREMENTS *fugitive-ts-requirements*
|
|
|
|
- Neovim 0.9.0+
|
|
- vim-fugitive (https://github.com/tpope/vim-fugitive)
|
|
- Treesitter parsers for languages you want highlighted
|
|
|
|
==============================================================================
|
|
SETUP *fugitive-ts-setup*
|
|
|
|
Using lazy.nvim: >lua
|
|
{
|
|
'barrettruth/fugitive-ts.nvim',
|
|
dependencies = { 'tpope/vim-fugitive' },
|
|
opts = {},
|
|
}
|
|
<
|
|
The plugin works automatically with no configuration required. For
|
|
customization, see |fugitive-ts-config|.
|
|
|
|
==============================================================================
|
|
CONFIGURATION *fugitive-ts-config*
|
|
|
|
*fugitive-ts.Config*
|
|
Fields: ~
|
|
{enabled} (boolean, default: true)
|
|
Enable or disable highlighting globally.
|
|
|
|
{debug} (boolean, default: false)
|
|
Enable debug logging to |:messages| with
|
|
`[fugitive-ts]` prefix.
|
|
|
|
{debounce_ms} (integer, default: 0)
|
|
Debounce delay in milliseconds for re-highlighting
|
|
after buffer changes. Lower values feel snappier
|
|
but use more CPU.
|
|
|
|
{hide_prefix} (boolean, default: false)
|
|
Hide diff prefixes (`+`/`-`/` `) using virtual
|
|
text overlay. Makes code appear without the
|
|
leading diff character. When `highlights.background`
|
|
is also enabled, the overlay inherits the line's
|
|
background color.
|
|
|
|
{treesitter} (table, default: see below)
|
|
Treesitter highlighting options.
|
|
See |fugitive-ts.TreesitterConfig| for fields.
|
|
|
|
{vim} (table, default: see below)
|
|
Vim syntax highlighting options (experimental).
|
|
See |fugitive-ts.VimConfig| for fields.
|
|
|
|
{highlights} (table, default: see below)
|
|
Controls which highlight features are enabled.
|
|
See |fugitive-ts.Highlights| for fields.
|
|
|
|
*fugitive-ts.TreesitterConfig*
|
|
Treesitter config fields: ~
|
|
{enabled} (boolean, default: true)
|
|
Apply treesitter syntax highlighting to code.
|
|
|
|
{max_lines} (integer, default: 500)
|
|
Skip treesitter highlighting for hunks larger than
|
|
this many lines. Prevents lag on massive diffs.
|
|
|
|
*fugitive-ts.VimConfig*
|
|
Vim config fields: ~
|
|
{enabled} (boolean, default: false)
|
|
Use vim syntax highlighting as fallback when no
|
|
treesitter parser is available for a language.
|
|
Creates a scratch buffer, sets the filetype, and
|
|
queries |synID()| per character to extract
|
|
highlight groups. Slower than treesitter but
|
|
covers languages without a TS parser installed.
|
|
|
|
{max_lines} (integer, default: 200)
|
|
Skip vim syntax highlighting for hunks larger than
|
|
this many lines. Lower than the treesitter default
|
|
due to the per-character cost of |synID()|.
|
|
|
|
*fugitive-ts.Highlights*
|
|
Highlights table fields: ~
|
|
{background} (boolean, default: true)
|
|
Apply background highlighting to `+`/`-` lines
|
|
using `FugitiveTsAdd`/`FugitiveTsDelete` groups
|
|
(derived from `DiffAdd`/`DiffDelete` backgrounds).
|
|
|
|
{gutter} (boolean, default: true)
|
|
Highlight line numbers with matching colors.
|
|
Only visible if line numbers are enabled.
|
|
|
|
Note: Header context (e.g., `@@ -10,3 +10,4 @@ func()`) is always
|
|
highlighted with treesitter when a parser is available.
|
|
|
|
Language detection uses Neovim's built-in |vim.filetype.match()| and
|
|
|vim.treesitter.language.get_lang()|. To customize filetype detection
|
|
or register treesitter parsers for custom filetypes, use
|
|
|vim.filetype.add()| and |vim.treesitter.language.register()|.
|
|
|
|
==============================================================================
|
|
API *fugitive-ts-api*
|
|
|
|
setup({opts}) *fugitive-ts.setup()*
|
|
Configure the plugin with `opts`.
|
|
|
|
Parameters: ~
|
|
{opts} (|fugitive-ts.Config|, optional) Configuration table.
|
|
|
|
attach({bufnr}) *fugitive-ts.attach()*
|
|
Manually attach highlighting to a buffer. Called automatically for
|
|
fugitive buffers via the `FileType fugitive` autocmd.
|
|
|
|
Parameters: ~
|
|
{bufnr} (integer, optional) Buffer number. Defaults to current buffer.
|
|
|
|
refresh({bufnr}) *fugitive-ts.refresh()*
|
|
Manually refresh highlighting for a buffer. Useful after external changes
|
|
or for debugging.
|
|
|
|
Parameters: ~
|
|
{bufnr} (integer, optional) Buffer number. Defaults to current buffer.
|
|
|
|
==============================================================================
|
|
IMPLEMENTATION *fugitive-ts-implementation*
|
|
|
|
1. The `FileType fugitive` autocmd triggers |fugitive-ts.attach()|
|
|
2. The buffer is parsed to detect file headers (`M path/to/file.lua`) and
|
|
hunk headers (`@@ -10,3 +10,4 @@`)
|
|
3. For each hunk:
|
|
- Language is detected from the filename using |vim.filetype.match()|
|
|
- Diff prefixes (`+`/`-`/` `) are stripped from code lines
|
|
- Code is parsed with |vim.treesitter.get_string_parser()|
|
|
- Background extmarks (`FugitiveTsAdd`/`FugitiveTsDelete`) at priority 198
|
|
- `Normal` extmarks at priority 199 clear underlying diff foreground
|
|
- Treesitter highlights are applied as extmarks at priority 200
|
|
- Conceal extmarks hide diff prefixes when `hide_prefix` is enabled
|
|
4. Re-highlighting occurs on `TextChanged` (debounced) and `Syntax` events
|
|
|
|
==============================================================================
|
|
KNOWN LIMITATIONS *fugitive-ts-limitations*
|
|
|
|
Syntax Highlighting Flash ~
|
|
*fugitive-ts-flash*
|
|
When opening a fugitive buffer, there is an unavoidable visual "flash" where
|
|
the buffer briefly shows fugitive's default diff highlighting before
|
|
fugitive-ts.nvim applies treesitter highlights.
|
|
|
|
This occurs because fugitive-ts.nvim hooks into the `FileType fugitive` event,
|
|
which fires after vim-fugitive has already painted the buffer. Even with
|
|
`debounce_ms = 0`, the re-painting goes through Neovim's event loop.
|
|
|
|
To minimize the flash, use a low debounce value: >lua
|
|
require('fugitive-ts').setup({
|
|
debounce_ms = 0,
|
|
})
|
|
<
|
|
See https://github.com/barrettruth/fugitive-ts.nvim/issues/18 for discussion
|
|
and potential solutions.
|
|
|
|
==============================================================================
|
|
HEALTH CHECK *fugitive-ts-health*
|
|
|
|
Run |:checkhealth| fugitive-ts to verify your setup.
|
|
|
|
Checks performed:
|
|
- Neovim version >= 0.9.0
|
|
- vim-fugitive is installed
|
|
|
|
==============================================================================
|
|
vim:tw=78:ts=8:ft=help:norl:
|