feat: Line numbers next to symbols for quick jumping
See reasoning in: simrat39/symbols-outline.nvim#212 This feature is turned off by default to avoid clutter, and many users might not want this feature on by default.
This commit is contained in:
60
README.md
60
README.md
@@ -80,7 +80,7 @@ features:
|
||||
|
||||
## Features
|
||||
|
||||
[Skip this section](#symbols-outlinenvim)
|
||||
[Skip to plugin readme](#symbols-outlinenvim)
|
||||
|
||||
Below is a list of features I've included in this fork which, at the time of
|
||||
writing, has not been included upstream (in the original repo). I try my best to
|
||||
@@ -99,6 +99,11 @@ Features/Changes:
|
||||
- simrat39/symbols-outline.nvim#174
|
||||
- simrat39/symbols-outline.nvim#207
|
||||
|
||||
- Show line number of each symbol in outline window (see [recipes](#recipes)
|
||||
for a screenshot)
|
||||
- Fixed issues:
|
||||
- simrat39/symbols-outline.nvim#212
|
||||
|
||||
- Cursorline option for the outline window.
|
||||
|
||||
- Added function and command to show provider and outline window status,
|
||||
@@ -120,7 +125,7 @@ Screen recordings of some of the features is shown at the bottom of the readme.
|
||||
|
||||
## PRs
|
||||
|
||||
[Skip this section](#symbols-outlinenvim)
|
||||
[Skip to plugin readme](#symbols-outlinenvim)
|
||||
|
||||
Key:
|
||||
```
|
||||
@@ -128,6 +133,9 @@ Key:
|
||||
📮 = Planned for merge
|
||||
```
|
||||
|
||||
- 📮 center view on goto symbol
|
||||
(#239 by skomposzczet)
|
||||
|
||||
- ✅ Open handler checks if view is not already open
|
||||
(#235 by eyalz800)
|
||||
|
||||
@@ -206,7 +214,7 @@ Key:
|
||||
|
||||
## TODO
|
||||
|
||||
[Skip this section](#symbols-outlinenvim)
|
||||
[Skip to plugin readme](#symbols-outlinenvim)
|
||||
|
||||
Key:
|
||||
```
|
||||
@@ -215,8 +223,6 @@ Key:
|
||||
- : Idea
|
||||
```
|
||||
|
||||
Items will be moved to above list when complete.
|
||||
|
||||
- Folds
|
||||
- `[ ]` Org-like <kbd>shift+tab</kbd> behavior: Open folds level-by-level
|
||||
- `[ ]` Optionally not opening all child nodes when opening parent node
|
||||
@@ -238,7 +244,8 @@ Items will be moved to above list when complete.
|
||||
|
||||
- View
|
||||
- `[/]` Outline window customizations (simrat39/symbols-outline#137)
|
||||
- `[/]` Option to show line number next to symbols
|
||||
- ✅ Option to show line number next to symbols (simrat39/symbols-outline#212)
|
||||
- `[/]` Option to hide cursor in outline window if cursorline enabled
|
||||
|
||||
|
||||
## Related plugins
|
||||
@@ -259,6 +266,24 @@ Supports all your favourite languages.**
|
||||
|
||||

|
||||
|
||||
Table of contents
|
||||
|
||||
<!-- mtoc start -->
|
||||
|
||||
* [Prerequisites](#prerequisites)
|
||||
* [Installation](#installation)
|
||||
* [Setup](#setup)
|
||||
* [Configuration](#configuration)
|
||||
* [Terminology](#terminology)
|
||||
* [Options](#options)
|
||||
* [Commands](#commands)
|
||||
* [Lua API](#lua-api)
|
||||
* [Default keymaps](#default-keymaps)
|
||||
* [Highlights](#highlights)
|
||||
* [Recipes](#recipes)
|
||||
|
||||
<!-- mtoc end -->
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- `neovim 0.7+`
|
||||
@@ -388,6 +413,11 @@ local opts = {
|
||||
show_cursorline = true, -- Only in this fork
|
||||
-- Show extra details with the symbols (lsp dependent)
|
||||
show_symbol_details = true,
|
||||
-- Only in this fork.
|
||||
-- Show line numbers of each symbol next to them.
|
||||
-- Why? See this comment:
|
||||
-- https://github.com/simrat39/symbols-outline.nvim/issues/212#issuecomment-1793503563
|
||||
show_symbol_lineno = false,
|
||||
-- Highlight group for the preview background
|
||||
preview_bg_highlight = 'Pmenu',
|
||||
-- Depth past which nodes will be folded by default
|
||||
@@ -665,3 +695,21 @@ This feature was added by @stickperson in an upstream PR 🙌
|
||||
|
||||
https://github.com/hedyhli/symbols-outline.nvim/assets/50042066/3d06e342-97ac-400c-8598-97a9235de66c
|
||||
|
||||
|
||||
**Hide the extra details after each symbol name**
|
||||
|
||||
```lua
|
||||
show_symbol_details = false,
|
||||
```
|
||||
|
||||
**Show line numbers next to each symbol to jump to that symbol quickly**
|
||||
|
||||
```lua
|
||||
show_symbol_lineno = true,
|
||||
```
|
||||
|
||||
The default highlight group is `LineNr`.
|
||||
|
||||
<img width="900" alt="image" src="https://github.com/hedyhli/symbols-outline.nvim/assets/50042066/2bbb5833-f40b-4c53-8338-407252d61443">
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user