application

package

Go to main page

Versions in this module

v0

v0.0.8

Aug 12, 2026

Changes in this version

+ const DetailFrontmatterState

+ const DetailHopsFromRoot

+ const DetailOKFVersion

+ const DetailReason

+ const DetailReservedFile

type Config

+ FarFromRootThreshold int

+ OKF bool

+ RespectGitignore bool

type NoticeKind

+ const NoticeGitignore

type Result

+ FarFromRootCount int

+ OKFConformant bool

+ OKFMissingFrontmatterCount int

+ OKFMissingTypeCount int

+ OKFMode bool

+ OKFReservedFileStructureCount int

+ OKFVersion string

v0.0.7

Jun 30, 2026

v0.0.6

Jun 23, 2026

v0.0.5

Jun 10, 2026

v0.0.4

Jun 10, 2026

v0.0.3

Jun 10, 2026

v0.0.2

Jun 10, 2026

Changes in this version

type Config

+ EmitExclude []string

v0.0.1

Jun 10, 2026

Changes in this version

+ const DetailAdamicAdar

+ const DetailAnchorText

+ const DetailBetweenness

+ const DetailBlocked

+ const DetailBowtieBucket

+ const DetailBridgeEndpoint

+ const DetailCandidates

+ const DetailCoCitation

+ const DetailComponentA

+ const DetailComponentB

+ const DetailCoupling

+ const DetailExpectedSlug

+ const DetailInboundCount

+ const DetailLinkType

+ const DetailRepresentativeA

+ const DetailRepresentativeB

+ const DetailScentScore

+ const DetailSharedNeighbours

+ const DetailSourceDocument

+ const DetailStatusCode

+ const DetailSuggestedAnchor

+ const DetailSuggestedTarget

+ const DetailTarget

+ const DetailTargetDocument

+ type Artifact struct

+ Content []byte

+ Name string

+ type ArtifactWriter interface

+ Write func(ctx context.Context, artifacts []Artifact) error

+ type BrokenEdge struct

+ Origin identity.DocumentID

+ Target string

+ type Config struct

+ CheckExternal bool

+ ExternalChecker ExternalLinkChecker

+ Formats []string

+ Ignore []string

+ InboundThreshold int

+ LinkSuggestionMinShared int

+ OutputDir string

+ ParseWorkers int

+ Quiet bool

+ ResolutionPolicy reference.ResolutionPolicy

+ RootPath string

+ Roots []string

+ Strict bool

+ StructureFindingsSeverity StructureFindingsSeverity

+ Verbose bool

+ func DefaultConfig() Config

+ type DocumentParser interface

+ Parse func(ctx context.Context, file ScannedFile) (*corpus.Document, error)

+ type DocumentParserFactory interface

+ Clone func() DocumentParser

+ New func() DocumentParser

+ type ExternalLinkChecker interface

+ Check func(ctx context.Context, urls []string) map[string]ExternalResult

+ type ExternalResult struct

+ Blocked bool

+ Err string

+ OK bool

+ StatusCode int

+ URL string

+ type FileScanner interface

+ Scan func(ctx context.Context, root string) (ScanResult, error)

+ type Notice struct

+ Detail string

+ Kind NoticeKind

+ Path string

+ type NoticeKind int

+ const NoticeConfig

+ const NoticeEscapesRoot

+ const NoticeIOError

+ const NoticeOversized

+ const NoticeSkippedNestedRepo

+ const NoticeSkippedSymlink

+ const NoticeTruncated

+ const NoticeWalkError

+ func (k NoticeKind) String() string

+ type Pipeline struct

+ func NewPipeline(cfg Config, scanner FileScanner, parserFac DocumentParserFactory, ...) *Pipeline

+ func (p *Pipeline) Run(ctx context.Context) (platform.ExitCode, Result, error)

+ type Result struct

+ AmbiguousCount int

+ ArticulationPointCount int

+ BridgeCount int

+ BrokenAnchorCount int

+ BrokenEdges []BrokenEdge

+ BrokenLinkCount int

+ Corpus *corpus.Corpus

+ DeadEndCount int

+ DeadLinkCount int

+ DocumentCount int

+ HeadingCount int

+ KnowledgeGapCount int

+ LowScentAnchorCount int

+ Metrics *graphmodel.GraphMetrics

+ Notices []Notice

+ OrphanCount int

+ ReferenceCount int

+ Report *analysis.AnalysisReport

+ StructureFindingsSeverity StructureFindingsSeverity

+ SuggestedLinkCount int

+ SuggestedLinksTruncated bool

+ UnderLinkedCount int

+ UnreachableCount int

+ func (r Result) CheckExitCode(strict bool) platform.ExitCode

+ type ScanResult struct

+ Files []ScannedFile

+ Notices []Notice

+ type ScannedFile struct

+ ID identity.DocumentID

+ ModTime time.Time

+ Path string

+ Size int64

+ type StructureFindingsSeverity string

+ const StructureFindingsInfo

+ const StructureFindingsWarning

+ func (s StructureFindingsSeverity) Valid() bool

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL