Issue 79: Add a json reporter to quantify the extend of the cli's documenation #32
Conversation
| return &report | ||
| } | ||
|
|
||
| func (report *Report) Write(w io.Writer) error { |
There was a problem hiding this comment.
Linters will fail on public methods without docs.
There was a problem hiding this comment.
Right, weird. My linter must have overlooked it for unknown reasons. I will get that fixed.
usage/html.go
Outdated
|
|
||
| // report | ||
| repjson := path.Join(dir, "report.json") | ||
| rjw, err := os.Create(repjson) |
There was a problem hiding this comment.
This will override a previous report. If you think this can be an issue you can use utils.WriteFile() that will ask the user for consent.
There was a problem hiding this comment.
Cool. I think I will stick with what's there now. The default behavior of the HTML help is to overwrite existing files.
sourishkrout
force-pushed
the
sebastian/issue-79
branch
from
a81dd25 to
7dfdc0c
Compare
usage/help.go
Outdated
| cli.StringFlag{ | ||
| Name: "report", | ||
| Usage: "The report <directory> for JSON report based on HTML docs.", | ||
| }, |
There was a problem hiding this comment.
The way that the code works, looks like this should be a cli.BoolFlag instead of a string with the directory, with this, we will generate the report with step help --html <directory> --report
There was a problem hiding this comment.
OK. That works for me too. I'll make the changes.
Description
Implemented a simple word/line counter report based on the HTML page generation written to the output ./html directory.
https://github.com/smallstep/ca-component/issues/79