Generate markdown summary without saving a file

thamara / vscode-code-annotation

Code Annotation Extension for VSCode

https://marketplace.visualstudio.com/items?itemName=tkcandrade.code-annotation

GNU General Public License v3.0

67 stars 27 forks source link

Generate markdown summary without saving a file #7

Closed thamara closed 3 years ago

thamara commented 4 years ago

generateMarkdownReport on reporting.ts generates the file only if a workspace is defined. This should be replaced by a virtual file, and the user can choose where to save it.

taismassaro commented 3 years ago

hi @thamara, I'd like to give this a try but have never developed a vscode extension 😁 could you give me some insights on where to start? I'm assuming this would be useful documentation?

also, thanks a lot for the effort you're putting into your repositories for hacktoberfest! it's really motivating! ✨ (too bad I'm usually too late and most issues have already been claimed)

thamara commented 3 years ago

Sure! Go ahead! This is also my first vscode extension, so I'm learning too. hahahaha This link is indeed good documentation, besides this, I usually go around GitHub looking for places where this is used (it helps if you already know of an extension that does this, but searching the code works well too). This is what I've been doing. This might also be a good approach. My idea behind this is not to "invade" the user's workspace by automatically saving the file, but at the same time, it would be really good if the user could easily save it just like opening a new file in VSCode.

And thank you a lot for the feedback <3 Also, feel free to suggest any change that is not captured in the issues yet, this way you have priority :D

taismassaro commented 3 years ago

@thamara I'm getting this when clicking on the summary button both locally and on the extension installed via the .vsix file. do I need to do anything specific to create a workspace? always thought it was just a project folder.

unrelated to this issue: when I started going through the code and vscode documentation I came across the command.category and thought that might be a better solution instead of writing Code Annotation before the title for each command. that way, the Code Annotation prefix only shows up when using the command palette, but not as the name of each button in the panel, which in my opinion makes it look a bit cleaner.

package.json

do you think it makes sense? if yes, would it be ok for me to open a PR for this change? :)

thamara commented 3 years ago

@thamara I'm getting this when clicking on the summary button both locally and on the extension installed via the .vsix file. do I need to do anything specific to create a workspace? always thought it was just a project folder.

Hmm, that's strange. Let me confirm and get back to you.

do you think it makes sense? if yes, would it be ok for me to open a PR for this change? :)

Yes! Absolutally. I didn't know that existed. A PR for this would be more than welcome!

tim3w4rp commented 2 years ago

Hey @thamara! I just installed your extension and I love the simplicity.

One thing - how can I specify the place where to save the .md file? We would love to use this in our project to share notes between developers.

Thanks!

thamara commented 2 years ago

Hey @Tim3W4rp! Thanks for the feedback. Looks like the only way today is to copy the content of the md file and save it elsewhere (which was my primary use case, so I didn't notice it). I'll open an issue here in GH to improve this part of the extension and will try to work on it over the next days/weeks. :)

fcFn commented 3 months ago

Heh, I have a somewhat popular app here on GH myself and I understand that we all frequently lose interest in our pet projects. Anyway, that is a very minor annoyance that you have to press a button to close the file. I hope someday you will find time to fix this. Maybe the issue should be reopened meanwhile?

Thanks for a great extension anyway!