Documentation
¶
Index ¶
- func CollectCodeBlockLines(f *File) map[int]bool
- func CountLines(b []byte) int
- func ResolveFiles(args []string) ([]string, error)
- func ResolveFilesWithOpts(args []string, opts ResolveOpts) ([]string, error)
- func StripFrontMatter(source []byte) (prefix, content []byte)
- type Diagnostic
- type File
- type GitignoreMatcher
- type ResolveOpts
- type Severity
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CollectCodeBlockLines ¶
CollectCodeBlockLines walks the AST and returns a set of 1-based line numbers that belong to fenced code blocks (including fence lines) or indented code blocks.
func CountLines ¶
CountLines returns the number of newline-terminated lines in b.
func ResolveFiles ¶
ResolveFiles takes positional arguments and returns deduplicated, sorted markdown file paths. It supports individual files, directories (recursive *.md and *.markdown), and glob patterns. Returns an error for nonexistent paths (that are not glob patterns). By default, directory walking respects .gitignore files.
func ResolveFilesWithOpts ¶
func ResolveFilesWithOpts(args []string, opts ResolveOpts) ([]string, error)
ResolveFilesWithOpts is like ResolveFiles but accepts options to control behavior such as gitignore filtering.
func StripFrontMatter ¶
StripFrontMatter removes YAML front matter delimited by "---\n" from the beginning of source. It returns the front matter block (including delimiters) and the remaining content. If no front matter is found, prefix is nil and content equals source.
Types ¶
type Diagnostic ¶
type Diagnostic struct {
File string
Line int
Column int
RuleID string
RuleName string
Severity Severity
Message string
}
Diagnostic represents a single lint finding.
type File ¶
type File struct {
Path string
Source []byte
Lines [][]byte
AST ast.Node
FS fs.FS
FrontMatter []byte
LineOffset int
}
File holds a parsed Markdown document and its source.
func NewFileFromSource ¶
NewFileFromSource creates a File from raw source bytes. When stripFrontMatter is true it strips YAML front matter, stores the prefix in FrontMatter, computes LineOffset via CountLines, and parses only the stripped content.
func (*File) AdjustDiagnostics ¶
func (f *File) AdjustDiagnostics(diags []Diagnostic)
AdjustDiagnostics adds the file's LineOffset to each diagnostic's Line.
func (*File) FullSource ¶
FullSource prepends the stored FrontMatter to body. It allocates a new slice to avoid mutating FrontMatter's backing array.
func (*File) LineOfOffset ¶
LineOfOffset converts a byte offset in Source to a 1-based line number.
type GitignoreMatcher ¶
type GitignoreMatcher struct {
// contains filtered or unexported fields
}
GitignoreMatcher checks whether a given path is ignored according to .gitignore rules. It supports multiple .gitignore files at different directory levels, including negation patterns.
func NewGitignoreMatcher ¶
func NewGitignoreMatcher(root string) *GitignoreMatcher
NewGitignoreMatcher creates a matcher by collecting .gitignore files from the given root directory and all its subdirectories. It also looks for .gitignore files in ancestor directories up to the filesystem root.
type ResolveOpts ¶
type ResolveOpts struct {
// UseGitignore enables filtering of walked directories by .gitignore
// rules. When true (the default), files matched by .gitignore patterns
// are skipped during directory walking. Explicitly named file paths are
// never filtered by gitignore. Defaults to true when the zero value is
// used (see DefaultResolveOpts).
UseGitignore *bool
// NoFollowSymlinks is a list of glob patterns. Symbolic links
// whose path matches any pattern are skipped during directory
// walking and glob expansion.
NoFollowSymlinks []string
}
ResolveOpts controls how file resolution behaves.
func DefaultResolveOpts ¶
func DefaultResolveOpts() ResolveOpts
DefaultResolveOpts returns options with defaults applied.
Source Files