Add Markdown output support #2344
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| package runner | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "reflect" | ||
| "strings" | ||
| ) | ||
|
|
||
| func (r Result) MarkdownHeader() string { //nolint | ||
| var headers []string | ||
|
|
||
| t := reflect.TypeOf(r) | ||
| for i := 0; i < t.NumField(); i++ { | ||
| field := t.Field(i) | ||
| tag := field.Tag.Get("md") | ||
| if tag == "" || tag == "-" { | ||
| continue | ||
| } | ||
| headers = append(headers, tag) | ||
| } | ||
|
|
||
| var b strings.Builder | ||
| b.WriteString("|") | ||
| for _, h := range headers { | ||
| fmt.Fprintf(&b, " %s |", h) | ||
| } | ||
| b.WriteString("\n") | ||
|
|
||
| b.WriteString("|") | ||
| for range headers { | ||
| b.WriteString("---|") | ||
| } | ||
| b.WriteString("\n") | ||
|
|
||
| return b.String() | ||
| } | ||
|
|
||
| func (r Result) MarkdownRow(scanopts *ScanOptions) string { //nolint | ||
| var values []string | ||
|
|
||
| v := reflect.ValueOf(r) | ||
| t := v.Type() | ||
|
|
||
| for i := 0; i < t.NumField(); i++ { | ||
| field := t.Field(i) | ||
| tag := field.Tag.Get("md") | ||
| if tag == "" || tag == "-" { | ||
| continue | ||
| } | ||
|
|
||
| fieldValue := v.Field(i) | ||
| values = append(values, formatMarkdownValue(fieldValue)) | ||
| } | ||
|
|
||
| var b strings.Builder | ||
| b.WriteString("|") | ||
| for _, val := range values { | ||
| fmt.Fprintf(&b, " %s |", val) | ||
| } | ||
| b.WriteString("\n") | ||
|
|
||
| return b.String() | ||
| } | ||
|
|
||
| func formatMarkdownValue(v reflect.Value) string { | ||
| switch v.Kind() { | ||
| case reflect.String: | ||
| return escapeMarkdown(v.String()) | ||
| case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64: | ||
| return fmt.Sprintf("%d", v.Int()) | ||
| case reflect.Bool: | ||
| return fmt.Sprintf("%t", v.Bool()) | ||
| case reflect.Slice: | ||
| if v.Len() == 0 { | ||
| return "" | ||
| } | ||
| var items []string | ||
| for i := 0; i < v.Len(); i++ { | ||
| items = append(items, fmt.Sprintf("%v", v.Index(i).Interface())) | ||
| } | ||
| return escapeMarkdown(strings.Join(items, ", ")) | ||
| default: | ||
| if v.CanInterface() { | ||
| return escapeMarkdown(fmt.Sprintf("%v", v.Interface())) | ||
| } | ||
| return "" | ||
| } | ||
| } | ||
|
|
||
| func escapeMarkdown(s string) string { | ||
| replacer := strings.NewReplacer( | ||
| "|", "\\|", | ||
| "\n", " ", | ||
| ) | ||
| return strings.TrimSpace(replacer.Replace(s)) | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Critical logic bug:
jsonAndCsvAndMDbreaks existing JSON+CSV behavior.The condition
jsonAndCsvAndMDrequires all three outputs (JSON, CSV, and Markdown) to be enabled simultaneously. This breaks the previous behavior where enabling just JSON and CSV would add.json/.csvextensions to avoid file overwrites.Scenario: User runs
httpx -json -csv -o outputoutput.jsonandoutput.csvoutput(no extensions), causing overwritesThe correct approach is to check if more than one structured output format is enabled:
🐛 Proposed fix
Then replace all occurrences of
jsonAndCsvAndMDwithmultipleStructuredOutputsat lines 967, 978, 989, 1012, 1229, 1340, and 1353.🤖 Prompt for AI Agents