markdown

package

v0.1.0-alpha.0 Latest Latest Go to latest Published: Sep 27, 2026 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/berquerant/git-iter-go

Links

Open Source Insights

Documentation ¶

Index ¶

func FormatCodeDetails(summary, code string) string
func FormatDetails(summary, content string) string
func HeadingPrefix(level int) string
func ParseResultFiles(stdout string) []string
func WriteHeader(w io.Writer, title string, headerLevel int) error
func WriteList(w io.Writer, results []common.RepoResult, reposRoot string, headerLevel int) error
func WriteLsFiles(w io.Writer, r common.Result, headerLevel int) error
func WriteLsFilesSummary(w io.Writer, results []common.Result, headerLevel int) error
func WriteRepo(w io.Writer, r common.RepoResult, headerLevel int) error
func WriteResult(w io.Writer, r common.Result, headerLevel int) error
func WriteSummary(w io.Writer, results []common.Result, headerLevel int) error
type Details
- func NewCodeDetails(summary, code string) Details
- func (d Details) String() string
- func (d Details) WriteTo(w io.Writer) (int64, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func FormatCodeDetails ¶

func FormatCodeDetails(summary, code string) string

FormatCodeDetails formats summary and code text wrapped in a markdown code block within a <details> element.

func FormatDetails ¶

func FormatDetails(summary, content string) string

FormatDetails formats summary and content as a markdown <details> block.

func HeadingPrefix ¶

func HeadingPrefix(level int) string

HeadingPrefix returns the markdown heading prefix for a given level (clamped to 1-6).

func ParseResultFiles ¶

func ParseResultFiles(stdout string) []string

ParseResultFiles parses stdout lines into non-empty file paths.

func WriteHeader ¶

func WriteHeader(w io.Writer, title string, headerLevel int) error

WriteHeader writes a top-level Markdown heading for a command execution. titleLevel is typically headerLevel - 1 (clamped to 1-6).

func WriteList ¶

func WriteList(w io.Writer, results []common.RepoResult, reposRoot string, headerLevel int) error

WriteList writes the complete list output in Markdown format: a top heading, a bullet list of repositories, and a summary section.

func WriteLsFiles ¶

func WriteLsFiles(w io.Writer, r common.Result, headerLevel int) error

WriteLsFiles writes an individual repository's ls-files Result formatted as Markdown.

func WriteLsFilesSummary ¶

func WriteLsFilesSummary(w io.Writer, results []common.Result, headerLevel int) error

WriteLsFilesSummary writes an aggregate summary for multiple ls-files Results.

func WriteRepo ¶

func WriteRepo(w io.Writer, r common.RepoResult, headerLevel int) error

WriteRepo writes RepoResult formatted as a Markdown section.

func WriteResult ¶

func WriteResult(w io.Writer, r common.Result, headerLevel int) error

WriteResult writes Result formatted as a Markdown section. The heading is "<h> <repo>: exit code = <code>" using headerLevel (clamped to 1-6). stdout/stderr are wrapped in collapsible <details> blocks.

func WriteSummary ¶

func WriteSummary(w io.Writer, results []common.Result, headerLevel int) error

WriteSummary writes an aggregate summary for multiple Results.

Types ¶

type Details ¶

type Details struct {
	Summary string
	Content string
}

Details represents an HTML <details><summary>...</summary>...</details> collapsible block.

func NewCodeDetails ¶

func NewCodeDetails(summary, code string) Details

NewCodeDetails creates a Details block with code content wrapped in triple backticks.

func (Details) String ¶

func (d Details) String() string

String formats the Details block into a string with a trailing double newline.

func (Details) WriteTo ¶

func (d Details) WriteTo(w io.Writer) (int64, error)

WriteTo writes the formatted <details> block to w with a trailing double newline, implementing io.WriterTo.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL