Merge pull request #444 from Workiva/fixed_issue_with_organize_imports_and_dart_comment

FEDX-1952: Fixed bug with organizeDirectives and LanguageVersion comment

Author: rm-astro-wf

lib/src/utils/organize_directives/organize_directives.dart

@@ -133,8 +133,15 @@ void _assignCommentsBeforeTokenToNamespace(
   for (Token? comment = token.precedingComments;
       comment != null;
       comment = comment.next) {
+    // the LanguageVersionToken (`// @dart=2.11`) must stay where it is at
+    // the top of the file. Do not assign this to any namespace
+    if (comment is LanguageVersionToken) continue;
+
     if (_commentIsOnSameLineAsNamespace(
-        comment, prevNamespace, sourceFileContents)) {
+      comment,
+      prevNamespace,
+      sourceFileContents,
+    )) {
       prevNamespace!.afterComments.add(comment);
     } else if (currNamespace != null) {
       currNamespace.beforeComments.add(comment);

test/tools/fixtures/organize_directives/directives.dart

@@ -569,11 +569,11 @@ const unorganized19 = '''
 /* Multi-line comment 3 */
 import 'dart:html';
 /* Multi-line comment 4 */
-/* 
-Multi-line comment 5 
+/*
+Multi-line comment 5
 */
 import 'dart:typed_data';
-/* 
+/*
  Multi-line comment 1
 */
 /* Multi-line comment 2 */
@@ -585,16 +585,16 @@ void main() {
 ''';
 
 const organized19 = '''
-/* 
+/*
  Multi-line comment 1
 */
 /* Multi-line comment 2 */
 import 'dart:async';
 /* Multi-line comment 3 */
 import 'dart:html';
 /* Multi-line comment 4 */
-/* 
-Multi-line comment 5 
+/*
+Multi-line comment 5
 */
 import 'dart:typed_data';
 
@@ -869,3 +869,18 @@ export 'package:dart_dev/dart_dev.dart'
         Type3, // comment
         Type4;
 ''';
+
+const unorganized32 = '''
+// @dart=2.11
+
+import 'package:c_package/c_package.dart';
+
+import 'package:a_package/a_package.dart';
+''';
+
+const organized32 = '''
+// @dart=2.11
+
+import 'package:a_package/a_package.dart';
+import 'package:c_package/c_package.dart';
+''';

test/utils/organize_imports/organize_directives_test.dart

@@ -108,6 +108,7 @@ void main() {
       organized30,
     ),
     _TestCase('31. comments with exports', unorganized31, organized31),
+    _TestCase('32. with dart version comment', unorganized32, organized32),
   ];
 
   group('organizeDirectives', () {