https://github.com/savetheclocktower/symbols-view-redux
Work-in-progress refactor of Pulsar's `symbols-view` package
https://github.com/savetheclocktower/symbols-view-redux
Last synced: 8 months ago
JSON representation
Work-in-progress refactor of Pulsar's `symbols-view` package
- Host: GitHub
- URL: https://github.com/savetheclocktower/symbols-view-redux
- Owner: savetheclocktower
- Created: 2023-04-30T23:07:11.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-03T01:24:05.000Z (over 2 years ago)
- Last Synced: 2025-02-26T17:55:15.882Z (over 1 year ago)
- Language: JavaScript
- Size: 226 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# symbols-view-redux
A refactor of `symbols-view`.
This is, in all likelihood, a temporary package; the code here will be contributed back to `symbols-view` unless it’s too disruptive.
## Design
[Design document is here](https://gist.github.com/savetheclocktower/be378d52fd9c6c09fd42af3bfb01b83e).
## Usage
* Install this package.
* Install any number of symbol providers (see below).
* If key shortcuts still invoke the old `symbols-view`, you may want to disable it.
## Providers
### Exclusive providers
More than one of these can (and should) be installed, but every request for symbols will choose one of these providers at most:
* [symbol-provider-tree-sitter](https://web.pulsar-edit.dev/packages/symbol-provider-tree-sitter): Uses Tree-sitter queries to identify symbols.
* [symbol-provider-ctags](https://web.pulsar-edit.dev/packages/symbol-provider-ctags): Uses `ctags` to identify symbols. (The built-in `symbols-view` package uses this approach.)
### Supplementary providers
Any number of these providers can be installed, and each one can optionally contribute symbols to any request for symbols. These tend to be specialized and to contribute symbols that an exclusive provider would not:
* [symbol-provider-bookmarks](https://web.pulsar-edit.dev/packages/symbol-provider-bookmarks): Represents bookmarks as file symbols.