Documentation
¶
Index ¶
- Constants
- func DeleteTagAt(line []rune, pos int) ([]rune, int, bool)
- func DeleteTagForward(line []rune, pos int) ([]rune, int, bool)
- func ExpandDocument(ctx context.Context, text, sourceAbsPath, projRoot string, notify *Notifier) (string, error)
- func ExpandDocumentWithMax(ctx context.Context, text, sourceAbsPath, projRoot string, maxFileBytes int64, ...) (string, error)
- func ExpandLine(ctx context.Context, visible, projRoot string, index []Entry) (apiContent string, err error)
- func JumpLeftOverTag(line []rune, pos int) int
- func JumpRightOverTag(line []rune, pos int) int
- func ResolveDocumentPath(tagPath, baseDir string) (abs string, err error)
- func ShortTag(relPath string, all []Entry) string
- type AtContext
- type DocumentOpts
- type DocumentTag
- type Entry
- type Index
- type IndexCache
- type Notifier
- type RuneBounds
- type SkipNotice
- type SkipReason
Constants ¶
View Source
const DefaultMaxFileExpandBytes = 32 * 1024
View Source
const MaxIncludeDepth = 4
View Source
const MaxPickerResults = 10
Variables ¶
This section is empty.
Functions ¶
func ExpandDocument ¶ added in v2026.621.0
func ExpandDocumentWithMax ¶ added in v2026.621.0
func ExpandLine ¶
func JumpLeftOverTag ¶
func JumpRightOverTag ¶
func ResolveDocumentPath ¶ added in v2026.621.0
Types ¶
type AtContext ¶
func AtContextAt ¶
type DocumentOpts ¶ added in v2026.621.0
type DocumentTag ¶ added in v2026.621.0
func FindDocumentTags ¶ added in v2026.621.0
func FindDocumentTags(s string) []DocumentTag
type IndexCache ¶
type IndexCache struct {
// contains filtered or unexported fields
}
func NewIndexCache ¶
func NewIndexCache() *IndexCache
func (*IndexCache) Invalidate ¶
func (c *IndexCache) Invalidate(projRoot string)
type Notifier ¶ added in v2026.621.0
type Notifier struct {
// contains filtered or unexported fields
}
func NewNotifier ¶ added in v2026.621.0
func NewNotifier() *Notifier
func (*Notifier) Add ¶ added in v2026.621.0
func (n *Notifier) Add(reason SkipReason, tag, path string)
type RuneBounds ¶
func TagRuneBounds ¶
func TagRuneBounds(line []rune) []RuneBounds
type SkipNotice ¶ added in v2026.621.0
type SkipNotice struct {
Reason SkipReason
Tag string
Path string
}
type SkipReason ¶ added in v2026.621.0
type SkipReason string
const ( SkipMissing SkipReason = "missing" SkipGitignored SkipReason = "gitignored" SkipBinary SkipReason = "binary" SkipExternal SkipReason = "external" SkipDepth SkipReason = "depth" SkipCycle SkipReason = "cycle" SkipNotText SkipReason = "not_text" )
Click to show internal directories.
Click to hide internal directories.