DAS plugins: Support fixes to ignore diagnostics

Change-Id: I71ae995d1a4a94ecfeafd187c5674c41b6d928d4
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/395702
Reviewed-by: Brian Wilkerson <[email protected]>
Commit-Queue: Samuel Rawlins <[email protected]>
Reviewed-by: Konstantin Shcheglov <[email protected]>

Author: srawlins

pkg/analysis_server/lib/src/g3/fixes.dart

@@ -3,12 +3,12 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analysis_server/src/protocol_server.dart' show SourceEdit;
-import 'package:analysis_server/src/services/correction/fix.dart';
 import 'package:analysis_server_plugin/edit/fix/dart_fix_context.dart';
 import 'package:analysis_server_plugin/edit/fix/fix.dart';
 import 'package:analysis_server_plugin/src/correction/dart_change_workspace.dart';
 import 'package:analysis_server_plugin/src/correction/fix_in_file_processor.dart';
 import 'package:analysis_server_plugin/src/correction/fix_processor.dart';
+import 'package:analysis_server_plugin/src/correction/ignore_diagnostic.dart';
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/file_system/file_system.dart';
@@ -110,9 +110,9 @@ class LintFixTester {
       fixes = await FixProcessor(context).compute();
       fixes.removeWhere(
         (fix) =>
-            fix.kind == DartFixKind.IGNORE_ERROR_LINE ||
-            fix.kind == DartFixKind.IGNORE_ERROR_FILE ||
-            fix.kind == DartFixKind.IGNORE_ERROR_ANALYSIS_FILE,
+            fix.kind == ignoreErrorLineKind ||
+            fix.kind == ignoreErrorFileKind ||
+            fix.kind == ignoreErrorAnalysisFileKind,
       );
     }
 

pkg/analysis_server/lib/src/services/correction/fix.dart

@@ -824,21 +824,6 @@ abstract final class DartFixKind {
     DartFixKindPriority.standard,
     'Extract local variable',
   );
