srcref

Documentation

Overview

Package srcref formats AST positions as repo-relative "file:line" references suitable for embedding in generated reference docs.

Generators usually want to point a reader at the exact source line that defines a flag, route, or config field. srcref handles the fiddly bits: resolving go/token.Pos against a FileSet, trimming an absolute path to a repo-relative one, and degrading gracefully when the position is invalid.

Index

• type SrcRef
  • func New(fset *token.FileSet) *SrcRef
  • func (s *SrcRef) Format(pos token.Pos, root string) string

Types

type SrcRef

type SrcRef struct {
	// contains filtered or unexported fields
}

SrcRef formats positions against a shared FileSet.

func New

func New(fset *token.FileSet) *SrcRef

New returns a SrcRef bound to fset. The FileSet must outlive the SrcRef; it typically lives for the duration of a single docsgen run.

func (*SrcRef) Format

func (s *SrcRef) Format(pos token.Pos, root string) string

Format renders pos as "path/to/file.go:LINE". If root is non-empty and the resolved filename lives underneath root, the result is relative to root; otherwise the absolute filename is used.

Returns "" if the position is invalid or the FileSet is nil.