Description
I'm not sure if this is strictly a bug, but it feels incorrect. I was investigating an issue at Dart-Code/Dart-Code#4865 where sometimes lots of blank lines were being added when formatting documents.
It seems like there may be two issues:
- The formatter changing a file using
\n
to\r\n
- VS Code showing
\r\n
as if it's two newlines if the file is set toLF
mode but contains CRLF.
The reason the first was occurring is that in the analysis server we are currently reusing the DartFormatter
instance. This class caches the line ending on first format if it's not explicitly provided. This means if you format a document that uses CRLF and then one that uses LF, it will output CRLF for the second file:
final formatter = DartFormatter();
print(jsonEncode(formatter.format('int a;\r\n'))); // Outputs "int a;\r\n"
print(jsonEncode(formatter.format('int b;\n'))); // Outputs "int b;\r\n" but expected "int b;\n"
I'm going to remove the reuse of this instance from the server (we were discussing this because of language versions anyway), but I thought it was worth raising this because it's not clear if this is expected behaviour.