Skip to content

oleg-shilo/codemap.vscode

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
bin
 
 
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

stand with Ukraine

CodeMap - VSCode Extension

Interactive code map for quick visualization and navigation within code DOM objects (e.g. classes, members).


Github All Releases

paypal

Overview

This simple extension visualizes the code DOM objects defined in the active document. This extension is a for of the popular plugin that is available for:

The extension functionality is straight forward. Just click the code map item and it will trigger the navigation to the document where the corresponding code element is defined in the document.

Features:

  • Supported syntaxes:
    • C#
    • TypeScript
    • JavaScript
    • Python
    • Java
    • Erlang
    • Markdown
    • PowerShell
    • R
    • JSON
    • XML
    • SVG
    • XAML
    • TCL
    • VB.NET
    • PDL2 (Comau Robot Language)
  • Customization by adding support for new syntaxes via:
    • A generic mapper that is set of Regex expressions in user settings
    • A dedicated simple mapper JS script file.
  • Auto-refreshing code map on document change.
  • Navigation to code fragment associated with the clicked code map node.
  • Refreshing on demand via "Refresh" toolbar button a and VSCode command.

codemap_vscode.gif

Note, the latest releases of CodeMap place the plugin view in its own activitrybar:

image

Adding custom mappers

The most intriguing feature is the possibility to extend the plugin to support new and even more exotic syntaxes. Read more about the technique in this Wiki page.

If you create mapping rules or dedicated mapper and want to share it with others. Create a pull request or just log the corresponding issue on this project and I will consider including your mapper into the plugin package.

Limitations

  • The main objective of this plugin is not to provide the most accurate CodeDOM (syntax tree) presentation but rather to assist with the navigation to the most important points in your code. Thus the default mappers deliberately avoid high resolution code parsing (e.g. local variables).