Navigation Helper

Trace codes easily with recording lines in files of each track in Visual Studio Code!

ext install navigation-helper

Background

Developers offen trace codes back and forth with many files opened in the editor.
But it's hard to remember all those files belong to which track you're tracing.
Especially, you're tracing multiple tracks and those files are in the same project folder.

For exmaple, for tracing Bug 111, you may open several files like File 1, File 3 ... etc and do the study.
Then, suddenly you get a ticket about Bug 112 with high priority, then you open File 3,File 2 and File 22 to trace the root cause.
Also, you might have Feature 11 and Feature 12 in the sprint backlog...

The following image illustrates the related files of each track (Bug 111,Bug 112,Feature 11 and Feature 12)

• It's tedious to record the related files manully on paper.
• It's time-consuming to navigate to those files, if you write down it on paper.

Concept

This extension helps you organize the file list into track-based in the editor.
We called Bug 111 as a Track, and called File 1, File 3 ... etc as a History.

Highlight

1. Record related files (History) into track-based file lists.
2. Add/Delete related files (History) into/from a track with ease.
3. Use Quick Pick Selecter to show related files of a track, and easy to navigate to them
4. Use Quick Pick Selecter to show tracks, and easy to switch between them

Demo

1. Add a file (History) into current Track

Press cmd+m (ctrl+m), You can see the Save to [ Track 0 ] message on status bar.
also if you've selected the words before press the cmd+m (ctrl+m). it will be record too.

The following image illustrates what the demo did.

2. Show the recorded files (History) in current Track

Press cmd+h (ctrl+h), and select the file you like, then navigate to it. The status bar shows current Track [ Track 0 ]

3. Rename the current Track

Press cmd+shift+, (ctrl+shift+,), and input the track name you like

The following image illustrates what the demo did.

4. Switch to another Track

Press cmd+shift+m (ctrl+shift+m), and select the track you like, then switch to it
The status bar shows current Track is changed to[ Track 3 ]

The following image illustrates what the demo did.
When you press cmd+h(ctrl+h) There would be an empty list in [ Track 3 ] now.

5. Clear a file (History) from current Track

Press f1 and input Navigation Helper: Clear One History From Current Track
, and select the history you would like to delete.

The following image illustrates what the demo did.

6. Clear all files (History) from current Track

Press f1 and input Navigation Helper: Clear All History From Current Track

The following image illustrates what the demo did.

7. Clear all files (History) from all Tracks

Press f1 and input Navigation Helper: Clear All History From All Tracks

The following image illustrates what the demo did.

Custom Keybinding

You can also set custom shortcuts in keybindings.json via Code => Preferences => Keyboard Shortcuts
For example:

Add a file (History) into current Track

[
    { "key": "cmd+m",//set to your favorite shortcut
      "command": "extension.saveToTrack",
      "when": "editorTextFocus" }
]

Show the recorded files (History) in current Track

[
    { "key": "cmd+h",//set to your favorite shortcut
      "command": "extension.showCurrentTrackHistory",
      "when": "editorTextFocus" }
]

Rename the current Track

[
    { "key": "cmd+shift+,",//set to your favorite shortcut
      "command": "extension.editCurrentTrackName",
      "when": "editorTextFocus" }
]

Switch to another Track

[
    { "key": "cmd+shift+m",//set to your favorite shortcut
      "command": "extension.changeTrack",
      "when": "editorTextFocus" }
]

Clear a file (History) from current Track

[
    { "key": "set to your favorite shortcut",//set to your favorite shortcut
      "command": "extension.clearOneHistoryFromCurrentTrack",
      "when": "editorTextFocus" }
]

Clear all files (History) from current Track

[
    { "key": "set to your favorite shortcut",//set to your favorite shortcut
      "command": "extension.clearAllHistoryFromCurrentTrack",
      "when": "editorTextFocus" }
]

Clear all files (History) from all Tracks

[
    { "key": "set to your favorite shortcut",//set to your favorite shortcut
      "command": "extension.clearAllHistoryFromAllTracks",
      "when": "editorTextFocus" }
]

Issues

Please submit issues to navigation-helper

Enjoy!