add preview for ALEFindReferences (#5001)

* add preview for ALEFindReferences
* ALEFindReferences: add -contents options and g:ale_references_show_contents option to configure default behaviour
* tests: add tests for ALEFindReferences -contents feature
* tests: update tsserver references tests with show_contents args
This commit is contained in:
bretello
2025-08-13 15:21:48 +02:00
committed by GitHub
parent c74b917648
commit 7df94447c1
3 changed files with 212 additions and 13 deletions

View File

@@ -2270,6 +2270,16 @@ g:ale_popup_menu_enabled
This setting must be set to `true` or `1` before ALE is loaded for this
behavior to be enabled. See |ale-lint-settings-on-startup|.
*ale-options.references_show_contents*
*g:ale_references_show_contents*
references_show_contents
g:ale_references_show_contents
Type: |Boolean| or |Number|
Default: true
If set to `true` or `1`, matches found by `:ALEFindReferences` will be
shown with a preview of the matching line.
*ale-options.rename_tsserver_find_in_comments*
*g:ale_rename_tsserver_find_in_comments*
rename_tsserver_find_in_comments
@@ -4065,10 +4075,14 @@ documented in additional help files.
`:ALEFindReferences -split` - Open the location in a horizontal split.
`:ALEFindReferences -vsplit` - Open the location in a vertical split.
`:ALEFindReferences -quickfix` - Put the locations into quickfix list.
`:ALEFindReferences -contents` - Show line contents for matches.
The default method used for navigating to a new location can be changed
by modifying |g:ale_default_navigation|.
The default behaviour on whether to show line content for matches can
be changed by modifying |g:ale_references_show_contents|.
You can add `-relative` to the command to view results with relatives paths,
instead of absolute paths. This option has no effect if `-quickfix` is used.