Adding markdown and html output format #7
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 5 commits
September 20, 2018 18:54
…to the generated html file.
asticode
requested changes
Sep 22, 2018
| @@ -22,8 +23,11 @@ var ( | |||
| todoIdentifiers = []string{"TODO", "FIXME"} | |||
| ) | |||
|
|
|||
| // TODOs represents a set of todos | |||
| type TODOs []*TODO | |||
| // TODOContainer represents a set of todos | |||
There was a problem hiding this comment.
I don't really like the idea of creating this wrapper here.
I'd rather keep the old TODOs struct and if you need the root path in one of the Write func, you inject it as one of the method argument.
| var c = csv.NewWriter(w) | ||
|
|
||
| // Write the headings for the document | ||
| if err = c.Write([]string{"Filename", "Line", "Assignee", "Message"}); err != nil { | ||
| if err = c.Write([]string{"Path", "Filename", "Line", "Assignee", "Message"}); err != nil { |
There was a problem hiding this comment.
Since we don't add TODOContainer, remove this column
| @@ -68,6 +68,14 @@ func main() { | |||
| if err = todos.WriteJSON(writer); err != nil { | |||
| log.Fatal(err) | |||
| } | |||
| case "md": | |||
| if err = todos.WriteMarkdown(writer); err != nil { | |||
| log.Fatal(err) | ||
| } | ||
| case "html": | ||
| if err = todos.WriteHTML(writer); err != nil { |
| tocBuffer.WriteString("\n</ul>\n") | ||
| contentBuffer.WriteString("\n</ul>\n") | ||
|
|
||
| _, err = io.WriteString(w, fmt.Sprintf("<html><head><title>Todos for %s</title><link rel=\"stylesheet\" type=\"text/css\" href=\"todos.css\" /></head><body>%s<hr>%s</body></html>", |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Besides adding the new formats I added the TODOContainer struct, which is capturing the path in which the TODOs have been found, in order to use that information in the outputs.