[analysis_server] Move EOL from ChangeBuilder to FileEditBuilder

Because ChangeBuilder can be used to modify multiple files, the EOL should come from an individual files edit builder and not from the overall ChangeBuilder.

This change renames `eol` on ChangeBuilder to `defaultEol` (since it's still useful to supply a custom default, for example when moving a class from an existing file to a new file, we want to default to the same EOL as the source file), and adds an EOL to file edit builders which is computed from the file content (and falls back to the default from ChangeBuilder if there are none).

My intention here is to not introduce any breaking changes (yet) so the ChangeBuilder constructor interface still has the "eol" named parameter (marked as deprecated) as well as the new `defaultEol` parameter.

I added a new `StringExtension` for `endOfLine` to both analyzer_plugin and analysis_server_plugin as we need this in both places (but I expect one of those projects will ultimately be dropped). This slightly differs from `CorrectionUtils.endOfLine` because it can return `null` which is a signal to fall back to the ChangeBuilder default instead of forcing its own default. (CorrectionUtils.endOfLine now uses that extension, although because of the null/default, it's likely that some - if not all - uses of this should migrate to the new extension and fall back to a default from a ChangeBuilder).

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

Author: DanTup

pkg/analysis_server/lib/src/cider/rename.dart

@@ -9,7 +9,6 @@ import 'package:analysis_server/src/services/refactoring/legacy/naming_conventio
 import 'package:analysis_server/src/services/refactoring/legacy/refactoring.dart';
 import 'package:analysis_server/src/services/search/hierarchy.dart';
 import 'package:analysis_server/src/utilities/change_builder.dart';
-import 'package:analysis_server_plugin/edit/correction_utils.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/source/line_info.dart';
@@ -377,7 +376,6 @@ class CheckNameResponse {
       return null;
     }
 
-    var utils = CorrectionUtils(resolvedUnit);
     var node = result.node;
     if (node is! NamedCompilationUnitMember) {
       return null;
@@ -391,7 +389,6 @@ class CheckNameResponse {
         constructorName: newName,
         isConst: node is EnumDeclaration,
       ),
-      eol: utils.endOfLine,
     );
     if (edit == null) {
       return null;

pkg/analysis_server/lib/src/lsp/handlers/commands/refactor_command_handler.dart

@@ -115,7 +115,7 @@ class RefactorCommandHandler extends SimpleEditCommandHandler<AnalysisServer> {
     var producer = generator(context);
     var builder = ChangeBuilder(
       workspace: context.workspace,
-      eol: context.utils.endOfLine,
+      defaultEol: context.utils.endOfLine,
     );
     var status = await producer.compute(arguments, builder);
 

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

@@ -94,9 +94,11 @@ class AddCallSuper extends ResolvedCorrectionProducer {
     var expression = body.expression;
     var semicolon = body.semicolon;
     var prefix = utils.getLinePrefix(expression.offset);
-    var prefixWithLine = eol + prefix + utils.oneIndent;
 
     await builder.addDartFileEdit(file, (builder) {
+      var eol = builder.eol;
+      var prefixWithLine = eol + prefix + utils.oneIndent;
+
       builder.addSimpleReplacement(
         range.startStart(body.functionDefinition, expression),
         '{${prefixWithLine}super.$_addition;${prefixWithLine}return ',

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

@@ -4,6 +4,7 @@
 
 import 'package:analysis_server/src/services/correction/fix.dart';
 import 'package:analysis_server_plugin/edit/dart/correction_producer.dart';
+import 'package:analysis_server_plugin/src/utilities/extensions/string_extension.dart';
 import 'package:analyzer/source/source_range.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
 import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
@@ -22,9 +23,13 @@ class AddEolAtEndOfFile extends ResolvedCorrectionProducer {
   @override
   Future<void> compute(ChangeBuilder builder) async {
     var content = unitResult.content;
-    if (!content.endsWith(eol)) {
+    var eol = content.endOfLine;
+    if (eol == null || !content.endsWith(eol)) {
       await builder.addDartFileEdit(file, (builder) {
-        builder.addSimpleInsertion(content.length, eol);
+        // Read the EOL off builder, because it is non-null and always has the
+        // correct default, whereas the original variable could be null if the
+        // file has no EOLs.
+        builder.addSimpleInsertion(content.length, builder.eol);
       });
     } else {
       var index = content.length;

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

@@ -29,6 +29,7 @@ class AddLeadingNewlineToString extends ResolvedCorrectionProducer {
     }
 
     await builder.addDartFileEdit(file, (builder) {
+      var eol = builder.eol;
       builder.addSimpleInsertion(stringLiteral.contentsOffset, eol);
     });
   }

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

@@ -42,6 +42,7 @@ class AddOverride extends ResolvedCorrectionProducer {
     var exitPosition = Position(file, token.offset - 1);
     var indent = utils.oneIndent;
     await builder.addDartFileEdit(file, (builder) {
+      var eol = builder.eol;
       builder.addSimpleReplacement(
         range.startLength(token, 0),
         '@override$eol$indent',

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

@@ -29,6 +29,7 @@ class AddRedeclare extends ResolvedCorrectionProducer {
     var token = member.firstTokenAfterCommentAndMetadata;
     var indent = utils.oneIndent;
     await builder.addDartFileEdit(file, (builder) {
+      var eol = builder.eol;
       builder.addInsertion(token.offset, (builder) {
         builder.write('@');
         builder.writeImportedName([

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

@@ -45,20 +45,22 @@ class AddReturnNull extends ResolvedCorrectionProducer {
     } else {
       return;
     }
-    int position;
-    String returnStatement;
-    if (block.statements.isEmpty) {
-      position = block.offset + 1;
-      var prefix = utils.getLinePrefix(block.offset);
-      returnStatement = '$eol$prefix${utils.oneIndent}return null;$eol$prefix';
-    } else {
-      var lastStatement = block.statements.last;
-      position = lastStatement.offset + lastStatement.length;
-      var prefix = utils.getNodePrefix(lastStatement);
-      returnStatement = '$eol${prefix}return null;';
-    }
-
     await builder.addDartFileEdit(file, (builder) {
+      var eol = builder.eol;
+      int position;
+      String returnStatement;
+      if (block.statements.isEmpty) {
+        position = block.offset + 1;
+        var prefix = utils.getLinePrefix(block.offset);
+        returnStatement =
+            '$eol$prefix${utils.oneIndent}return null;$eol$prefix';
+      } else {
+        var lastStatement = block.statements.last;
+        position = lastStatement.offset + lastStatement.length;
+        var prefix = utils.getNodePrefix(lastStatement);
+        returnStatement = '$eol${prefix}return null;';
+      }
+
       builder.addInsertion(position, (builder) {
         builder.write(returnStatement);
       });

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

@@ -44,7 +44,7 @@ class AddSwitchCaseBreak extends ResolvedCorrectionProducer {
 
     await builder.addDartFileEdit(file, (builder) {
       builder.addInsertion(lastStatement.end, (builder) {
-        builder.write(eol);
+        builder.writeln();
         builder.write(utils.getNodePrefix(lastStatement));
         builder.write('break;');
       });

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

@@ -6,6 +6,7 @@ import 'package:_fe_analyzer_shared/src/scanner/token.dart';
 import 'package:analysis_server/src/services/correction/assist.dart';
 import 'package:analysis_server/src/services/correction/fix.dart';
 import 'package:analysis_server_plugin/edit/dart/correction_producer.dart';
+import 'package:analysis_server_plugin/src/utilities/extensions/string_extension.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer_plugin/utilities/assist/assist.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
@@ -39,7 +40,12 @@ class ConvertDocumentationIntoLine extends ParsedCorrectionProducer {
       return;
     }
     var text = token.lexeme;
-    var lines = text.split(eol);
+    var eol = text.endOfLine;
+    var lines = eol != null ? text.split(eol) : [text];
+    // To simplify the code below which builds prefixes with eols in the loop,
+    // ensure we have a value. In the case of a single line (eol=null) these
+    // eols are only assigned to variables and not used.
+    eol ??= builder.defaultEol;
     var prefix = utils.getNodePrefix(comment);
     var newLines = <String>[];
     var firstLine = true;