doctor

Documentation

Overview

Package doctor anaylzes notes for empty content, incorrect links and duplicates.

Index

• Constants
• func PrintReport(r Report)
• type BrokenLink
• type DuplicateTitle
• type Report
  • func Run(notesPath string) (Report, error)

Constants

const (
	Bold   = "\033[1m"
	Green  = "\033[32m"
	Red    = "\033[31m"
	Yellow = "\033[33m"
	Reset  = "\033[0m"
	Dim    = "\033[2m"
)

ANSI color codes for terminal output formatting.

Functions

func PrintReport

func PrintReport(r Report)

PrintReport formats and prints the linter report to standard output. It colorizes the output, groups broken links and duplicate titles by file, and ensures consistent alphabetical sorting of the results.

Types

type BrokenLink

type BrokenLink struct {
	SourceFile string
	TargetNote string
}

type DuplicateTitle

type DuplicateTitle struct {
	Title string
	Paths []string
}

type Report

type Report struct {
	BrokenLinks []BrokenLink
	EmptyNotes  []string
	Duplicates  []DuplicateTitle
}

Report gathers all problems in one structure

func Run

func Run(notesPath string) (Report, error)

Run reads directory and checks for problems