internal/

directory
v0.0.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 12, 2026 License: Apache-2.0

Directories

Path Synopsis
Package application orchestrates the matlatl pipeline.
Package application orchestrates the matlatl pipeline.
domain
analysis
Package analysis holds the pure-domain result model: findings, their severity and kind, and the immutable AnalysisReport every emitter renders from.
Package analysis holds the pure-domain result model: findings, their severity and kind, and the immutable AnalysisReport every emitter renders from.
corpus
Package corpus is the pure-domain model of a scanned markdown repository: the documents, their front matter and section trees, and the in-memory Corpus that holds them along with the indices (HeadingInventory, AliasTable) that downstream resolution and analysis read from.
Package corpus is the pure-domain model of a scanned markdown repository: the documents, their front matter and section trees, and the in-memory Corpus that holds them along with the indices (HeadingInventory, AliasTable) that downstream resolution and analysis read from.
graphmodel
Package graphmodel holds the pure-domain graph model and analyses: the directed reference graph over documents and sections, the hierarchy tree, and the orphan/component/HITS/gap analyses defined on the document projection (see ADR 0007).
Package graphmodel holds the pure-domain graph model and analyses: the directed reference graph over documents and sections, the hierarchy tree, and the orphan/component/HITS/gap analyses defined on the document projection (see ADR 0007).
identity
Package identity defines DocumentID — a document's canonical, repository- relative identity (ADR 0001) — and its validating constructor.
Package identity defines DocumentID — a document's canonical, repository- relative identity (ADR 0001) — and its validating constructor.
okf
Package okf implements the Open Knowledge Format (OKF) v0.1 conformance check (ADR 0023).
Package okf implements the Open Knowledge Format (OKF) v0.1 conformance check (ADR 0023).
reference
Package reference models the directed edges of the corpus: links between documents (and sections), their type, their resolution target, and their health classification.
Package reference models the directed edges of the corpus: links between documents (and sections), their type, their resolution target, and their health classification.
infrastructure
config
Package config loads the optional per-repo `.matlatl.yml` configuration file that lives at the scan root (a sibling of `.matlatlignore`).
Package config loads the optional per-repo `.matlatl.yml` configuration file that lives at the scan root (a sibling of `.matlatlignore`).
emit
Package emit renders analysis results into machine- and CI-consumable artifacts (findings.json, JUnit XML) and writes them safely under an output directory.
Package emit renders analysis results into machine- and CI-consumable artifacts (findings.json, JUnit XML) and writes them safely under an output directory.
emit/diagram
Package diagram renders the reference graph as hand-rolled Mermaid and DOT / Graphviz text.
Package diagram renders the reference graph as hand-rolled Mermaid and DOT / Graphviz text.
emit/graphjson
Package graphjson renders graph.json — the PRIMARY machine-/LLM-queryable artifact: a compact, schemaVersion-stamped, fully parseable manifest of the analyzed corpus (nodes, edges, sections, components, HITS, and every gap/ orphan/broken-link signal).
Package graphjson renders graph.json — the PRIMARY machine-/LLM-queryable artifact: a compact, schemaVersion-stamped, fully parseable manifest of the analyzed corpus (nodes, edges, sections, components, HITS, and every gap/ orphan/broken-link signal).
emit/index
Package index renders index.md: a navigable flat index of every document by canonical DocumentID, with a one-line description (front matter → first H1 fallback), category/section, and mod-date.
Package index renders index.md: a navigable flat index of every document by canonical DocumentID, with a one-line description (front matter → first H1 fallback), category/section, and mod-date.
emit/llmstxt
Package llmstxt renders the llms.txt family — the LLM-facing navigation and context artifacts:
Package llmstxt renders the llms.txt family — the LLM-facing navigation and context artifacts:
emit/report
Package report renders the human-audience analysis reports: a colorized, TTY-aware terminal summary and a committable GitHub-flavored Markdown report.
Package report renders the human-audience analysis reports: a colorized, TTY-aware terminal summary and a committable GitHub-flavored Markdown report.
emit/trails
Package trails renders trails.json — the suggested reading-order artifact (ADR 0016).
Package trails renders trails.json — the suggested reading-order artifact (ADR 0016).
fsscanner
Package fsscanner implements application.FileScanner: it walks a repository root, discovers markdown files, applies ignore rules, and enforces the security boundary of ADR 0003 (no symlink following, root containment, resource caps).
Package fsscanner implements application.FileScanner: it walks a repository root, discovers markdown files, applies ignore rules, and enforces the security boundary of ADR 0003 (no symlink following, root containment, resource caps).
linkcheck
Package linkcheck implements application.ExternalLinkChecker: an opt-in (--check-external) HTTP liveness checker for external http(s) links, with a mandatory SSRF guard (ADR 0003).
Package linkcheck implements application.ExternalLinkChecker: an opt-in (--check-external) HTTP liveness checker for external http(s) links, with a mandatory SSRF guard (ADR 0003).
mcpserver
Package mcpserver exposes a matlatl analysis as a read-only MCP server over streamable HTTP, for an agent to query a markdown corpus' link graph.
Package mcpserver exposes a matlatl analysis as a read-only MCP server over streamable HTTP, for an agent to query a markdown corpus' link graph.
mdparser
Package mdparser implements application.DocumentParser.
Package mdparser implements application.DocumentParser.
This file implements the process exit-code contract defined in ADR 0005: 0=success, 1=findings at/above threshold, 2=usage error, 3=runtime error.
This file implements the process exit-code contract defined in ADR 0005: 0=success, 1=findings at/above threshold, 2=usage error, 3=runtime error.

Jump to

Keyboard shortcuts

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