Add HTML exporting feature for reports #183
Conversation
There was a problem hiding this comment.
There are two significant things to refactor:
-
The logic generating the HTML report is a bit hard to follow, I think an approach of having a single function putting the required variables inside a unique Html template would be better, as the SVG template in the console here: https://github.com/nodesource/nsolid-console-ng/blob/master/lib/svg-template.js. This would be easier to maintain; lets split the template and the logic to create it in different files to create a separation of concerns.
-
Remove any third-party dependencies for the CSS and JS embedded in the template, we want a report that could be used offline, also a whole framework is kind of an overkill for what we need here.
lib/report/html.js
Outdated
| module.exports = htmlReport | ||
|
|
||
| async function htmlReport (report, whitelist, dir, output) { | ||
| if (output === true) output = path.join(process.cwd(), `ncm-report-${Date.now()}.html`) |
There was a problem hiding this comment.
Would be nice to include the name of the app in the name
|
Changes completed as per your review @edsadr |
|
Updated Example Screenshot: |
mster
force-pushed
the
mster/report-html
branch
from
284f98f
to
560cc0e
Compare
mster
force-pushed
the
mster/report-html
branch
from
560cc0e
to
32660ff
Compare
mster
changed the title
| } | ||
|
|
||
| return vulns | ||
| } |
There was a problem hiding this comment.
Migration of formatting logic for reusability in the HTML reporting feature.
There was a problem hiding this comment.
The report is working, great work on this @mster, just some items to consider:
-
Currently, the report contains different information than the one being generated by the CLI, this could confuse the customer. let's use the same information and also support all filters like
--filter=compliance -
I know I suggested not to include external assets, but let's add the styles to use our fonts, if the customer has it it will render properly, if not fall back to another font, ask @pdevay about it.
…lement filtering into html report.
|
Filtering now supported.
(and depending on security vulnerability level, as the cli does) |
mster
changed the title
…ange font weight, use nbsp in risk badges
|
Reflection of changes
|
See: https://github.com/nodesource/process/issues/36
Description:
Allows for users to generate and export a NCM project report in HTML (as per customer request).
--longreport.--html path/to/report.html(default exports to cwd with a timestamped report name).TODO:
Screenshot(s): a very ugly duckling