-  static const IGNORE_ERROR_LINE = FixKind(
-    'dart.fix.ignore.line',
-    DartFixKindPriority.ignore,
-    "Ignore '{0}' for this line",
-  );
-  static const IGNORE_ERROR_FILE = FixKind(
-    'dart.fix.ignore.file',
-    DartFixKindPriority.ignore - 1,
-    "Ignore '{0}' for the whole file",
-  );
-  static const IGNORE_ERROR_ANALYSIS_FILE = FixKind(
-    'dart.fix.ignore.analysis',
-    DartFixKindPriority.ignore - 2,
-    "Ignore '{0}' in `analysis_options.yaml`",
-  );
   static const IMPORT_ASYNC = FixKind(
     'dart.fix.import.async',
     49,

pkg/analysis_server/lib/src/services/correction/fix_internal.dart

@@ -103,7 +103,6 @@ import 'package:analysis_server/src/services/correction/dart/data_driven.dart';
 import 'package:analysis_server/src/services/correction/dart/extend_class_for_mixin.dart';
 import 'package:analysis_server/src/services/correction/dart/extract_local_variable.dart';
 import 'package:analysis_server/src/services/correction/dart/flutter_remove_widget.dart';
-import 'package:analysis_server/src/services/correction/dart/ignore_diagnostic.dart';
 import 'package:analysis_server/src/services/correction/dart/import_library.dart';
 import 'package:analysis_server/src/services/correction/dart/inline_invocation.dart';
 import 'package:analysis_server/src/services/correction/dart/inline_typedef.dart';
@@ -250,6 +249,7 @@ import 'package:analysis_server/src/services/correction/dart/wrap_in_text.dart';
 import 'package:analysis_server/src/services/correction/dart/wrap_in_unawaited.dart';
 import 'package:analysis_server_plugin/src/correction/fix_generators.dart';
 import 'package:analysis_server_plugin/src/correction/fix_processor.dart';
+import 'package:analysis_server_plugin/src/correction/ignore_diagnostic.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/src/dart/error/ffi_code.g.dart';
 import 'package:analyzer/src/error/codes.dart';

pkg/analysis_server/test/src/services/correction/fix/ignore_diagnostic_test.dart

@@ -2,7 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-import 'package:analysis_server/src/services/correction/fix.dart';
+import 'package:analysis_server_plugin/src/correction/ignore_diagnostic.dart';
 import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
 import 'package:test_reflective_loader/test_reflective_loader.dart';
 
@@ -19,7 +19,7 @@ void main() {
 @reflectiveTest
 class IgnoreDiagnosticAnalysisOptionFileTest extends FixProcessorTest {
   @override
-  FixKind get kind => DartFixKind.IGNORE_ERROR_ANALYSIS_FILE;
+  FixKind get kind => ignoreErrorAnalysisFileKind;
 
   @override
   void setUp() {
@@ -187,7 +187,7 @@ void f() {
 @reflectiveTest
 class IgnoreDiagnosticFileTest extends FixProcessorTest {
   @override
-  FixKind get kind => DartFixKind.IGNORE_ERROR_FILE;
+  FixKind get kind => ignoreErrorFileKind;
 
   Future<void> test_cannotIgnore_other() async {
     createAnalysisOptionsFile(
@@ -304,7 +304,7 @@ void f() {
 @reflectiveTest
 class IgnoreDiagnosticLineTest extends FixProcessorTest {
   @override
-  FixKind get kind => DartFixKind.IGNORE_ERROR_LINE;
+  FixKind get kind => ignoreErrorLineKind;
 
   Future<void> test_cannotIgnore_other() async {
     createAnalysisOptionsFile(

pkg/analysis_server/lib/src/services/correction/dart/ignore_diagnostic.dart renamed to pkg/analysis_server_plugin/lib/src/correction/ignore_diagnostic.dart

@@ -1,9 +1,9 @@
-// Copyright (c) 2021, the Dart project authors. Please see the AUTHORS file
+// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-import 'package:analysis_server/src/services/correction/fix.dart';
 import 'package:analysis_server_plugin/edit/dart/correction_producer.dart';
+import 'package:analysis_server_plugin/edit/dart/dart_fix_kind_priority.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/src/dart/analysis/analysis_options.dart';
@@ -16,17 +16,32 @@ import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
 import 'package:yaml/yaml.dart';
 import 'package:yaml_edit/yaml_edit.dart' show YamlEditor;
 
+const ignoreErrorAnalysisFileKind = FixKind(
+  'dart.fix.ignore.analysis',
+  DartFixKindPriority.ignore - 2,
+  "Ignore '{0}' in `analysis_options.yaml`",
+);
+const ignoreErrorFileKind = FixKind(
+  'dart.fix.ignore.file',
+  DartFixKindPriority.ignore - 1,
+  "Ignore '{0}' for the whole file",
+);
+const ignoreErrorLineKind = FixKind(
+  'dart.fix.ignore.line',
+  DartFixKindPriority.ignore,
+  "Ignore '{0}' for this line",
+);
+
 class IgnoreDiagnosticInAnalysisOptionsFile extends _BaseIgnoreDiagnostic {
   IgnoreDiagnosticInAnalysisOptionsFile({required super.context});
 
   @override
   CorrectionApplicability get applicability =>
-          // TODO(applicability): comment on why.
-          CorrectionApplicability
-          .singleLocation;
+      // TODO(applicability): comment on why.
+      CorrectionApplicability.singleLocation;
 
   @override
-  FixKind get fixKind => DartFixKind.IGNORE_ERROR_ANALYSIS_FILE;
+  FixKind get fixKind => ignoreErrorAnalysisFileKind;
 
   @override
   Future<void> compute(ChangeBuilder builder) async {
@@ -112,7 +127,7 @@ class IgnoreDiagnosticInFile extends _DartIgnoreDiagnostic {
   String get commentPrefix => 'ignore_for_file';
 
   @override
-  FixKind get fixKind => DartFixKind.IGNORE_ERROR_FILE;
+  FixKind get fixKind => ignoreErrorFileKind;
 
   @override
   Future<void> compute(ChangeBuilder builder) async {
@@ -178,7 +193,7 @@ class IgnoreDiagnosticOnLine extends _DartIgnoreDiagnostic {
   String get commentPrefix => 'ignore';
 
   @override
-  FixKind get fixKind => DartFixKind.IGNORE_ERROR_LINE;
+  FixKind get fixKind => ignoreErrorLineKind;
 
   @override
   Future<void> compute(ChangeBuilder builder) async {
@@ -216,9 +231,8 @@ abstract class _BaseIgnoreDiagnostic extends ResolvedCorrectionProducer {
 
   @override
   CorrectionApplicability get applicability =>
-          // TODO(applicability): comment on why.
-          CorrectionApplicability
-          .singleLocation;
+      // TODO(applicability): comment on why.
+      CorrectionApplicability.singleLocation;
 
   AnalysisError get error => diagnostic as AnalysisError;
 
@@ -231,7 +245,8 @@ abstract class _BaseIgnoreDiagnostic extends ResolvedCorrectionProducer {
   /// - `error.code` is present in the `cannot-ignore` list.
   /// - `error.code` is already ignored in the `errors` list.
   bool get _isCodeUnignorable {
-    var cannotIgnore = (analysisOptions as AnalysisOptionsImpl).unignorableNames
+    var cannotIgnore = (analysisOptions as AnalysisOptionsImpl)
+        .unignorableNames
         .contains(error.errorCode.name);
 
     if (cannotIgnore) {

pkg/analysis_server_plugin/lib/src/plugin_server.dart

@@ -85,6 +85,7 @@ class PluginServer {
     for (var plugin in plugins) {
       plugin.register(_registry);
     }
+    _registry.registerIgnoreProducerGenerators();
   }
 
   /// Handles an 'analysis.setPriorityFiles' request.

pkg/analysis_server_plugin/lib/src/registry.dart

@@ -4,6 +4,7 @@
 
 import 'package:analysis_server_plugin/registry.dart';
 import 'package:analysis_server_plugin/src/correction/fix_generators.dart';
+import 'package:analysis_server_plugin/src/correction/ignore_diagnostic.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/src/lint/linter.dart';
 import 'package:analyzer/src/lint/registry.dart';
@@ -17,6 +18,15 @@ final class PluginRegistryImpl implements PluginRegistry {
     registeredFixGenerators.registerFixForLint(code, generator);
   }
 
+  /// Registers the "ignore diagnostic" producer generators.
+  void registerIgnoreProducerGenerators() {
+    registeredFixGenerators.ignoreProducerGenerators.addAll([
+      IgnoreDiagnosticOnLine.new,
+      IgnoreDiagnosticInFile.new,
+      IgnoreDiagnosticInAnalysisOptionsFile.new,
+    ]);
+  }
+
   @override
   void registerLintRule(AnalysisRule rule) {
     Registry.ruleRegistry.registerLintRule(rule);

pkg/analysis_server_plugin/pubspec.yaml

@@ -10,6 +10,8 @@ dependencies:
   analyzer: ^7.3.0
   analyzer_plugin: ^0.13.0
   meta: ^1.16.0
+  yaml: ^3.1.0
+  yaml_edit: ^2.2.0
 
 # Use 'any' constraints here; we get our versions from the DEPS file.
 dev_dependencies:

pkg/analysis_server_plugin/test/src/plugin_server_test.dart

@@ -94,12 +94,9 @@ bool b = false;
 
     var result = await pluginServer.handleEditGetFixes(
         protocol.EditGetFixesParams(filePath, 'bool b = '.length));
-    var fixes = result.fixes;
-    // We expect 1 fix because neither `IgnoreDiagnosticOnLine` nor
-    // `IgnoreDiagnosticInFile` are registered by the plugin.
-    // TODO(srawlins): Investigate whether they should be.
-    expect(fixes, hasLength(1));
-    expect(fixes[0].fixes, hasLength(1));
+    var fixes = result.fixes.single;
+    // The WrapInQuotes fix plus three "ignore diagnostic" fixes.
+    expect(fixes.fixes, hasLength(4));
   }
 
   Future<void> test_lintDiagnosticsAreDisabledByDefault() async {