[analysis_server] Change default leading/trailing behaviour for replaceSourceIndent

Makes behaviour of changing leading indent or trailing newlines opt-in.

There are only slightly more uses of this method that don't want this (now opt-in) behaviour, although I think this is slightly less surprising (for example the trailing newline behaviour was to "add a trailing newline only if it didn't already exist" which I don't think was obvious).

Mostly this was just changing the defaults and all of the call sites. However, some call sites were getting the old behaviour (inc leading/trailing whitespace), but then calling `.trim()`, so I didn't add the opt-in there because it would then be removed (they won't show up in the diff because they didn't actually get any changes).

Change-Id: I2f05b3a6266aaad5ee510ce2a8bf269b26d42d5d
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/329540
Reviewed-by: Brian Wilkerson <[email protected]>
Commit-Queue: Brian Wilkerson <[email protected]>
Reviewed-by: Phil Quitslund <[email protected]>

Author: DanTup

pkg/analysis_server/lib/src/services/completion/postfix/postfix_completion.dart

@@ -350,7 +350,8 @@ class PostfixCompletionProcessor {
         builder.write('try {');
         builder.write(eol);
         builder.write(utils.replaceSourceIndent(
-            src, indent, '$indent${utils.getIndent(1)}'));
+            src, indent, '$indent${utils.getIndent(1)}',
+            includeLeading: true, ensureTrailingNewline: true));
         builder.selectHere();
         builder.write(indent);
         builder.write('}');

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

@@ -30,8 +30,6 @@ class ConvertFlutterChildren extends ResolvedCorrectionProducer {
               widgetText,
               indentOld,
               indentNew,
-              includeLeading: false,
-              includeTrailingNewline: false,
             );
 
             await builder.addDartFileEdit(file, (builder) {

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

@@ -134,6 +134,8 @@ class ConvertToIfCaseStatementChain extends ResolvedCorrectionProducer {
       range,
       firstIndent,
       blockIndent + singleIndent,
+      includeLeading: true,
+      ensureTrailingNewline: true,
     );
     builder.write(code);
   }

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

@@ -158,6 +158,8 @@ class ConvertIfStatementToSwitchStatement extends ResolvedCorrectionProducer {
       range,
       ifStatementIndent,
       newIndent,
+      includeLeading: true,
+      ensureTrailingNewline: true,
     );
 
     builder.write(code);

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

@@ -78,8 +78,6 @@ class FlutterConvertToChildren extends ResolvedCorrectionProducer {
         childArgSrc,
         indentOld,
         indentNew,
-        includeLeading: false,
-        includeTrailingNewline: false,
       );
       newChildArgSrc = '$prefix$newChildArgSrc,$eol$indentOld]';
       builder.addSimpleReplacement(range.node(childArg), newChildArgSrc);

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

@@ -108,8 +108,6 @@ class FlutterRemoveWidget extends ResolvedCorrectionProducer {
         childText,
         indentOld,
         indentNew,
-        includeLeading: false,
-        includeTrailingNewline: false,
       );
       builder.addSimpleReplacement(range.node(widgetCreation), childText);
     });
@@ -128,8 +126,6 @@ class FlutterRemoveWidget extends ResolvedCorrectionProducer {
         childText,
         indentOld,
         indentNew,
-        includeLeading: false,
-        includeTrailingNewline: false,
       );
       builder.addSimpleReplacement(range.node(widgetCreation), childText);
     });

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

@@ -44,8 +44,6 @@ abstract class FlutterParentAndChild extends ResolvedCorrectionProducer {
               text,
               childIndent,
               parentIndent,
-              includeLeading: false,
-              includeTrailingNewline: false,
             );
             builder.write(parentIndent);
             builder.write('  ');
@@ -70,8 +68,6 @@ abstract class FlutterParentAndChild extends ResolvedCorrectionProducer {
               text,
               parentIndent,
               childIndent,
-              includeLeading: false,
-              includeTrailingNewline: false,
             );
             builder.write(childIndent);
             builder.write('  ');

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

@@ -234,8 +234,6 @@ abstract class _WrapMultipleWidgets extends ResolvedCorrectionProducer {
           src,
           indentOld,
           indentNew2,
-          includeLeading: false,
-          includeTrailingNewline: false,
         );
         builder.write(indentNew2);
         builder.write(newSrc);
@@ -314,8 +312,6 @@ abstract class _WrapSingleWidget extends ResolvedCorrectionProducer {
             widgetSrc,
             indentOld,
             indentNew,
-            includeLeading: false,
-            includeTrailingNewline: false,
           );
           widgetSrc += ',$eol$indentOld';
         }

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

