feat(output): auto-open HTML file after scan #1412
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1412 +/- ##
==========================================
+ Coverage 69.05% 69.43% +0.38%
==========================================
Files 186 186
Lines 18237 18357 +120
==========================================
+ Hits 12593 12746 +153
+ Misses 4965 4934 -31
+ Partials 679 677 -2 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
|
Hmm, thinking a bit more, if we host it on a localhost port, users could potentially use SSH port forwarding to access the website if they are remotely accessing the server. But I don't know how likely this case would be. |
This is the workflow I typically use whenever I need to inspect a web page generated by some tool (e.g. documentation) |
Updated code to also host the HTML file on localhost |
| // This may be nil. | ||
| return r, err | ||
| } | ||
|
|
||
| // openHTML opens the outputted HTML file and simultaneously hosts it on localhost:8000 for remote access. | ||
| func openHTML(outputPath string, r reporter.Reporter) { |
There was a problem hiding this comment.
nit: r should be the first argument
| // This could be done in a separate goroutine to avoid blocking the main thread, | ||
| // but since this is basically the last step in generating the HTML output, | ||
| // it's kept in the main thread for better maintainability and readability. | ||
| servePort := "8000" |
There was a problem hiding this comment.
This should probably only be done when the open command fails.
There was a problem hiding this comment.
I think this is primarily for users to remote access.
There was a problem hiding this comment.
I'm assuming open will most likely fail if it's a machine that is being sshed into, which is why I'm thinking this should start the server when xdg-open fails.
Added support to automatically open the HTML file in users' default browser after a scan finishes.
Implementing this by using the right
opencommand for each OS (likexdg-openfor Linux,startfor Windows, andopenfor macOS). Simultaneously, the file is served on localhost for easy remote access.