summary library
Deprecated secondary barrel — use package:tom_analyzer_shared/tom_analyzer_shared.dart.
This file exists to mirror the lib/summary.dart export that
tom_reflection_generator historically used; new code should depend
on the main library instead.
Classes
- AnalyzerCacheGarbageCollector
- Opt-in garbage collector for orphaned analyzer-cache partitions.
- AnalyzerCachePartition
-
One
<analyzer-major>/<dart-sdk-version>partition in the shared cache. - CacheStats
- Statistics about the summary cache.
- DependencyResolver
- Resolves project dependencies with their versions from pubspec.lock.
- DependencySet
- Groups dependencies by their cacheability status.
- GroupedPackageBundle
-
Result of building a grouped
packages.sumbundle from several package closures. - GroupedPackageBundleBuilder
-
Builds one
packages.sumbundle from the union of several package dependency closures. - PackageDependency
- Represents a resolved package dependency with version information.
- SummaryCacheManager
- Manages the analyzer summary cache for a workspace.
- SummaryCacheResult
- Result of a summary-cache stage execution.
- SummaryGenerationResult
- Result of generating summaries for a batch of packages.
- SummaryGenerator
- Generates analyzer summaries for packages.
- ToolCacheLocator
- Resolves the Tom tool-cache directory — a workspace-local location for build artefacts that can be reused across the projects and tools of a single workspace.
Extensions
-
DependencyListExtensions
on List<
PackageDependency> - Extension methods for working with dependency lists.
Constants
- analyzerMajorVersion → const int
-
The major version of the
analyzerpackage this build oftom_analyzer_sharedwas compiled against.
Functions
-
currentDartSdkVersion(
) → String -
The
<major>.<minor>.<patch>Dart SDK version of the running toolchain. -
looksLikeDartSdk(
String? dir) → bool -
Whether
dirlooks like a Dart SDK root. -
mergePackageRootsForDirs(
Iterable< String> packageDirs) → Map<String, String> -
Merges the package roots resolved from each given package directory's
.dart_tool/package_config.jsoninto a single name→root map. -
readPackageRoots(
File packageConfigFile) → Map< String, String> -
Reads a resolved
.dart_tool/package_config.jsonand returns a map of package-name → absolute package root directory (the directory that containslib/). -
resolveDartSdkPath(
) → String? -
Resolves the Dart SDK root directory, or
nullto let the analyzer fall back to its default (executable-relative) detection. -
runSummaryCacheStage(
String projectRoot, {bool verbose = false, bool rebuildCache = false, bool showCacheStatus = false, List< String> cacheOnlyPackages = const [], void log(String message)?, SummaryCacheManager? cacheManager}) → Future<SummaryCacheResult?> - Runs the summary-cache stage for a project.
Exceptions / Errors
- SummaryConfigException
-
Raised when a package directory has no resolved
.dart_tool/package_config.json(i.e.pub gethas not been run there), or when a grouped bundle cannot be built (no SDK / no libraries).