sunmorgus / vscode-symbolexplorer

A simple vscode extension to provide and explorer view of the symbols in the active document.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Symbol Explorer

A simple vscode extension to provide an explorer view of the symbols in the active document.

Features

  • Views for Explorer, Debugger, and a separate Activity Bar view of it's own!
  • Lists all symbols in the active document
  • Sort symbols alphabetically (default sort order can be set in preferences)
  • Symbols are grouped by container (i.e. methods within a class are grouped under that class) (default state can be set in preferences)
  • Symbols update automatically when your document is saved
  • Refresh the list

Explorer View

screenshot

Activity Bar

screenshot

Configuration

  • vscode-symbolexplorer.showExplorer: Show or hide Symbol Explorer in Explorer View (defaults to true, requires window reload)
  • vscode-symbolexplorer.showExplorerDebug: Show or hide the Symbol Explorer in Debug View (defaults to false, requires window reload)
  • vscode-symbolexplorer.autoStart: Whether to auto-check for symbols on start up
  • vscode-symbolexplorer.autoStartDelay: Delay auto-start to allow language server to start
  • vscode-symbolexplorer.defaultSort: Choose default sort direction (none, asc, desc) for the symbols in the view
  • vscode-symbolexplorer.defaultState: Choose default state of parent symbols (expanded [default], collapsed)

Requirements

The only requirement is having a document open that supports symbols.

Known Issues

  • Code complexity scoring has only been tested on C# and may not yet work properly in other languages
  • Depending on what extension is providing the symbols for your file, you may have to hit the refresh button after the extension has finished loading (for instance, with the C# extension, once omnisharp has finished loading your project)
    • Adjusting the autoStartDelay setting can help with this

Contributions

Release Notes

See Changelog

Todo:

  1. Ability to reorganize you code with drag and drop
  2. Code complexity scoring for individual symbols
  3. Ability to group symbols with regions (if the current document supports regions)

About

A simple vscode extension to provide and explorer view of the symbols in the active document.


Languages

Language:TypeScript 100.0%