Improved comment handling (and misc. formatter fixes).

pkg/analyzer_experimental/test/services/formatter_test.dart

 // Copyright (c) 2013, 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:unittest/unittest.dart';
 
 import 'package:analyzer_experimental/src/generated/scanner.dart';
 import 'package:analyzer_experimental/src/services/formatter_impl.dart';
 import 'package:analyzer_experimental/src/services/writer.dart';
 
@@ skipping 50 matching lines @@
 
     test('CU (5)', () {
       expectCUFormatsTo(
           'class A  { int meaningOfLife() => 42; }',
           'class A {\n'
           '  int meaningOfLife() => 42;\n'
           '}'
       );
     });
 
+    test('CU - EOL comments', () {
+      expectCUFormatsTo(
+          '//comment one\n\n'
+          '//comment two\n\n',
+          '//comment one\n\n'
+          '//comment two\n\n'
+      );
+      expectCUFormatsTo(
+          'library foo;\n'
+          '\n'
+          '//comment one\n'
+          '\n'
+          'class C {\n'
+          '}\n',
+          'library foo;\n'
+          '\n'
+          '//comment one\n'
+          '\n'
+          'class C {\n'
+          '}\n'
+      );
+      expectCUFormatsTo(
+          'library foo;\n'
+          '\n'
+          '//comment one\n'
+          '\n'
+          '//comment two\n'
+          '\n'
+          'class C {\n'
+          '}\n',
+          'library foo;\n'
+          '\n'
+          '//comment one\n'
+          '\n'
+          '//comment two\n'
+          '\n'
+          'class C {\n'
+          '}\n'
+      );
+    });
 
