Fix CI

Author: rrousselGit

packages/custom_lint/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased patch
+
+- Fix CI
+
 ## 0.6.7 - 2024-09-08
 
 - Removed offline package resolution for the analyzer plugin.

packages/custom_lint/example/lib/main.dart

@@ -9,6 +9,7 @@ class Main {}
 // expect_lint: riverpod_final_provider
 ProviderBase<int> provider = Provider((ref) => 0);
 
+// expect_lint: riverpod_final_provider
 Provider<int> provider2 = Provider((ref) => 0);
 
 Object? foo = 42;

packages/custom_lint/lib/src/output/render_lints.dart

@@ -24,6 +24,7 @@ void renderLints(
     case OutputFormatEnum.json:
       outputFormat = JsonOutputFormat();
     case OutputFormatEnum.plain:
+    // ignore: unreachable_switch_default, disable for now as won't work on stable
     default:
       outputFormat = DefaultOutputFormat();
   }

packages/custom_lint/lib/src/workspace.dart

@@ -395,21 +395,6 @@ RunProcess runProcess = Process.run;
 @visibleForTesting
 bool platformIsWindows = Platform.isWindows;
 
-/// An error thrown when [CustomLintPlugin._visitSelfAndTransitiveDependencies] tries to iterate over
-/// the dependencies of a package, but the package cannot be found in
-/// the `package_config.json`.
-class UnresolvedTransitiveDependencyException implements Exception {
-  UnresolvedTransitiveDependencyException._(this.dependencyName);
-
-  /// The dependency that failed to resolve
-  final String dependencyName;
-
-  @override
-  String toString() {
-    return 'Unresolved transitive dependency: $dependencyName. Did you forget to run "pub get"?';
-  }
-}
-
 String? _findOptionsForPubspec(String pubspecPath) {
   final analysisOptions = File(join(pubspecPath, 'analysis_options.yaml'));
   if (analysisOptions.existsSync()) return analysisOptions.path;
@@ -1009,34 +994,6 @@ class CustomLintProject {
   }
 }
 
-class _PackageAndPubspec {
-  _PackageAndPubspec({required this.package, required this.parentPubspec});
-
-  final Package package;
-  final Pubspec parentPubspec;
-}
-
-class _PackageNameAndPubspec {
-  _PackageNameAndPubspec({
-    required this.packageName,
-    required this.parentPubspec,
-  });
-
-  static Iterable<_PackageNameAndPubspec> fromPubspecDependencies(
-    Pubspec pubspec,
-  ) {
-    return pubspec.dependencies.keys.map(
-      (packageName) => _PackageNameAndPubspec(
-        packageName: packageName,
-        parentPubspec: pubspec,
-      ),
-    );
-  }
-
-  final String packageName;
-  final Pubspec parentPubspec;
-}
-
 /// A custom_lint plugin and its version constraints.
 @internal
 class CustomLintPlugin {
@@ -1075,80 +1032,6 @@ class CustomLintPlugin {
 
   /// The version constraints in the project's `pubspec.yaml`.
   final PubspecDependency constraint;
-
-  /// Returns an iterable of the transitive dependencies of a Dart project
-  /// located at the given [directory]. The function uses the `pubspec.yaml`
-  /// and `package_config.json` files of the project to resolve the
-  /// transitive dependencies.
-  ///
-  /// The function uses a breadth-first search algorithm to traverse the
-  /// dependency tree. The root project's dependencies are processed first,
-  /// followed by their transitive dependencies, and so on.
-  ///
-  /// If a transitive dependency cannot be resolved (i.e., it is not listed
-  /// in the `package_config.json` file), the function throws an
-  /// [UnresolvedTransitiveDependencyException].
-  ///
-  /// The function will also throw if a pubspec/package_config.json could not
-  /// be decoded, such as if the file is missing or incorrectly formatted.
-  ///
-  /// Example usage:
-  /// ```dart
-  /// final dependencies = _listTransitiveDependencies('/path/to/my/project').toList();
-  /// ```
-  Iterable<_PackageAndPubspec> _visitSelfAndTransitiveDependencies(
-    PubspecCache pubspecCache,
-  ) sync* {
-    yield _PackageAndPubspec(
-      package: package,
-      parentPubspec: ownerPubspec,
-    );
-
-    // A map of of the packages defined in package_config.json for fast lookup.
-    // This avoids an O(n^2) lookup in the loop below.
-    final packages = Map.fromEntries(
-      ownerPackageConfig.packages.map((e) => MapEntry(e.name, e)),
-    );
-
-    // Only queue "dependencies" but no "dev_dependencies" or "dependency_overrides".
-    // This is plugins are considered in to be in "release mode", in which case
-    // dev only dependencies are not included.
-    final dependenciesToVisit = ListQueue<_PackageNameAndPubspec>.of(
-      _PackageNameAndPubspec.fromPubspecDependencies(pubspec),
-    );
-
-    /// The set of already visited pubspecs
-    final visited = <String>{};
-
-    while (dependenciesToVisit.isNotEmpty) {
-      // Check if the dependency is already visited
-      final dependency = dependenciesToVisit.removeFirst();
-      if (!visited.add(dependency.packageName)) continue;
-
-      // Emit the dependency's package metadata.
-      final package = packages[dependency.packageName];
-      if (package == null) {
-        throw UnresolvedTransitiveDependencyException._(dependency.packageName);
-      }
-
-      final packageDir = Directory.fromUri(package.root);
-      // TODO test error
-      final dependencyPubspec = pubspecCache(packageDir);
-
-      yield _PackageAndPubspec(
-        package: package,
-        parentPubspec: dependency.parentPubspec,
-      );
-
-      // Now queue the dependencies of the dependency to be emitted too.
-      // Only queue "dependencies" but no "dev_dependencies" or "dependency_overrides".
-      // This is plugins are considered in to be in "release mode", in which case
-      // dev only dependencies are not included.
-      dependenciesToVisit.addAll(
-        _PackageNameAndPubspec.fromPubspecDependencies(dependencyPubspec),
-      );
-    }
-  }
 }
 
 /// A dependency in a `pubspec.yaml`.
@@ -1317,201 +1200,3 @@ class SdkPubspecDependency extends PubspecDependency {
     return 'From SDK: ${dependency.sdk}';
   }
 }
