This repository has been archived by the owner. It is now read-only.
A symbol outline for Visual Studio Code
Switch branches/tags
Nothing to show
Clone or download
Latest commit 4a9fd32 Jul 11, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode Initial commit Jun 9, 2017
resources Provide a standalone viewlet May 9, 2018
src Fix #127 May 16, 2018
test Initial commit Jun 9, 2017
.gitignore Initial commit Jun 9, 2017
.vscodeignore Initial commit Jun 9, 2017
CHANGELOG.md Fix #127 May 16, 2018
LICENSE Add license Apr 6, 2018
README.md Update README.md Jul 11, 2018
package-lock.json Update vscode dep May 16, 2018
package.json Update vscode dep May 16, 2018
tsconfig.json Initial commit Jun 9, 2017

README.md

Code Outline tree provider for Visual Studio Code

⚠️ DEPRECATED. Please use the Outline view that comes with Visual Studio Code.

Features

Displays a code outline tree in the explorer pane.

To activate find and expand the "Code Outline" section near the bottom of the Explorer tab.

Language Support

For the outline to work, the language support plugins need to support symbol information.

For the outline to form a tree structure, the language support plugins need to report the entire definition range as part of symbol.

See VS Code issue #34968 and language server protocol issue #132 for a discussion.

Here is a list of languages known to work with Code Outline:

Language/Format Extension
C C/C++
C++ C/C++, cquery
Docker Docker
HTML Comes with VS Code
Go Go
Java Language Support for Java(TM) by Red Hat
JavaScript Comes with VS Code
JSON Comes with VS Code
Markdown Comes with VS Code
Perl Perl
PHP PHP Symbols
Powershell PowerShell
Python Python
Rust Rust (rls)
TypeScript Comes with VS Code
YAML YAML Support by Red Hat

Please report any missing extensions and I'll update the list.

Extension Settings

Default settings:

{
  "symbolOutline.doSort": false,
  "symbolOutline.sortOrder": [
    "Class",
    "Module",
    "Constant",
    "Interface",
    "*",
    "Constructor",
    "Function",
    "Method"
  ],
  "symbolOutline.expandNodes": [
    "Module",
    "Class",
    "Interface",
    "Namespace",
    "Object",
    "Package",
    "Struct"
  ],
  "symbolOutline.topLevel": [
    "*"
  ]
}
  • doSort: sort the outline.
  • expandNodes: kinds of nodes to be expanded automatically.
  • sortOrder: order to the sort symbols.
  • topLevel: wich symbols include at the topmost scope.

Known Issues

Depending on other extensions you have installed the symbol list may initially return an empty list. Use the "Refresh" button next to the title to fix this.