feat: use file link in markdown report

mrsimonemms · Apr 4, 2024 · 30f33f5 · 30f33f5
1 parent f2748b7
commit 30f33f5
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 5 deletions.
diff --git a/pkg/output/markdown.go b/pkg/output/markdown.go
@@ -36,7 +36,7 @@ func (o MarkdownOutput) generate(report []scanner.Report) ([]byte, error) {
 
 	for _, item := range report {
 		res = append(res, []string{
-			item.File,
+			fmt.Sprintf("[%s](%s#L%d)", item.File, item.File, item.LineNumber),
 			strconv.Itoa(item.LineNumber),
 			item.Author,
 			item.Msg,

diff --git a/pkg/scanner/scan.go b/pkg/scanner/scan.go
@@ -195,7 +195,6 @@ func (s *Scan) scanFileForTodo(filename string) ([]Report, error) {
 			// Remove prefixed slash (may or may not be in working directory)
 			cleanFilename = strings.TrimPrefix(cleanFilename, "/")
 
-			// @todo(sje): add the URL to the file/line number
 			res = append(res, Report{
 				File:       cleanFilename,
 				LineNumber: lineNumber,

diff --git a/toodaloo.md b/toodaloo.md
@@ -4,6 +4,5 @@
 
 | File | Line Number | Author | Message |
 | --- | --- | --- | --- |
-| pkg/output/markdown.go | 30 | sje | implement report |
-| pkg/scanner/scan.go | 189 | sje | get the author from the Git history |
-| pkg/scanner/scan.go | 198 | sje | add the URL to the file/line number |
+| [pkg/output/markdown.go](pkg/output/markdown.go#L30) | 30 | sje | implement report |
+| [pkg/scanner/scan.go](pkg/scanner/scan.go#L189) | 189 | sje | get the author from the Git history |