Skip to main content

Crate todo_tree

Crate todo_tree 

Source
Expand description

Core library for todo-tree: parses TODO-style comments out of source files and produces structured scan results.

This crate is intentionally silent and side-effect-free: it never prints to stdout/stderr and never reads CLI arguments. Those concerns live in the todo-tree/tt binaries, which are thin CLI wrappers around parser::TodoParser, scanner::Scanner, and printer::Printer.

Re-exports§

pub use crate::core::ScanResult;
pub use crate::core::ScanSummary;
pub use crate::core::TodoItem;
pub use crate::core::TodoPriority;

Modules§

config
.todorc configuration file discovery, parsing, and merging with CLI overrides. .todorc configuration file discovery, parsing, and merging with CLI overrides.
core
Domain types shared across the crate: TODO items, scan results and summaries, priorities, and the built-in tag catalog. Domain types: TODO items, scan results/summaries, priorities, and the built-in tag catalog.
display
Terminal display helpers (priority-to-color mapping) shared by the library’s printers and the CLI binaries. Terminal display helpers shared by the library’s printers and the CLI binaries’ own (non-Printer) output.
parser
Regex-based parsing of TODO-style comments out of file content. Regex-based parsing of TODO-style comments out of file content.
printer
Formatting a core::ScanResult as tree, flat, or JSON output. Formatting a crate::core::ScanResult as tree, flat, or JSON output.
scanner
Directory walking and file parsing orchestration. Directory walking and file parsing orchestration.