docs(readme): mention vscode-diff algorithm and credit @esmuellert (#103)
## Problem The README doesn't mention the optional vscode-diff FFI backend for word-level intra-line accuracy, and the codediff.nvim acknowledgement doesn't credit the author by name. ## Solution Expand the intra-line feature bullet to mention vscode-diff with a link to codediff.nvim. Credit @esmuellert by name in the acknowledgements section. Also update the stale context padding reference in known limitations to match the current behavior.
This commit is contained in:
parent
35067151e4
commit
2d7d26a1bc
1 changed files with 10 additions and 7 deletions
17
README.md
17
README.md
|
|
@ -10,11 +10,13 @@ syntax highlighting.
|
|||
## Features
|
||||
|
||||
- Treesitter syntax highlighting in fugitive diffs and commit views
|
||||
- Character-level intra-line diff highlighting
|
||||
- Character-level intra-line diff highlighting (with optional
|
||||
[vscode-diff](https://github.com/esmuellert/codediff.nvim) FFI backend for
|
||||
word-level accuracy)
|
||||
- `:Gdiff` unified diff against any revision
|
||||
- Background-only diff colors for `&diff` buffers
|
||||
- Inline merge conflict detection, highlighting, and resolution
|
||||
- Vim syntax fallback, context padding, configurable blend/debounce
|
||||
- Vim syntax fallback, configurable blend/debounce/priorities
|
||||
|
||||
## Requirements
|
||||
|
||||
|
|
@ -38,10 +40,9 @@ luarocks install diffs.nvim
|
|||
## Known Limitations
|
||||
|
||||
- **Incomplete syntax context**: Treesitter parses each diff hunk in isolation.
|
||||
To improve accuracy, `diffs.nvim` reads lines from disk before and after each
|
||||
hunk for parsing context (`highlights.context`, enabled by default with 25
|
||||
lines). This resolves most boundary issues. Set
|
||||
`highlights.context.enabled = false` to disable.
|
||||
Context lines within the hunk (` ` prefix) provide syntactic context for the
|
||||
parser. In rare cases, hunks that start or end mid-expression may produce
|
||||
imperfect highlights due to treesitter error recovery.
|
||||
|
||||
- **Syntax flashing**: `diffs.nvim` hooks into the `FileType fugitive` event
|
||||
triggered by `vim-fugitive`, at which point the buffer is preliminarily
|
||||
|
|
@ -64,7 +65,9 @@ luarocks install diffs.nvim
|
|||
# Acknowledgements
|
||||
|
||||
- [`vim-fugitive`](https://github.com/tpope/vim-fugitive)
|
||||
- [`codediff.nvim`](https://github.com/esmuellert/codediff.nvim)
|
||||
- [@esmuellert](https://github.com/esmuellert) /
|
||||
[`codediff.nvim`](https://github.com/esmuellert/codediff.nvim) - vscode-diff
|
||||
algorithm FFI backend for word-level intra-line accuracy
|
||||
- [`diffview.nvim`](https://github.com/sindrets/diffview.nvim)
|
||||
- [`difftastic`](https://github.com/Wilfred/difftastic)
|
||||
- [`mini.diff`](https://github.com/echasnovski/mini.diff)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue