analyzer plugin template

analysis_options.yaml

@@ -1,6 +1,8 @@
 include: package:pedantic/analysis_options.yaml
 
 analyzer:
+  plugins:
+    - dart_code_metrics
   strong-mode:
     implicit-casts: false
     implicit-dynamic: false

lib/analyzer_plugin.dart

@@ -0,0 +1 @@
+export 'package:dart_code_metrics/src/analyzer_plugin_starter.dart';

lib/src/analyzer_plugin/analyzer_plugin.dart

@@ -0,0 +1,97 @@
+import 'dart:async';
+
+import 'package:analyzer/dart/analysis/results.dart';
+import 'package:analyzer/file_system/file_system.dart';
+import 'package:analyzer/src/context/builder.dart';
+import 'package:analyzer/src/context/context_root.dart';
+import 'package:analyzer/src/dart/analysis/driver.dart';
+import 'package:analyzer_plugin/plugin/plugin.dart';
+import 'package:analyzer_plugin/protocol/protocol_common.dart' as plugin;
+import 'package:analyzer_plugin/protocol/protocol_generated.dart' as plugin;
+import 'package:dart_code_metrics/src/analyzer_plugin/checker.dart';
+
+class MetricsAnalyzerPlugin extends ServerPlugin {
+  final Checker checker = Checker();
+
+  MetricsAnalyzerPlugin(ResourceProvider provider) : super(provider);
+
+  @override
+  AnalysisDriverGeneric createAnalysisDriver(plugin.ContextRoot contextRoot) {
+    final root = ContextRoot(contextRoot.root, contextRoot.exclude,
+        pathContext: resourceProvider.pathContext)
+      ..optionsFilePath = contextRoot.optionsFile;
+    final contextBuilder = ContextBuilder(resourceProvider, sdkManager, null)
+      ..analysisDriverScheduler = analysisDriverScheduler
+      ..byteStore = byteStore
+      ..performanceLog = performanceLog
+      ..fileContentOverlay = fileContentOverlay;
+    final result = contextBuilder.buildDriver(root);
+    result.results.listen(_processResult);
+    return result;
+  }
+
+  @override
+  List<String> get fileGlobsToAnalyze => const ['*.dart'];
+
+  @override
+  String get name => 'Dart Code Metrics';
+
+  @override
+  String get version => '1.4.0';
+
+  @override
+  String get contactInfo => 'https://github.com/wrike/dart-code-metrics/issues';
+
+  void _processResult(ResolvedUnitResult analysisResult) {
+    try {
+      if (analysisResult.unit == null ||
+          analysisResult.libraryElement == null) {
+        channel.sendNotification(
+            plugin.AnalysisErrorsParams(analysisResult.path, [])
+                .toNotification());
+      } else {
+        final checkResult = checker.check(analysisResult.libraryElement);
+        channel.sendNotification(plugin.AnalysisErrorsParams(
+                analysisResult.path, checkResult.keys.toList())
+            .toNotification());
+      }
+    } catch (e, stackTrace) {
+      channel.sendNotification(
+          plugin.PluginErrorParams(false, e.toString(), stackTrace.toString())
+              .toNotification());
+    }
+  }
+
+  @override
+  void contentChanged(String path) {
+    super.driverForPath(path).addFile(path);
+  }
+
+  @override
+  Future<plugin.EditGetFixesResult> handleEditGetFixes(
+      plugin.EditGetFixesParams parameters) async {
+    try {
+      final analysisResult =
+          await (driverForPath(parameters.file) as AnalysisDriver)
+              .getResult(parameters.file);
+
+      final checkResult = checker.check(analysisResult.libraryElement);
+
+      final fixes = <plugin.AnalysisErrorFixes>[];
+      for (var error in checkResult.keys) {
+        if (error.location.file == parameters.file &&
+            checkResult[error].change.edits.single.edits.isNotEmpty) {
+          fixes.add(
+              plugin.AnalysisErrorFixes(error, fixes: [checkResult[error]]));
+        }
+      }
+
+      return plugin.EditGetFixesResult(fixes);
+    } catch (e, stackTrace) {
+      channel.sendNotification(
+          plugin.PluginErrorParams(false, e.toString(), stackTrace.toString())
+              .toNotification());
+      return plugin.EditGetFixesResult([]);
+    }
+  }
+}

lib/src/analyzer_plugin/checker.dart

@@ -0,0 +1,12 @@
+import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer_plugin/protocol/protocol_common.dart';
+import 'package:analyzer_plugin/protocol/protocol_generated.dart';
+
+class Checker {
+  Map<AnalysisError, PrioritizedSourceChange> check(
+      LibraryElement libraryElement) {
+    final result = <AnalysisError, PrioritizedSourceChange>{};
+
+    return result;
+  }
+}

lib/src/analyzer_plugin_starter.dart

@@ -0,0 +1,10 @@
+import 'dart:isolate';
+
+import 'package:analyzer/file_system/physical_file_system.dart';
+import 'package:analyzer_plugin/starter.dart';
+import 'package:dart_code_metrics/src/analyzer_plugin/analyzer_plugin.dart';
+
+void start(Iterable<String> _, SendPort sendPort) {
+  ServerPluginStarter(MetricsAnalyzerPlugin(PhysicalResourceProvider.INSTANCE))
+      .start(sendPort);
+}

pubspec.yaml

@@ -10,6 +10,7 @@ environment:
 
 dependencies:
   analyzer: '>=0.38.0 <0.40.0'
+  analyzer_plugin: ^0.2.1
   ansicolor: ^1.0.0
   args: ^1.5.0
   crypto: ^2.1.0

tools/analyzer_plugin/bin/plugin.dart

@@ -0,0 +1,7 @@
+import 'dart:isolate';
+
+import 'package:dart_code_metrics/analyzer_plugin.dart';
+
+void main(List<String> args, SendPort sendPort) {
+  start(args, sendPort);
+}

tools/analyzer_plugin/pubspec.yaml

@@ -0,0 +1,9 @@
+name: dart_code_metrics_plugin_loader
+description: This pubspec determines the version of the analyzer plugin to load.
+version: 1.4.0
+
+environment:
+  sdk: ">=2.4.0 <3.0.0"
+
+dependencies:
+  dart_code_metrics: ^1.4.0