leigh/outline.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:hedyhli/symbols-outline.nvim

Browse Source
This commit is contained in:
hedy
2023-11-02 22:15:58 +08:00
parent af8e219dbb abc58a2cfb
commit e10d947572
1 changed files with 44 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
doc/symbols-outline.txt
View File

@@ -3,12 +3,12 @@
============================================================================== ==============================================================================
Table of Contents *symbols-outline-table-of-contents* Table of Contents *symbols-outline-table-of-contents*
1. ⚠️ NOTE: THIS IS A FORK |symbols-outline-⚠️-note:-this-is-a-fork| 1. Fork status |symbols-outline-fork-status|
- Maintenance status|symbols-outline-⚠️-note:-this-is-a-fork-maintenance-status| - Maintenance status |symbols-outline-fork-status-maintenance-status|
- 🛑 Breaking changes|symbols-outline-⚠️-note:-this-is-a-fork-🛑-breaking-changes| - Fixes |symbols-outline-fork-status-fixes|
- Features |symbols-outline-⚠️-note:-this-is-a-fork-features| - 🛑 Breaking changes |symbols-outline-fork-status-🛑-breaking-changes|
- Fixes |symbols-outline-⚠️-note:-this-is-a-fork-fixes| - Features |symbols-outline-fork-status-features|
- PRs |symbols-outline-⚠️-note:-this-is-a-fork-prs| - PRs |symbols-outline-fork-status-prs|
2. symbols-outline.nvim |symbols-outline-symbols-outline.nvim| 2. symbols-outline.nvim |symbols-outline-symbols-outline.nvim|
- Prerequisites |symbols-outline-symbols-outline.nvim-prerequisites| - Prerequisites |symbols-outline-symbols-outline.nvim-prerequisites|
- Installation |symbols-outline-symbols-outline.nvim-installation| - Installation |symbols-outline-symbols-outline.nvim-installation|
@@ -20,11 +20,12 @@ Table of Contents *symbols-outline-table-of-contents*
- Recipes |symbols-outline-symbols-outline.nvim-recipes| - Recipes |symbols-outline-symbols-outline.nvim-recipes|
============================================================================== ==============================================================================
1. ⚠️ NOTE: THIS IS A FORK *symbols-outline-⚠️-note:-this-is-a-fork* 1. Fork status *symbols-outline-fork-status*
This is a fork of the original symbols-outline.nvim which merges some selected This is a fork of the original symbols-outline.nvim which fixes a lot of bugs
PRs from the original repo, plus some other improvements due to personal from the original repo.
preferences.
It also adds many more features listed |symbols-outline-below|.
It does not attempt to be an up-to-date successor of the original repo, nor It does not attempt to be an up-to-date successor of the original repo, nor
does it attempt to ensure everyone’s use-cases are satisfied by providing an does it attempt to ensure everyone’s use-cases are satisfied by providing an
@@ -32,7 +33,7 @@ overall better experience. It is merely a fork which I maintain for my personal
use-cases which incorporates some selected PRs. use-cases which incorporates some selected PRs.
MAINTENANCE STATUS*symbols-outline-⚠️-note:-this-is-a-fork-maintenance-status* MAINTENANCE STATUS *symbols-outline-fork-status-maintenance-status*
This fork is NOT guaranteed to be completely bug-free, nor as stable as the This fork is NOT guaranteed to be completely bug-free, nor as stable as the
original. However, since I use this plugin myself, it is guaranteed that original. However, since I use this plugin myself, it is guaranteed that
@@ -42,19 +43,40 @@ ability).
I do not merge PRs from the original repo that I don’t personally need. I do not merge PRs from the original repo that I don’t personally need.
- **DO use this fork if**: - **DO use this fork if**:
- You want to use features available in this fork, which are not included - You want to use to bugfixes included in this fork, including `auto_preview`,
upstream (listed below) and others listed in |symbols-outline-fixes|
- You MIGHT want some up-to-date fixes to problems (that I also face) but is - You want to use |symbols-outline-features| available in this fork, which are not
OK with some things not being looked after well (things I don’t personally use) included upstream
- You are OK with some things not being looked after well such as CoC support
(things I don’t personally use)
- **Do NOT use this fork if**: - **Do NOT use this fork if**:
- You want a stable plugin - You want a stable plugin
- You don’t need the extra features in this fork - You don’t need the extra features in this fork
- You do not need the bugfixes in this fork
🛑 BREAKING CHANGES*symbols-outline-⚠️-note:-this-is-a-fork-🛑-breaking-changes* FIXES *symbols-outline-fork-status-fixes*
- **Config**: `keymaps.focus_location` -> `keymaps.peek_location` to avoid - Symbol preview empty (simrat39/symbols-outline.nvim#176)
confusion with focus window commands. - `SymbolsOutlineClose` crashing when already closed: simrat39/symbols-outline.nvim#163
- Symbols not showing by supporting Nerd fonts v3.0: simrat39/symbols-outline.nvim#225
- Newlines in symbols crash: simrat39/symbols-outline.nvim#204 (simrat39/symbols-outline.nvim#184)
- `code_actions`: simrat39/symbols-outline.nvim#168 (simrat39/symbols-outline.nvim#123)
- Fold all operation too slow: simrat39/symbols-outline.nvim#223 (simrat39/symbols-outline.nvim#224)
- "Invalid buffer id" error simrat39/symbols-outline.nvim#177
- Open handler triggering multiple times ends up in messy state with errors
simrat39/symbols-outline.nvim#235
🛑 BREAKING CHANGES *symbols-outline-fork-status-🛑-breaking-changes*
This section may be relevant to you if your existing config uses the mentioned
features:
- **Config**: `keymaps.focus_location` RENAMED to `keymaps.peek_location` to
avoid confusion with focus window commands.
- **Config**: Marker icons used for guides can now be customized. `show_guides`
REMOVED in favor of `guides.enabled`.
- **Behaviour**: Removed hover floating window from `toggle_preview`. - **Behaviour**: Removed hover floating window from `toggle_preview`.
- Instead, you can set `open_hover_on_preview=true` (true by default) so that - Instead, you can set `open_hover_on_preview=true` (true by default) so that
the `hover_symbol` action can be triggered when `toggle_preview`is the `hover_symbol` action can be triggered when `toggle_preview`is
@@ -63,8 +85,6 @@ I do not merge PRs from the original repo that I don’t personally need.
third). This is planned to be configurable. third). This is planned to be configurable.
- The preview window is positioned to be vertically center-aligned (rather - The preview window is positioned to be vertically center-aligned (rather
than fixed to the top). This is planned to be configurable. than fixed to the top). This is planned to be configurable.
- **Config**: Marker icons used for guides can now be customized. `show_guides`
removed in favor of `guides.enabled`.
- **Behaviour**: When `auto_close=true` only auto close if `goto_location` is - **Behaviour**: When `auto_close=true` only auto close if `goto_location` is
used (where focus changed), and not for `focus_location` used (where focus changed), and not for `focus_location`
(simrat39/symbols-outline.nvim#119). (simrat39/symbols-outline.nvim#119).
@@ -72,7 +92,7 @@ I do not merge PRs from the original repo that I don’t personally need.
some delay. Now preview is shown instantly every time the cursor moves. some delay. Now preview is shown instantly every time the cursor moves.
FEATURES *symbols-outline-⚠️-note:-this-is-a-fork-features* FEATURES *symbols-outline-fork-status-features*
Below is a list of features I’ve included in this fork which, at the time of 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 writing, has not been included upstream (in the original repo). I try my best
@@ -96,20 +116,7 @@ Features/Changes:
- Flash highlight when using goto/peek location. - Flash highlight when using goto/peek location.
FIXES *symbols-outline-⚠️-note:-this-is-a-fork-fixes* PRS *symbols-outline-fork-status-prs*
- Symbol preview (simrat39/symbols-outline.nvim#176)
- `SymbolsOutlineClose` crashing when already closed: simrat39/symbols-outline.nvim#163
- Symbols not showing by supporting Nerd fonts v3.0: simrat39/symbols-outline.nvim#225
- Newlines in symbols crash: simrat39/symbols-outline.nvim#204 (simrat39/symbols-outline.nvim#184)
- `code_actions`: simrat39/symbols-outline.nvim#168 (simrat39/symbols-outline.nvim#123)
- Fold all operation too slow: simrat39/symbols-outline.nvim#223 (simrat39/symbols-outline.nvim#224)
- "Invalid buffer id" error simrat39/symbols-outline.nvim#177
- Open handler triggering multiple times ends up in messy state with errors
simrat39/symbols-outline.nvim#235
PRS *symbols-outline-⚠️-note:-this-is-a-fork-prs*
Key: Key:
@@ -179,6 +186,8 @@ RELATED PLUGINS ~
- nvim-navbuddy - nvim-navbuddy
- dropdown.nvim - dropdown.nvim
- treesitter (inspect/edit) - treesitter (inspect/edit)
- lspsaga
- navigator.lua
------------------------------------------------------------------------------ ------------------------------------------------------------------------------