search

StarlaneStudios / vscode-comment-anchors

⚓A Visual Studio Code extension that adds support for comment anchors 🔭
https://marketplace.visualstudio.com/items?itemName=ExodiusStudios.comment-anchors
MIT License
206 stars 32 forks source link

Option to show cursor location among anchors #122

Closed sloganking closed 3 years ago

sloganking commented 3 years ago

While the comment anchors sidebar provides a nice overview of how a file's code is organized, it does not display the current location of the user's cursor relative to the comment anchors. In order for the user to find out what part of the code they are inside of, they must scroll up until they see a comment anchor, and then find that comment anchor's comment name inside the comment anchors sidebar.

This issue proposes a toggle-able option that will inject a comment anchor icon for the user's cursor into the sidebar, and always unfold any sections necessary to display that icon in the sidebar. A button for this icon could be put next to the existing collapse all button.

Here are some visual examples using a REVIEW anchor in place of the proposed automated USER anchor.

Visually, this issue proposes the USER anchor look like the above images, except that the REVIEW text would either be dropped or replaced by USER and the green anchor would be replaced by a more traditional user icon. Similar to the image below.

macjuul commented 3 years ago

Hey!

I've gone ahead and implemented your suggestion, I hope it's as you expected it to be!

Thanks!

image

sloganking commented 3 years ago

@macjuul Thanks for the speedy response, that looks great! I'd like to verify this change's behavior, however the latest commit I can see in this repo is from 7 days ago. Is there a way I can try out this fix now, or will I need to wait until this change is merged into the live extension?

sloganking commented 3 years ago

I see this fix has now been put in https://github.com/ExodiusStudios/vscode-comment-anchors/commit/d5741ae9aab18f8d98c0408c66512565e4562749 and is contained in release 1.9.4 . Ending this discussion for now.