@@ -49,8 +49,6 @@ class FlutterWrapBuilder extends ResolvedCorrectionProducer {
           widgetSrc,
           indentOld,
           indentNew2,
-          includeLeading: false,
-          includeTrailingNewline: false,
         );
         builder.write(indentNew2);
         builder.write('return $widgetSrc');

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

@@ -47,8 +47,6 @@ class FlutterWrapGeneric extends ResolvedCorrectionProducer {
           literalSrc,
           indentOld,
           indentList,
-          includeLeading: false,
-          includeTrailingNewline: false,
         ));
         builder.write(',');
         builder.write(eol);

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

@@ -54,8 +54,6 @@ class FlutterWrapStreamBuilder extends ResolvedCorrectionProducer {
           widgetSrc,
           indentOld,
           indentNew2,
-          includeLeading: false,
-          includeTrailingNewline: false,
         );
         builder.write(indentNew2);
         builder.write('return $widgetSrc');

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

@@ -92,7 +92,8 @@ class SplitAndCondition extends ResolvedCorrectionProducer {
         builder.addSimpleReplacement(
             linesRange,
             utils.replaceSourceRangeIndent(
-                linesRange, thenIndentOld, thenIndentNew));
+                linesRange, thenIndentOld, thenIndentNew,
+                includeLeading: true, ensureTrailingNewline: true));
       }
     });
   }

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

@@ -48,8 +48,9 @@ class SurroundWith extends MultiCorrectionProducer {
     // prepare environment
     var indentOld = utils.getNodePrefix(firstStatement);
     var indentNew = '$indentOld${utils.getIndent(1)}';
-    var indentedCode =
-        utils.replaceSourceRangeIndent(statementsRange, indentOld, indentNew);
+    var indentedCode = utils.replaceSourceRangeIndent(
+        statementsRange, indentOld, indentNew,
+        includeLeading: true, ensureTrailingNewline: true);
 
     return [
       _SurroundWithBlock(statementsRange, indentOld, indentNew, indentedCode),
@@ -98,8 +99,8 @@ class _SurroundWithBlock extends _SurroundWith {
       builder.addSimpleInsertion(statementsRange.offset, '$indentOld{$eol');
       builder.addSimpleReplacement(
           statementsRange,
-          utils.replaceSourceRangeIndent(
-              statementsRange, indentOld, indentNew));
+          utils.replaceSourceRangeIndent(statementsRange, indentOld, indentNew,
+              includeLeading: true, ensureTrailingNewline: true));
       builder.addSimpleInsertion(statementsRange.end, '$indentOld}$eol');
     });
   }

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

