pulsar/packages/symbols-view
Andrew Dupont 86cb072c54 [symbols-view] Ensure query field contents are initially selected…
…when `prefillSelectedText` is `true` and the editor has selected text when a `SelectListView` is opened.
2024-03-10 14:09:30 -07:00
..
keymaps [symbols-view] Remap go-to-declaration commands on Windows/Linux 2024-02-15 14:23:41 -08:00
lib [symbols-view] Ensure query field contents are initially selected… 2024-03-10 14:09:30 -07:00
spec [symbols-view] Ensure query field contents are initially selected… 2024-03-10 14:09:30 -07:00
styles Align icons better alongside symbol names 2024-01-28 23:43:21 -08:00
.eslintrc.js Add symbol provider packages 2024-01-03 10:26:17 -08:00
package.json [symbols-view] Implement “prefill with selected text” 2024-01-29 00:53:42 -08:00
README.md First attempted import of symbols-view 2024-01-03 10:26:17 -08:00

symbols-view

Display a list of symbols in the editor. Typically, a symbol will correspond to a meaningful part of a source code file (like a function definition) but can refer to other important parts of files depending on context.

Providers

symbols-view uses a provider/subscriber model similar to that of autocomplete-plus. This package implements the UI, but it relies on other packages to suggest symbols.

Built-in providers

The original symbol provider, ctags, now lives in its own provider package called symbol-provider-ctags. Another package, symbol-provider-tree-sitter, is the preferred provider (by default) in buffers that use a Tree-sitter grammar.

Community package providers

Any package can act as a symbol provider. These are the packages on the Pulsar Package Repository that provide the symbol.provider service.

Commands

Command Description Keybinding (Linux/Windows) Keybinding (macOS)
symbols-view:toggle-file-symbols Show all symbols in current file ctrl-r cmd-r
symbols-view:toggle-project-symbols Show all symbols in the project ctrl-shift-r cmd-shift-r
symbols-view:go-to-declaration Jump to the symbol under the cursor ctrl-alt-down cmd-alt-down
symbols-view:return-from-declaration Return from the jump ctrl-alt-up cmd-alt-up
symbols-view:show-active-providers Display a list of all known symbol providers

Commands relating to project-wide symbols may fail if no provider can satisfy a request for project-wide symbols. See symbol-provider-ctags for more information.