Deprecate RangeFactory.error in favor of RangeFactory.diagnostic

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

Author: srawlins

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

@@ -182,7 +182,7 @@ class AddConst extends ResolvedCorrectionProducer {
             error.diagnosticCode == LinterLintCode.prefer_const_constructors,
       ),
     ];
-    var ranges = diagnostics.map(range.error);
+    var ranges = diagnostics.map(range.diagnostic);
     var variablesRanges = variables.map((v) {
       var initializer = v.initializer;
       if (initializer == null) return range.node(v);

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

@@ -25,7 +25,7 @@ class ReplaceBooleanWithBool extends ResolvedCorrectionProducer {
   Future<void> compute(ChangeBuilder builder) async {
     if (diagnostic case var diagnostic?) {
       await builder.addDartFileEdit(file, (builder) {
-        builder.addSimpleReplacement(range.error(diagnostic), 'bool');
+        builder.addSimpleReplacement(range.diagnostic(diagnostic), 'bool');
       });
     }
   }

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

@@ -28,7 +28,10 @@ class ReplaceContainerWithColoredBox extends ResolvedCorrectionProducer {
     var diagnostic = this.diagnostic;
     if (diagnostic is Diagnostic) {
       await builder.addDartFileEdit(file, (builder) {
-        builder.addSimpleReplacement(range.error(diagnostic), 'ColoredBox');
+        builder.addSimpleReplacement(
+          range.diagnostic(diagnostic),
+          'ColoredBox',
+        );
       });
     }
   }

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

@@ -28,7 +28,7 @@ class ReplaceContainerWithSizedBox extends ResolvedCorrectionProducer {
     var diagnostic = this.diagnostic;
     if (diagnostic is Diagnostic) {
       await builder.addDartFileEdit(file, (builder) {
-        builder.addSimpleReplacement(range.error(diagnostic), 'SizedBox');
+        builder.addSimpleReplacement(range.diagnostic(diagnostic), 'SizedBox');
       });
     }
   }

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

@@ -27,7 +27,7 @@ class ReplaceNullWithVoid extends ResolvedCorrectionProducer {
     var diagnostic = this.diagnostic;
     if (diagnostic is Diagnostic) {
       await builder.addDartFileEdit(file, (builder) {
-        builder.addSimpleReplacement(range.error(diagnostic), 'void');
+        builder.addSimpleReplacement(range.diagnostic(diagnostic), 'void');
       });
     }
   }

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

@@ -25,7 +25,7 @@ class ReplaceVarWithDynamic extends ResolvedCorrectionProducer {
     var diagnostic = this.diagnostic;
     if (diagnostic is Diagnostic) {
       await builder.addDartFileEdit(file, (builder) {
-        builder.addSimpleReplacement(range.error(diagnostic), 'dynamic');
+        builder.addSimpleReplacement(range.diagnostic(diagnostic), 'dynamic');
       });
     }
   }

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

@@ -35,7 +35,7 @@ class ReplaceWithNamedConstant extends ResolvedCorrectionProducer {
       }
 
       await builder.addDartFileEdit(file, (builder) {
-        builder.addSimpleReplacement(range.error(diagnostic), correction);
+        builder.addSimpleReplacement(range.diagnostic(diagnostic), correction);
       });
     }
   }

pkg/analyzer_plugin/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.13.2
+- Deprecated: `RangeFactory.error` is replaced by `RangeFactory.diagnostic`.
+
 ## 0.13.1
 - Updated SDK constraint to `^3.5.0`.
 - Require version `7.4.x` of the `analyzer` package.

pkg/analyzer_plugin/lib/utilities/range_factory.dart

@@ -14,6 +14,7 @@ final RangeFactory range = RangeFactory();
 
 /// A factory used to create instances of [SourceRange] based on various
 /// syntactic and semantic entities.
+// TODO(srawlins): Make this class final.
 class RangeFactory {
   /// Return a source range that covers all of the arguments in the
   /// [argumentList] between the [lower] and [upper] indices, inclusive. The
@@ -95,6 +96,10 @@ class RangeFactory {
     return startOffsetEndOffset(startOffset, endOffset);
   }
 
+  /// A source range that covers the same range as the given [diagnostic].
+  SourceRange diagnostic(Diagnostic diagnostic) =>
+      SourceRange(diagnostic.offset, diagnostic.length);
+
   /// Return a source range that starts at the end of [leftEntity] and ends at
   /// the end of [rightEntity].
   SourceRange endEnd(SyntacticEntity leftEntity, SyntacticEntity rightEntity) {
@@ -123,12 +128,8 @@ class RangeFactory {
     return SourceRange(node.offset, node.length);
   }
 
-  /// Returns a source range that covers the same range as the given
-  /// [diagnostic].
-  // TODO(srawlins): Rename to 'diagnostic'.
-  SourceRange error(Diagnostic diagnostic) {
-    return SourceRange(diagnostic.offset, diagnostic.length);
-  }
+  @Deprecated("Use 'diagnostic' instead")
+  SourceRange error(Diagnostic d) => diagnostic(d);
 
   /// Returns a source range that covers the name of the given [fragment].
   ///

pkg/analyzer_plugin/test/utilities/range_factory_test.dart

@@ -538,7 +538,7 @@ const class B {}
 ''');
     var result = await resolveFile(testFile);
     var diagnostic = result.diagnostics.single;
-    expect(range.error(diagnostic), SourceRange(11, 5));
+    expect(range.diagnostic(diagnostic), SourceRange(11, 5));
   }
 
   Future<void> test_node() async {