cartographer library
Public API for cartographer.
Most users will invoke cartographer via the CLI (dart run cartographer).
This library exposes the extractor and config types for programmatic use
(e.g., custom CI scripts).
Classes
- CartographerConfig
-
Optional configuration loaded from
cartographer.yamlat the project root. - CategoryRule
- SitemapResult
- Result of extracting a sitemap from a Flutter project.
Functions
-
extractSitemap(
{required Directory projectRoot, CartographerConfig? config, ExtractProgress? onProgress}) → Future< SitemapResult>
Typedefs
- ExtractProgress = void Function(String phase, int current, int total)
-
Walk
projectRoot/lib using package:analyzer and produce a sitemap of widget classes and the Navigator pushes between them.