trailofbits / vscode-weaudit

Create code bookmarks and code highlights with a click.
https://marketplace.visualstudio.com/items?itemName=trailofbits.weaudit
GNU General Public License v3.0
169 stars 16 forks source link

Feature request: Mark as pre-reviewed or multiple mark #22

Closed n0kto closed 4 months ago

n0kto commented 5 months ago

A lot of auditors go through the code at least twice, it could be really useful to mark the code as "pre-reviewed" before "completly reviewed" or be able to put multiple mark on a file/region of a file.

fcasal commented 5 months ago

Hi @n0kto could you describe your intended workflow better? Currently, you can add a note called "Pre-reviewed" with several regions, and then go through those one more time.

n0kto commented 5 months ago

Hi @fcasal,

The interesting behavior I wanted is the mark on the right of file. The idea came to my mind because I was currently auditing a protocol with a restricted scope (not all the protocol was included). The green mark on the right of the file was really helpful to see which file I needed to come back but I could not differenciate files I entirely checked twice.

Moreover I only use weAudit notes like a "to-do list": I put question I need to answer (as you said, like a "pre-reviewed") because there is just one type of note, so I cannot write explaination notes or other types of notes.

But even with several types of note or using "pre-reviewed" in my "to-do list", I should put one "pre-reviewed" note at least on every files in the scope (time-consuming). A double mark with one more "cmd + +" would be more practical.

That’s just a proposal, maybe nobody uses weAudit notes like me, but in my process, have multiple "reviewed mark" could be a cool features instead of creating more notes. :)

fcasal commented 4 months ago

Hi @n0kto, I've decided not to implement this feature for now as I don't see it adds enough value to the extension. Still, thanks for the suggestion, and feel free to suggest other features.