foambubble / foam

A personal knowledge management and sharing system for VSCode
https://foambubble.github.io/
Other
15.42k stars 661 forks source link

Bidirectional links as code comments in non-markdown files? #1307

Open Nezteb opened 11 months ago

Nezteb commented 11 months ago

Is your feature request related to a problem? Please describe.

I often have a problem visualizing codebases and how a request travels through an application during its lifecycle. I'll usually map out this sort of thing on paper or a whiteboard, but I'd also like to be able to add annotation/comment metadata to my code that allows easy editor integration.

Essentially I want my normal code to be part of my PKM tool as a first-class citizen.

Describe the solution you'd like

Initially I did a brain dump of an idea for an entirely separate extension for this functionality, but I think a tool like Foam is uniquely placed to (potentially) support this. 😄

Essentially I just want Foam to be able to add wiki-style links between any text files.

The easiest and least-intrusive way to do this seems like some sort of config for including/excluding specific directories or file extensions to parse for wiki comments.

Describe alternatives you've considered

There are some other extensions similar to Foam, but all of them are meant to only work with Markdown notes, not code.

Screenshots or Videos

No response

riccardoferretti commented 11 months ago

I haven't tried it, but if you treat code as "notes", Foam will recognize the [[wikilink]] syntax. Given it doesn't interfere with most languages (that I can think of), I wonder if you might just be able to pull it off. Look for the setting "Files: Notes Extensions" and add the ones for the codebase (e.g. js ts py)