feat(custom_lint_core): Support workspaces (#312)

Author: Rexios80

packages/custom_lint_core/lib/src/package_utils.dart

@@ -1,3 +1,4 @@
+import 'dart:convert';
 import 'dart:io';
 
 import 'package:meta/meta.dart';
@@ -41,6 +42,9 @@ extension PackageIOUtils on Directory {
   /// The `.dart_tool/package_config.json` file.
   File get packageConfig => file('.dart_tool', 'package_config.json');
 
+  /// The `.dart_tool/pub/workspace_ref.json` file.
+  File get workspaceRef => file('.dart_tool', 'pub', 'workspace_ref.json');
+
   /// Returns a path relative to the given [other].
   String relativeTo(FileSystemEntity other) {
     return normalize(relative(path, from: other.path));
@@ -116,29 +120,6 @@ $content
   return pubspec.dependencyOverrides;
 }
 
-/// Try parsing the package config of the given directory.
-///
-/// If the parsing fails for any reason, returns null.
-PackageConfig? tryParsePackageConfigSync(Directory directory) {
-  try {
-    return parsePackageConfigSync(directory);
-  } catch (_) {
-    return null;
-  }
-}
-
-/// Parse the package config of the given directory.
-///
-/// Throws if the parsing fails, such as if the file is badly formatted or
-/// does not exists.
-PackageConfig parsePackageConfigSync(Directory directory) {
-  final packageConfigFile = directory.packageConfig;
-  return PackageConfig.parseBytes(
-    packageConfigFile.readAsBytesSync(),
-    packageConfigFile.uri,
-  );
-}
-
 /// Try parsing the package config of the given directory.
 ///
 /// If the parsing fails for any reason, returns null.
@@ -155,7 +136,17 @@ Future<PackageConfig?> tryParsePackageConfig(Directory directory) async {
 /// Throws if the parsing fails, such as if the file is badly formatted or
 /// does not exists.
 Future<PackageConfig> parsePackageConfig(Directory directory) async {
-  final packageConfigFile = directory.packageConfig;
+  var packageConfigFile = directory.packageConfig;
+  if (!packageConfigFile.existsSync()) {
+    final workspaceRefFile = directory.workspaceRef;
+    final content = workspaceRefFile.readAsStringSync();
+    final json = jsonDecode(content) as Map<String, dynamic>;
+    final workspaceRoot = json['workspaceRoot'] as String;
+    final workspacePath =
+        normalize(join(workspaceRefFile.parent.path, workspaceRoot));
+    final workspaceDir = Directory(workspacePath);
+    packageConfigFile = workspaceDir.packageConfig;
+  }
 
   return PackageConfig.parseBytes(
     await packageConfigFile.readAsBytes(),

packages/custom_lint_core/test/configs_test.dart

@@ -1,3 +1,4 @@
+import 'dart:convert';
 import 'dart:io' as io;
 
 import 'package:analyzer/file_system/file_system.dart';
@@ -20,7 +21,12 @@ File createAnalysisOptions(String content) {
   return PhysicalResourceProvider.INSTANCE.getFile(ioFile.path);
 }
 
-Future<String> createTempProject(String projectName, String tempDirPath) async {
+Future<String> createTempProject({
+  required String tempDirPath,
+  required String projectName,
+  String? packageConfig,
+  String? workspaceRef,
+}) async {
   final projectPath = join(tempDirPath, projectName);
 
   final dir = io.Directory(projectPath);
@@ -36,6 +42,28 @@ custom_lint:
     - from_package
   ''');
 
+  final projectDartToolPath = join(projectPath, '.dart_tool');
+  await io.Directory(projectDartToolPath).create(recursive: true);
+
+  if (packageConfig != null) {
+    final String packageConfigPath;
+    if (workspaceRef != null) {
+      final workspaceDartToolPath = join(tempDirPath, '.dart_tool');
+      await io.Directory(workspaceDartToolPath).create(recursive: true);
+      packageConfigPath = join(workspaceDartToolPath, 'package_config.json');
+    } else {
+      packageConfigPath = join(projectDartToolPath, 'package_config.json');
+    }
+    await io.File(packageConfigPath).writeAsString(packageConfig);
+  }
+
+  if (workspaceRef != null) {
+    final pubPath = join(projectDartToolPath, 'pub');
+    await io.Directory(pubPath).create(recursive: true);
+    final workspaceRefPath = join(pubPath, 'workspace_ref.json');
+    await io.File(workspaceRefPath).writeAsString(workspaceRef);
+  }
+
   return dir.path;
 }
 
@@ -205,7 +233,10 @@ custom_lint:
 include: package:$testPackageName/analysis_options.yaml
       ''');
 
-      final tempProjectDir = await createTempProject(dir.path, testPackageName);
+      final tempProjectDir = await createTempProject(
+        tempDirPath: dir.path,
+        projectName: testPackageName,
+      );
 
       final patchedPackageConfig = patchPackageConfig(
         packageConfig,
@@ -225,7 +256,10 @@ include: package:$testPackageName/$notExistingFileName
       ''');
       final dir = createDir();
 
-      final tempProjectDir = await createTempProject(dir.path, testPackageName);
+      final tempProjectDir = await createTempProject(
+        tempDirPath: dir.path,
+        projectName: testPackageName,
+      );
       final patchedPackageConfig = patchPackageConfig(
         packageConfig,
         testPackageName,
@@ -243,7 +277,10 @@ include: package:$testPackageName/$notExistingFileName
 include: package:$notExistingPackage/analysis_options.yaml
       ''');
       final dir = createDir();
-      final tempProjectDir = await createTempProject(dir.path, testPackageName);
+      final tempProjectDir = await createTempProject(
+        tempDirPath: dir.path,
+        projectName: testPackageName,
+      );
 
       final patchedPackageConfig = patchPackageConfig(
         packageConfig,
@@ -300,5 +337,33 @@ foo:
         expect(configs, CustomLintConfigs.empty);
       });
     });
+
+    group('package config', () {
+      test('single package', () async {
+        final dir = createDir();
+        final projectPath = await createTempProject(
+          tempDirPath: dir.path,
+          projectName: testPackageName,
+          packageConfig: jsonEncode(PackageConfig.toJson(packageConfig)),
+        );
+        final projectDir = io.Directory(projectPath);
+        final parsed = parsePackageConfig(projectDir);
+        expect(parsed, isNotNull);
+      });
+
+      test('workspace', () async {
+        final dir = createDir();
+        print(dir);
+        final projectPath = await createTempProject(
+          tempDirPath: dir.path,
+          projectName: testPackageName,
+          packageConfig: jsonEncode(PackageConfig.toJson(packageConfig)),
+          workspaceRef: jsonEncode({'workspaceRoot': '../../..'}),
+        );
+        final projectDir = io.Directory(projectPath);
+        final parsed = parsePackageConfig(projectDir);
+        expect(parsed, isNotNull);
+      });
+    });
   });
 }