codemap

type CheckResult struct {
	Path string
	Lang string
	// Checked is false when nothing could check this file — no parser covers
	// its type, or (see Reason) its content is not the language yet. The file
	// was not parsed, which is not the same as it being clean: nothing may be
	// concluded from an empty Diagnostics in that case.
	Checked bool
	// Reason says why a file of a checkable type was still not checked — a
	// YAML file holding template syntax, say. Empty when the type itself has
	// no parser.
	Reason string
	// Diagnostics is empty for a file that parses cleanly.
	Diagnostics []Diagnostic
	// Truncated is true when MaxDiagnostics cut the list short.
	Truncated bool
}

type Diagnostic struct {
	Line   int
	Column int
	// EndLine is the last line the problem covers, equal to Line for a
	// single-line one. A damaged region can run for many lines, and its extent
	// is what tells a reader whether they are looking at one bad token or a
	// file that needs rewriting.
	EndLine int
	// Missing marks a diagnostic the parser inferred from a token that should
	// have been there rather than from bytes it could not use. These carry the
	// better message — the parser names the exact token it wanted.
	Missing bool
	Message string
	// Source is the file's line at Line, trimmed of trailing space. Empty when
	// the diagnostic points past the last line.
	Source string
}

type FileMap struct {
	Path       string
	Lang       string
	TotalLines int
	Symbols    []*Symbol
	// FromLine and ToLine bound a map of one region (see OutlineRange); both
	// are zero for a map of the whole file.
	FromLine, ToLine int
	// Omitted counts symbols dropped by the MaxSymbols cap.
	Omitted int
	// OmittedDepth, when the cap dropped anything, is the shallowest nesting
	// level it dropped: every entry that deep or deeper is left out, all
	// through the file, so what remains still covers the file end to end. Zero
	// when even the file-scope entries did not fit, and the map ends at
	// StopLine instead.
	OmittedDepth int
	// StopLine is the last line a map cut short by the cap still covers; zero
	// when it runs to the end.
	StopLine int
	// Fallback is true when no grammar covered this extension and the
	// heuristic scanner produced the outline.
	Fallback bool
	// ParseError is true when tree-sitter hit a syntax error. The outline is
	// still usable — tree-sitter recovers and keeps going — but it may be
	// missing declarations after the damaged region, and a reader deserves to
	// know that before trusting a gap.
	ParseError bool
}

type Symbol struct {
	Kind      string // func, method, type, const, var, import, and fallback kinds
	Name      string // primary identifier; empty for import blocks
	Signature string // rendered display form, already collapsed and capped
	Doc       string // first line of the doc comment, markers stripped
	StartLine int
	EndLine   int
	// Depth is how many symbols enclose this one — 0 at file scope, 1 for a
	// class member. Rendered as indentation.
	Depth int
	// contains filtered or unexported fields
}

type TooLargeError struct {
	Size int64
}