Comment Links

Comment Links allows you to link to other files in your workspace inside of comments. This can help with documentation by linking functions, tracing mutated data, utilities, and anywhere you can provide context.

Description

Allows you to link to any file in your workspace with comment links. Use (text)[relative or absolute file path:line] structure to link to a file. You can choose to link to a particular line or not.

Usage

• // (componentFunction)[./Components/CoolComponent.js] // link to a file
• // (specificFunction)[./Components/CoolComponent.js:50] // link to a file at a particular line
• // (rootComponent)[../../src/App.js:88] // links can evaluate based on your current directory

Ctrl+click or Command+click (on Mac) on the underlined text to quickly navigate to your file directory

• // This is a comment with a (link) <----------- if there is a link, it will have an underline according to your vscode default link settings.

Known Issues

• Tooltips may show pop up with links that do not evaluate to anything, please only ctrl+click on the underlined text in the parenthesis

Release Notes

Initial release! Will continue fixing bugs and adding features soon.

1.0.0

Initial release

Enjoy!