honor sub packages in workspaces

Author: ElectricCookie

lib/changelog_generator/changelog_generator.dart

@@ -118,7 +118,7 @@ class ChangelogGenerator {
     final updatedContent = '$newEntry$existingContent';
     await changelogFile.writeAsString(updatedContent);
 
-    logger.info('CHANGELOG.md updated successfully.');
+    logger.info('${changelogFile.absolute.path} updated successfully.');
   }
 
   /// Retrieves the package version and homepage from pubspec.yaml

lib/doc_comparator/get_ref.dart

@@ -3,8 +3,10 @@ import 'dart:io';
 import 'package:mtrust_api_guard/doc_comparator/parse_doc_file.dart';
 import 'package:mtrust_api_guard/doc_generator/cache.dart';
 import 'package:mtrust_api_guard/doc_generator/doc_generator.dart';
+import 'package:mtrust_api_guard/doc_generator/git_utils.dart';
 import 'package:mtrust_api_guard/logger.dart';
 import 'package:mtrust_api_guard/models/package_info.dart';
+import 'package:path/path.dart';
 
 Future<PackageApi> getRef({
   required String ref,
@@ -22,11 +24,17 @@ Future<PackageApi> getRef({
 
   // Handle git refs
   if (cache) {
-    final cache = Cache();
+    final cacheInstance = Cache();
+    final repoPath = GitUtils.getRepositoryRoot(gitRoot.path);
+    final dartRelativePath = relative(dartRoot.path, from: gitRoot.path);
 
-    if (cache.hasApiFile(gitRoot.path, ref)) {
+    if (cacheInstance.hasApiFile(repoPath, ref, dartRelativePath)) {
       logger.success('Using cached API documentation for $ref');
-      final cachedContent = await cache.retrieveApiFile(gitRoot.path, ref);
+      final cachedContent = await cacheInstance.retrieveApiFile(
+        repoPath,
+        ref,
+        dartRelativePath,
+      );
       if (cachedContent != null) {
         return parsePackageApiFile(cachedContent);
       }

lib/doc_generator/cache.dart

@@ -20,40 +20,59 @@ class Cache {
     return Directory(join(_cacheDir.path, repoName));
   }
 
-  /// Gets the path for an API file cached for a specific git ref
-  File getApiFileForRef(String repoPath, String ref) {
+  /// Sanitizes a path for use in file names
+  String _sanitizePath(String path) {
+    if (path == '.' || path.isEmpty) {
+      return 'root';
+    }
+    // Replace path separators and invalid characters with underscores
+    return path.replaceAll(RegExp(r'[<>:"|?*\x00-\x1f/\\]'), '_');
+  }
+
+  /// Gets the path for an API file cached for a specific git ref and dart root
+  File getApiFileForRef(String repoPath, String ref, String dartRelativePath) {
     final repoCacheDir = getRepositoryCacheDir(repoPath);
-    return File(join(repoCacheDir.path, '${ref}_api.json'));
+    final sanitizedDartPath = _sanitizePath(dartRelativePath);
+    return File(join(repoCacheDir.path, '${ref}_${sanitizedDartPath}_api.json'));
   }
 
-  /// Stores API documentation for a specific git ref
-  Future<void> storeApiFile(String repoPath, String ref, String content) async {
+  /// Stores API documentation for a specific git ref and dart root
+  Future<void> storeApiFile(
+    String repoPath,
+    String ref,
+    String dartRelativePath,
+    String content,
+  ) async {
     final repoCacheDir = getRepositoryCacheDir(repoPath);
     if (!repoCacheDir.existsSync()) {
       repoCacheDir.createSync(recursive: true);
     }
 
-    final apiFile = getApiFileForRef(repoPath, ref);
+    final apiFile = getApiFileForRef(repoPath, ref, dartRelativePath);
     await apiFile.writeAsString(content);
   }
 
-  bool hasApiFileForRef(String repoPath, String ref) {
-    final apiFile = getApiFileForRef(repoPath, ref);
+  bool hasApiFileForRef(String repoPath, String ref, String dartRelativePath) {
+    final apiFile = getApiFileForRef(repoPath, ref, dartRelativePath);
     return apiFile.existsSync();
   }
 
-  /// Retrieves API documentation for a specific git ref
-  Future<String?> retrieveApiFile(String repoPath, String ref) async {
-    final apiFile = getApiFileForRef(repoPath, ref);
+  /// Retrieves API documentation for a specific git ref and dart root
+  Future<String?> retrieveApiFile(
+    String repoPath,
+    String ref,
+    String dartRelativePath,
+  ) async {
+    final apiFile = getApiFileForRef(repoPath, ref, dartRelativePath);
     if (apiFile.existsSync()) {
       return await apiFile.readAsString();
     }
     return null;
   }
 
-  /// Checks if API documentation exists for a specific git ref
-  bool hasApiFile(String repoPath, String ref) {
-    final apiFile = getApiFileForRef(repoPath, ref);
+  /// Checks if API documentation exists for a specific git ref and dart root
+  bool hasApiFile(String repoPath, String ref, String dartRelativePath) {
+    final apiFile = getApiFileForRef(repoPath, ref, dartRelativePath);
     return apiFile.existsSync();
   }
 

lib/doc_generator/doc_generator.dart

@@ -82,9 +82,13 @@ Future<PackageApi> generateDocs({
   final classes = <DocComponent>[];
 
   if (shouldCache) {
-    if (cache.hasApiFile(repoPath, effectiveRef)) {
+    if (cache.hasApiFile(repoPath, effectiveRef, dartRelativePath)) {
       logger.success('Using cached API documentation for $effectiveRef');
-      final cachedContent = await cache.retrieveApiFile(repoPath, effectiveRef);
+      final cachedContent = await cache.retrieveApiFile(
+        repoPath,
+        effectiveRef,
+        dartRelativePath,
+      );
       if (cachedContent != null) {
         logger.success('Using cached API documentation for $effectiveRef');
 
@@ -112,20 +116,20 @@ Future<PackageApi> generateDocs({
     }
   }
 
+  logger.info('determining analysis dart root');
+  logger.info('dartRoot: ${dartRoot.path}');
+  logger.info('gitRoot: ${gitRoot.path}');
+  logger.info('worktreePath: $worktreePath');
+
   // Determine the root path to use for analysis
   // If using a worktree, calculate the dartRoot path relative to the worktree
-  final analysisDartRoot = worktreePath != null
-      ? () {
-          final gitRootAbs = Directory(gitRoot.path).absolute.path;
-          final dartRootAbs = Directory(dartRoot.path).absolute.path;
-          final relativePath = relative(dartRootAbs, from: gitRootAbs);
-          // Handle case where dartRoot == gitRoot (relative path would be ".")
-          if (relativePath == '.' || relativePath.isEmpty) {
-            return Directory(worktreePath!);
-          }
-          return Directory(join(worktreePath!, relativePath));
-        }()
-      : dartRoot;
+  Directory analysisDartRoot = dartRoot;
+  if (worktreePath != null) {
+    final gitRootAbs = Directory(gitRoot.path).absolute.path;
+    final dartRootAbs = Directory(dartRoot.path).absolute.path;
+    final relativePath = relative(dartRootAbs, from: gitRootAbs);
+    analysisDartRoot = Directory(join(worktreePath, relativePath));
+  }
 
   try {
     final (config, globbedFiles) = evaluateTargetFiles(analysisDartRoot.path);
@@ -269,7 +273,7 @@ Future<PackageApi> generateDocs({
 
     // Cache the generated documentation if requested
     if (shouldCache) {
-      await cache.storeApiFile(repoPath, effectiveRef, output);
+      await cache.storeApiFile(repoPath, effectiveRef, dartRelativePath, output);
       logger.success('Cached documentation for ref: $effectiveRef');
     }
 
@@ -285,10 +289,10 @@ Future<PackageApi> generateDocs({
     return packageApi;
   } finally {
     // Clean up worktree if it was created
-    if (worktreeCreated && worktreePath != null) {
+    if (worktreeCreated) {
       try {
         logger.detail('Cleaning up worktree at $worktreePath');
-        await GitUtils.removeWorktree(repoPath, worktreePath);
+        await GitUtils.removeWorktree(repoPath, worktreePath!);
         logger.detail('Successfully cleaned up worktree');
       } catch (e) {
         logger.err('Warning: Failed to clean up worktree at $worktreePath: $e');

lib/version/version.dart

@@ -97,6 +97,9 @@ Future<VersionResult> version({
 
   final baseVersion = PubspecUtils.getVersion(basePubSpec);
 
+  logger.info('Base version: $baseVersion');
+  logger.info('Changes: $changes');
+
   final highestMagnitudeChange = getHighestMagnitude(changes);
 
   logger.info('Highest magnitude change: $highestMagnitudeChange');