-//    test('CU - comments', () {
-//      expectCUFormatsTo(
-//          'library foo;\n'
-//          '\n'
-//          '//comment one\n\n'
-//          '//comment two\n\n'
-//          'class C {\n}\n',
-//          'library foo;\n'
-//          '\n'
-//          '//comment one\n\n'
-//          '//comment two\n\n'
-//          'class C {\n}\n'
-//      );
-//    });
+    test('CU - nested functions', () {
+      expectCUFormatsTo(
+          'x() {\n'
+          '  y() {\n'
+          '  }\n'
+          '}\n',
+          'x() {\n'
+          '  y() {\n'
+          '  }\n'
+          '}\n'
+        );
+    });
 
     test('CU - top level', () {
       expectCUFormatsTo(
           '\n\n'
           'foo() {\n'
           '}\n'
           'bar() {\n'
           '}\n',
           '\n\n'
           'foo() {\n'
@@ skipping 13 matching lines @@
       expectCUFormatsTo(
           'import "dart:io";\n\n'
           'import "package:unittest/unittest.dart";\n'
           'foo() {\n'
           '}\n',
           'import "dart:io";\n\n'
           'import "package:unittest/unittest.dart";\n'
           'foo() {\n'
           '}\n'
       );
+      expectCUFormatsTo(
+          'library a; class B { }',
+          'library a;\n'
+          'class B {\n'
+          '}'
+      );
     });
 
     test('CU - method invocations', () {
       expectCUFormatsTo(
           'class A {\n'
           '  foo() {\n'
           '    bar();\n'
           '    for (int i = 0; i < 42; i++) {\n'
           '      baz();\n'
           '    }\n'
@@ skipping 141 matching lines @@
           '}\n',
           'class A {\n'
           '}\n\n'
           'class B {\n\n\n'
           '  int b() => 42;\n\n'
           '  int c() => b();\n\n'
           '}\n'
       );
     });
 
+    test('CU - Block comments', () {
+      expectCUFormatsTo(
+          '/** Old school class comment */\n'
+          'class C {\n'
+          '  /** Foo! */ int foo() => 42;\n'
+          '}\n',
+          '/** Old school class comment */\n'
+          'class C {\n'
+          '  /** Foo! */ int foo() => 42;\n'
+          '}\n'
+      );
+      expectCUFormatsTo(
+          'library foo;\n'
+          'class C /* is cool */ {\n'
+          '  /* int */ foo() => 42;\n'
+          '}\n',
+          'library foo;\n'
+          'class C /* is cool */ {\n'
+          '  /* int */ foo() => 42;\n'
+          '}\n'
+      );
+      expectCUFormatsTo(
+          'library foo;\n'
+          '/* A long\n'
+          ' * Comment\n'
+          '*/\n'
+          'class C /* is cool */ {\n'
+          '  /* int */ foo() => 42;\n'
+          '}\n',
+          'library foo;\n'
+          '/* A long\n'
+          ' * Comment\n'
+          '*/\n'
+          'class C /* is cool */ {\n'
+          '  /* int */ foo() => 42;\n'
+          '}\n'
+      );
+      expectCUFormatsTo(

[Brian Wilkerson, 2013/08/27 21:12:45]

Related to my earlier questions, what happens if the end-of-line comment
precedes the block comment? Or if the comment is at the end of the file? For
example:

library foo;


/* Comment 1 */


// Comment 2


/* Comment 3 */

[pquitslund, 2013/08/27 21:55:38]

Predictably this breaks.  Thanks for the catch.  Sine the fix requires a little
rejiggering, I'll follow-up with another CL.

+          'library foo;\n'
+          '/* A long\n'
+          ' * Comment\n'
+          '*/\n'
+          '\n'
+          '/* And\n'
+          ' * another...\n'
+          '*/\n'
+          '\n'
+          '// Mixing it up\n'
+          '\n'
+          'class C /* is cool */ {\n'
+          '  /* int */ foo() => 42;\n'
+          '}\n',
+          'library foo;\n'
+          '/* A long\n'
+          ' * Comment\n'
+          '*/\n'
+          '\n'
+          '/* And\n'
+          ' * another...\n'
+          '*/\n'
+          '\n'
+          '// Mixing it up\n'
+          '\n'
+          'class C /* is cool */ {\n'
+          '  /* int */ foo() => 42;\n'
+          '}\n'
+      );
+      expectCUFormatsTo(
+          '/// Copyright info\n'
+          '\n'
+          'library foo;\n'
+          '/// Class comment\n'
+          '//TODO: implement\n'
+          'class C {\n'
+          '}\n',
+          '/// Copyright info\n'
+          '\n'
+          'library foo;\n'
+          '/// Class comment\n'
+          '//TODO: implement\n'
+          'class C {\n'
+          '}\n'
+      );
+    });
+    
+    
     test('CU - constructor', () {
       expectCUFormatsTo(
           'class A {\n'
           '  const _a;\n'
           '  A();\n'
           '  int a() => _a;\n'
           '}\n',
           'class A {\n'
           '  const _a;\n'
           '  A();\n'
@@ skipping 57 matching lines @@
           'class A {\n'
           '  int _a;\n'
           '  A(this._a);\n'
           '}\n'
         );
     });
 
     test('CU - parts', () {
       expectCUFormatsTo(
         'part of foo;',
-        'part of foo;'
+        'part of foo;\n'
       );
     });
 
     test('stmt', () {
       expectStmtFormatsTo(
          'if (true){\n'
          'if (true){\n'
          'if (true){\n'
          'return true;\n'
          '} else{\n'
@@ skipping 38 matching lines @@
       );
     });
 
     test('stmt (generics)', () {
       expectStmtFormatsTo(
         'var numbers = <int>[1, 2, (3 + 4)];',
         'var numbers = <int>[1, 2, (3 + 4)];'
       );
     });
 
+    test('stmt (maps)', () {
+      expectStmtFormatsTo(
+        'var map = const {"foo": "bar", "fuz": null};',
+        'var map = const {"foo": "bar", "fuz": null};'
+      );
+    });
+
     test('stmt (try/catch)', () {
       expectStmtFormatsTo(
         'try {\n'
         'doSomething();\n'
         '} catch (e) {\n'
         'print(e);\n'
         '}',
         'try {\n'
         '  doSomething();\n'
         '} catch (e) {\n'
@@ skipping 183 matching lines @@
 String formatCU(src, {options: const FormatterOptions()}) =>
     new CodeFormatter(options).format(CodeKind.COMPILATION_UNIT, src);
 
 String formatStatement(src, {options: const FormatterOptions()}) =>
     new CodeFormatter(options).format(CodeKind.STATEMENT, src);
 
 expectCUFormatsTo(src, expected) => expect(formatCU(src), equals(expected));
 
 expectStmtFormatsTo(src, expected) => expect(formatStatement(src),
     equals(expected));