feat: Use linters from regular dependencies (#276)

Author: dickermoshe

packages/custom_lint/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased patch
+
+- Support installing custom_lint plugins in `dependencies:` instead of `dev_dependencies` (thanks to @dickermoshe).
+
 ## 0.6.9 - 2024-10-09
 
 - `custom_lint_core` upgraded to `0.6.9`

packages/custom_lint/lib/src/workspace.dart

@@ -602,22 +602,26 @@ publish_to: 'none'
   }
 
   void _writePubspecDependencies(StringBuffer buffer) {
+    // Collect all the dependencies for each package.
     final uniqueDependencyNames = projects.expand((e) sync* {
+      yield* e.pubspec.dependencies.keys;
       yield* e.pubspec.devDependencies.keys;
       yield* e.pubspec.dependencyOverrides.keys;
     }).toSet();
 
     final dependenciesByName = {
       for (final name in uniqueDependencyNames)
         name: (
-          devDependencies: projects
-              .map((project) {
-                final dependency = project.pubspec.devDependencies[name];
-                if (dependency == null) return null;
-                return (project: project, dependency: dependency);
-              })
-              .nonNulls
-              .toList(),
+          dependencies: projects.expand((project) {
+            final dependency = project.pubspec.dependencies[name];
+            final devDependency = project.pubspec.devDependencies[name];
+            return [
+              if (dependency != null)
+                (project: project, dependency: dependency),
+              if (devDependency != null)
+                (project: project, dependency: devDependency),
+            ];
+          }).toList(),
           dependencyOverrides: projects
               .map((project) {
                 final dependency = project.pubspec.dependencyOverrides[name];
@@ -629,37 +633,37 @@ publish_to: 'none'
         ),
     };
 
-    // A flag for whether the "dependencies:" header has been written.
-    var didWriteDevDependenciesHeader = false;
-    // Write dev_dependencies
+    final dependencies = <String, String>{};
+
+    // Iterate over each plugin and compute their constraints.
     for (final name in uniquePluginNames) {
       final allDependencies = dependenciesByName[name];
       if (allDependencies == null) continue;
 
-      // // We don't write dev_dependencies which are sometimes prod dependencies,
-      // // as dev_dependencies, because then we'd be specifying the dependency twice.
-      if (
-          // allDependencies.dependencies.isNotEmpty ||
-          allDependencies.devDependencies.isEmpty) {
+      if (allDependencies.dependencies.isEmpty) {
         continue;
       }
 
-      if (!didWriteDevDependenciesHeader) {
-        didWriteDevDependenciesHeader = true;
-        buffer.writeln('\ndev_dependencies:');
-      }
-
       final constraint = allDependencies.dependencyOverrides.isNotEmpty
           ? ' any'
           : _buildDependencyConstraint(
               name,
-              allDependencies.devDependencies,
+              allDependencies.dependencies,
               workingDirectory: workingDirectory,
               fileName: 'pubspec.yaml',
             );
-      buffer.writeln('  $name:$constraint');
+      dependencies[name] = constraint;
+    }
+
+    // Write the dependencies to the buffer.
+    if (dependencies.isNotEmpty) {
+      buffer.writeln('\ndependencies:');
+      for (final dependency in dependencies.entries) {
+        buffer.writeln('  ${dependency.key}:${dependency.value}');
+      }
     }
 
+    // Write the dependency_overrides to the buffer.
     _writeDependencyOverrides(
       buffer,
       dependencyOverrides: {
@@ -923,9 +927,11 @@ class CustomLintProject {
       );
     });
 
-    // TODO check that only dev_dependencies are checked
     final plugins = await Future.wait(
-      projectPubspec.devDependencies.entries.map((e) async {
+      {
+        ...projectPubspec.dependencies,
+        ...projectPubspec.devDependencies,
+      }.entries.map((e) async {
         final packageWithName = projectPackageConfig.packages
             .firstWhereOrNull((p) => p.name == e.key);
         if (packageWithName == null) {

packages/custom_lint/test/cli_test.dart

@@ -164,63 +164,68 @@ No issues found!
           expect(process.exitCode, 0);
         });
 
-        test('CLI lists warnings from all plugins and set exit code', () async {
-          final plugin =
-              createPlugin(name: 'test_lint', main: helloWordPluginSource);
-          final plugin2 =
-              createPlugin(name: 'test_lint2', main: oyPluginSource);
-
-          final app = createLintUsage(
-            source: {
-              'lib/main.dart': 'void fn() {}',
-              'lib/another.dart': 'void fail() {}',
-            },
-            plugins: {'test_lint': plugin.uri, 'test_lint2': plugin2.uri},
-            name: 'test_app',
-          );
+        for (final installAsDevDependency in [false, true]) {
+          test(
+              'CLI lists warnings from all plugins and set exit code installAsDevDependency: $installAsDevDependency',
+              () async {
+            final plugin =
+                createPlugin(name: 'test_lint', main: helloWordPluginSource);
+            final plugin2 =
+                createPlugin(name: 'test_lint2', main: oyPluginSource);
+
+            final app = createLintUsage(
+              source: {
+                'lib/main.dart': 'void fn() {}',
+                'lib/another.dart': 'void fail() {}',
+              },
+              plugins: {'test_lint': plugin.uri, 'test_lint2': plugin2.uri},
+              name: 'test_app',
+              installAsDevDependency: installAsDevDependency,
+            );
 
-          final process = await Process.start(
-            'dart',
-            [
-              customLintBinPath,
-              '--format',
-              format,
-            ],
-            workingDirectory: app.path,
-          );
+            final process = await Process.start(
+              'dart',
+              [
+                customLintBinPath,
+                '--format',
+                format,
+              ],
+              workingDirectory: app.path,
+            );
 
-          final out = process.stdout.map(utf8.decode);
-          final err = process.stderr.map(utf8.decode);
+            final out = process.stdout.map(utf8.decode);
+            final err = process.stderr.map(utf8.decode);
 
-          expect(err, emitsDone);
+            expect(err, emitsDone);
 
-          if (format == 'json') {
-            expect(
-              out.join(),
-              completion(
-                equals('${jsonLints(app.resolveSymbolicLinksSync())}\n'),
-              ),
-            );
-          } else {
-            expect(
-              out.join(),
-              completion(
-                allOf(
-                  startsWith('Analyzing...'),
-                  endsWith('''
+            if (format == 'json') {
+              expect(
+                out.join(),
+                completion(
+                  equals('${jsonLints(app.resolveSymbolicLinksSync())}\n'),
+                ),
+              );
+            } else {
+              expect(
+                out.join(),
+                completion(
+                  allOf(
+                    startsWith('Analyzing...'),
+                    endsWith('''
   lib/another.dart:1:6 • Hello world • hello_world • INFO
   lib/another.dart:1:6 • Oy • oy • INFO
   lib/main.dart:1:6 • Hello world • hello_world • INFO
   lib/main.dart:1:6 • Oy • oy • INFO
 
 4 issues found.
 '''),
+                  ),
                 ),
-              ),
-            );
-          }
-          expect(await process.exitCode, 1);
-        });
+              );
+            }
+            expect(await process.exitCode, 1);
+          });
+        }
       });
     }
   }

packages/custom_lint/test/create_project.dart

@@ -214,9 +214,10 @@ Directory createLintUsage({
   Map<String, Uri> plugins = const {},
   Map<String, String> source = const {},
   Map<String, Uri> extraPackageConfig = const {},
+  bool installAsDevDependency = true,
   required String name,
 }) {
-  final pluginDevDependencies = plugins.entries
+  final pluginDependencies = plugins.entries
       .map(
         (e) => '''
   ${e.key}:
@@ -244,11 +245,12 @@ environment:
 dependencies:
   analyzer: any
   analyzer_plugin: any
+${installAsDevDependency ? "" : pluginDependencies}
 
 dev_dependencies:
   custom_lint:
     path: ${PeerProjectMeta.current.customLintPath}
-$pluginDevDependencies
+${installAsDevDependency ? pluginDependencies : ""}
 ''',
     packageConfig: createPackageConfig(
       plugins: {...plugins, ...extraPackageConfig},