-
-class _ConflictEntry {
-  _ConflictEntry(
-    this.plugin,
-    this.project,
-    this.packageMeta, {
-    required this.workingDirectory,
-  });
-
-  final CustomLintPlugin plugin;
-  final CustomLintProject project;
-  final _PackageAndPubspec packageMeta;
-  final Directory workingDirectory;
-
-  /// Whether [packageMeta] is the plugin itself.
-  late final bool _isPlugin = packageMeta.package.name == plugin.name;
-
-  String get _name => packageMeta.package.name;
-
-  PubspecDependency _dependency() {
-    // Short path for when the constraint is readily available.
-    if (_isPlugin) return plugin.constraint;
-
-    final dependency = packageMeta.parentPubspec.getDependency(_name);
-    if (dependency == null) {
-      // TODO test error
-      throw ArgumentError(
-        'Package ${packageMeta.parentPubspec.name} does not depend on package $_name\n${packageMeta.parentPubspec.dependencies}',
-      );
-    }
-
-    return PubspecDependency.fromDependency(dependency);
-  }
-
-  String buildConflictHeader() {
-    if (_isPlugin) {
-      return 'Plugin $_name:';
-    }
-    return 'Package $_name:';
-  }
-
-  String buildConflictingMessage() {
-    final trailingMessage = _isPlugin
-        ? 'Used by project "${project.pubspec.name}" at "${project.directory.relativeTo(workingDirectory)}"'
-        : 'Used by plugin "${plugin.name}" at "${plugin.directory.relativeTo(workingDirectory)}" '
-            'in the project "${project.pubspec.name}" at "${project.directory.relativeTo(workingDirectory)}"';
-    return '''
-- ${_dependency().buildShortDescription()}
-  Resolved with ${packageMeta.package.root.toFilePath()}
-  $trailingMessage''';
-  }
-}
-
-/// A class that checks if there are conflicting packages in the context roots.
-class _ConflictingPackagesChecker {
-  final _entries = <_ConflictEntry>[];
-
-  /// Registers a [Package] and its associated [CustomLintPlugin]/[CustomLintProject]
-  /// to be checked against version conflicts.
-  void addPluginPackage(
-    CustomLintProject project,
-    CustomLintPlugin plugin,
-    _PackageAndPubspec package, {
-    required Directory workingDirectory,
-  }) {
-    _entries.add(
-      _ConflictEntry(
-        plugin,
-        project,
-        package,
-        workingDirectory: workingDirectory,
-      ),
-    );
-  }
-
-  /// Throws an error if there are conflicting packages.
-  void throwErrorIfConflictingPackages() {
-    final packageNameRootMap = <String, Set<Uri>>{};
-    // Group packages by name and collect all unique roots,
-    // since we're using a set
-    for (final entry in _entries) {
-      final entriesForName =
-          packageNameRootMap[entry.packageMeta.package.name] ??= {};
-      entriesForName.add(entry.packageMeta.package.root);
-    }
-
-    // Find packages with more than one root
-    final packagesWithConflictingVersions = packageNameRootMap.entries
-        .where((entry) => entry.value.length > 1)
-        .map((e) => e.key)
-        .toSet();
-
-    // If there are no conflicting versions, return
-    if (packagesWithConflictingVersions.isEmpty) return;
-
-    throw PackageVersionConflictException._(
-      packagesWithConflictingVersions,
-      _entries,
-    );
-  }
-}
-
-/// An error thrown if a custom_lint workspace contains two or more projects
-/// which depend on the same package (directly or transitively) with different versions.
-class PackageVersionConflictException implements Exception {
-  PackageVersionConflictException._(
-    this._packagesWithConflictingVersions,
-    this._entries,
-  );
-
-  final Set<String> _packagesWithConflictingVersions;
-  final List<_ConflictEntry> _entries;
-
-  @override
-  String toString() {
-    final conflictingEntriesByPackages = Map.fromEntries(
-      _packagesWithConflictingVersions.map(
-        (packageName) => MapEntry(
-          packageName,
-          _entries
-              .where((entry) => entry.packageMeta.package.name == packageName)
-              .sortedBy((value) => value.project.pubspec.name),
-        ),
-      ),
-    );
-
-    final errorMessageBuilder = StringBuffer('''
-PackageVersionConflictException – Some dependencies with conflicting versions were identified:
-
-''');
-
-    // Build conflicting packages message
-    for (final conflictingEntriesForPackage
-        in conflictingEntriesByPackages.values) {
-      errorMessageBuilder.writeln(
-        conflictingEntriesForPackage.first.buildConflictHeader(),
-      );
-      for (final conflictEntry in conflictingEntriesForPackage) {
-        errorMessageBuilder.writeln(conflictEntry.buildConflictingMessage());
-      }
-      errorMessageBuilder.writeln();
-    }
-
-    errorMessageBuilder
-      ..writeln(
-        'This is not supported. Custom_lint shares the analysis between all'
-        ' packages. As such, all plugins are started under a single process,'
-        ' sharing the dependencies of all the packages that use custom_lint. '
-        "Since there's a single process for all plugins, if 2 plugins try to"
-        ' use different versions for a dependency, the process cannot be '
-        'reasonably started. Please make sure all packages have the same version.',
-      )
-      ..writeln('You could run the following commands to try fixing this:')
-      ..writeln();
-
-    // Organize conflicting packages by project instead of by name
-    final conflictingEntriesByProjects =
-        <CustomLintProject, List<_ConflictEntry>>{};
-    for (final conflictingEntriesForPackage
-        in conflictingEntriesByPackages.values) {
-      for (final conflictEntry in conflictingEntriesForPackage) {
-        final project = conflictEntry.project;
-        final projectConflictingEntries =
-            conflictingEntriesByProjects[project] ?? [];
-        projectConflictingEntries.add(conflictEntry);
-        conflictingEntriesByProjects[project] = projectConflictingEntries;
-      }
-    }
-
-    // Build fix commands
-    for (final conflictingEntriesForProject
-        in conflictingEntriesByProjects.entries) {
-      final pubspec = conflictingEntriesForProject.key.pubspec;
-      final isFlutter = pubspec.dependencies.containsKey('flutter');
-
-      final command = isFlutter ? 'flutter' : 'dart';
-
-      final conflictingPackageEntries = conflictingEntriesForProject.value;
-      final conflictingPackagesNames = conflictingPackageEntries
-          .map((entry) => entry.packageMeta.package.name)
-          .join(' ');
-
-      errorMessageBuilder
-        ..writeln('cd ${conflictingEntriesForProject.key.directory.path}')
-        ..writeln('$command pub upgrade $conflictingPackagesNames');
-    }
-
-    return errorMessageBuilder.toString();
-  }
-}
-
-extension on Pubspec {
-  Dependency? getDependency(String name) {
-    return dependencies[name] ??
-        devDependencies[name] ??
-        dependencyOverrides[name];
-  }
-}