Skip to main content

Module formatters

Module formatters 

Source

Structs§

OutlineNode
Node representing directory or file in codebase outline tree.

Constants§

STOP_SITES_LISTED

Functions§

add_path_to_outline
Add a file path into the outline tree, bounded by max_depth.
add_unsupported_to_outline
Counts a file no extractor reads on the deepest folder the outline already shows for it, or on its top-level folder. Call it after every indexed file is added.
format_blast_radius
Format blast radius and likely test targets into token-dense markdown.
format_context_slice
Format surgical context bundle for a symbol.
format_context_slices
The context of one symbol or of each of its overloads.
format_edit_check
The post-edit answer: the base, each symbol whose shape changed with its sites split by whether the diff reached them, the tests to run, and the blind spots of the index.
format_fact_categories
format_file_skeleton
Format progressive disclosure file skeleton with implementation bodies stripped.
format_find_symbol_results
format_import_summary
Format references list for callers/callees with optional limit footer. One line for the import statements of a target: their count and the first three sites.
format_no_facts
The answer when a category matches no fact. A known alias gets only the alias summary, and import says where imports are, because most extractors record imports as symbols. Any other category lists every raw category, so the agent can pick one.
format_reference_report
The callers answer: three header lines, the sites in label order up to limit, the text-only lines, the blind spots of the index, and the import summary. Counts are always complete.
format_references
format_search_results
Formats FTS5 conceptual search results into token-dense markdown.
format_stop_reason
The reason a Stop hook gives for a check: how many proven sites outside the diff still use the old shape of which symbols, then the first of them. None when no change that [blocks_a_stop] has such a site.
format_structural_facts
Format structural facts and matching literals into token-dense markdown.
format_symbol_bodies
The bodies of one symbol or of its overloads, each under its own location comment.
format_symbol_body
Format symbol body with metadata header, signature, and body content. A symbol’s source as written, under a location comment.
no_facts_heading
Format available structural fact & literal categories. The first line of a fact query that matched nothing; it names the path the query was limited to.
render_outline_tree
stop_sites
The proven sites that block a stop, in the order its reason lists them.