@@ -1236,15 +1236,18 @@ class CorrectionUtils {
   /// Returns the source with indentation changed from [oldIndent] to
   /// [newIndent], keeping indentation of lines relative to each other.
   ///
-  /// If [includeLeading] is `false`, indentation on the first line will not be
-  /// altered. This should be used if the provided string is a substring of code
-  /// that does not begin and end at line boundaries and [oldIndent] may be
-  /// an empty string.
+  /// Indentation on the first line will only be updated if [includeLeading] is
+  /// `true`.
   ///
-  /// Unless [includeTrailingNewline] is `false`, a newline will be added to
-  /// the end of the returned code.
+  /// If [ensureTrailingNewline] is `true`, a newline will be added to
+  /// the end of the returned code if it does not already have one.
+  ///
+  /// Usually [includeLeading] and [ensureTrailingNewline] will both be set
+  /// together when indenting a set of statements to go inside a block (as
+  /// opposed to just wrapping a nested expression that might span multiple
+  /// lines).
   String replaceSourceIndent(String source, String oldIndent, String newIndent,
-      {bool includeLeading = true, bool includeTrailingNewline = true}) {
+      {bool includeLeading = false, bool ensureTrailingNewline = false}) {
     // prepare STRING token ranges
     var lineRanges = <SourceRange>[];
     {
@@ -1262,12 +1265,17 @@ class CorrectionUtils {
     var lineOffset = 0;
     for (var i = 0; i < lines.length; i++) {
       var line = lines[i];
-      var doReplaceWhitespace = i != 0 || includeLeading;
-      var doAppendEol = i != lines.length - 1 || includeTrailingNewline;
-      // last line, stop if empty
+      // Exit early if this is the last line and it's already empty, to avoid
+      // inserting any whitespace or appending an additional newline if
+      // [ensureTrailingNewline].
       if (i == lines.length - 1 && isEmpty(line)) {
         break;
       }
+      // Don't replace whitespace on first line unless [includeLeading].
+      var doReplaceWhitespace = i != 0 || includeLeading;
+      // Don't add eol to last line unless [ensureTrailingNewline].
+      var doAppendEol = i != lines.length - 1 || ensureTrailingNewline;
+
       // check if "offset" is in one of the String ranges
       var inString = false;
       for (var lineRange in lineRanges) {
@@ -1295,10 +1303,24 @@ class CorrectionUtils {
   /// Returns the source of the given [SourceRange] with indentation changed
   /// from [oldIndent] to [newIndent], keeping indentation of lines relative
   /// to each other.
+  ///
+  /// Indentation on the first line will only be updated if [includeLeading] is
+  /// `true`.
+  ///
+  /// If [ensureTrailingNewline] is `true`, a newline will be added to
+  /// the end of the returned code if it does not already have one.
+  ///
+  /// Usually [includeLeading] and [ensureTrailingNewline] will both be set
+  /// together when indenting a set of statements to go inside a block (as
+  /// opposed to just wrapping a nested expression that might span multiple
+  /// lines).
   String replaceSourceRangeIndent(
-      SourceRange range, String oldIndent, String newIndent) {
+      SourceRange range, String oldIndent, String newIndent,
+      {bool includeLeading = false, bool ensureTrailingNewline = false}) {
     var oldSource = getRangeText(range);
-    return replaceSourceIndent(oldSource, oldIndent, newIndent);
+    return replaceSourceIndent(oldSource, oldIndent, newIndent,
+        includeLeading: includeLeading,
+        ensureTrailingNewline: ensureTrailingNewline);
   }
 
   /// Return `true` if [selection] covers [node] and there are any

pkg/analysis_server/lib/src/services/refactoring/legacy/extract_method.dart

@@ -668,7 +668,8 @@ class ExtractMethodRefactoringImpl extends RefactoringImpl
     if (selectionStatements != null) {
       var selectionIndent = utils.getNodePrefix(selectionStatements[0]);
       var targetIndent = '${utils.getNodePrefix(_parentMember!)}  ';
-      source = utils.replaceSourceIndent(source, selectionIndent, targetIndent);
+      source = utils.replaceSourceIndent(source, selectionIndent, targetIndent,
+          includeLeading: true, ensureTrailingNewline: true);
     }
     // done
     return source;

pkg/analysis_server/lib/src/services/refactoring/legacy/extract_widget.dart

@@ -524,8 +524,6 @@ class ExtractWidgetRefactoringImpl extends RefactoringImpl
                   code,
                   indentOld,
                   indentNew,
-                  includeLeading: false,
-                  includeTrailingNewline: false,
                 );
 
                 builder.writeln('{');
@@ -540,8 +538,7 @@ class ExtractWidgetRefactoringImpl extends RefactoringImpl
                 var indentNew = '    ';
 
                 var code = utils.getRangeText(_statementsRange!);
-                code = utils.replaceSourceIndent(code, indentOld, indentNew,
-                    includeLeading: false, includeTrailingNewline: false);
+                code = utils.replaceSourceIndent(code, indentOld, indentNew);
 
                 builder.writeln('{');
 

pkg/analysis_server/lib/src/services/refactoring/legacy/inline_method.dart

@@ -553,7 +553,8 @@ class _ReferenceProcessor {
         var source = _getMethodSourceForInvocation(status,
             ref._methodStatementsPart!, _refUtils, usage, target, arguments);
         source = _refUtils.replaceSourceIndent(
-            source, ref._methodStatementsPart!._prefix, _refPrefix);
+            source, ref._methodStatementsPart!._prefix, _refPrefix,
+            includeLeading: true, ensureTrailingNewline: true);
         // do insert
         var edit =
             newSourceEdit_range(SourceRange(_refLineRange!.offset, 0), source);

pkg/analysis_server/lib/src/utilities/flutter.dart

@@ -82,7 +82,7 @@ class Flutter {
       String Function(int) getIndent,
       String Function(int, int) getText,
       String Function(String, String, String,
-              {bool includeLeading, bool includeTrailingNewline})
+              {bool includeLeading, bool ensureTrailingNewline})
           replaceSourceIndent,
       SourceRange Function(Expression) rangeNode) {
     var childLoc = namedExp.offset + 'child'.length;
@@ -113,8 +113,6 @@ class Flutter {
         childArgSrc,
         indentOld,
         indentNew,
-        includeLeading: false,
-        includeTrailingNewline: false,
       );
       newChildArgSrc = '$prefix$newChildArgSrc,$eol$indentOld]';
       builder.addSimpleReplacement(rangeNode(childArg), newChildArgSrc);