New fix: move_annotation_to_library_directive

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

Author: srawlins

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

@@ -0,0 +1,103 @@
+// Copyright (c) 2022, 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:_fe_analyzer_shared/src/scanner/token.dart';
+import 'package:analysis_server/src/services/correction/dart/abstract_producer.dart';
+import 'package:analysis_server/src/services/correction/fix.dart';
+import 'package:analyzer/dart/analysis/features.dart';
+import 'package:analyzer/dart/ast/ast.dart';
+import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
+import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
+import 'package:analyzer_plugin/utilities/range_factory.dart';
+
+class MoveAnnotationToLibraryDirective extends CorrectionProducer {
+  @override
+  FixKind get fixKind => DartFixKind.MOVE_ANNOTATION_TO_LIBRARY_DIRECTIVE;
+
+  @override
+  Future<void> compute(ChangeBuilder builder) async {
+    var annotation = node.thisOrAncestorOfType<Annotation>();
+    if (annotation == null) {
+      return;
+    }
+    var compilationUnit = annotation.root;
+    if (compilationUnit is! CompilationUnit) {
+      return;
+    }
+
+    var firstDirective = compilationUnit.directives.isEmpty
+        ? null
+        : compilationUnit.directives.first;
+    if (firstDirective is LibraryDirective) {
+      await _moveToExistingLibraryDirective(
+          builder, annotation, firstDirective);
+      return;
+    }
+
+    if (!libraryElement.featureSet.isEnabled(Feature.unnamedLibraries)) {
+      // If the library doesn't support unnamed libraries, then we cannot add
+      // a new library directive; we don't know what to name it.
+      return;
+    }
+
+    await _moveToNewLibraryDirective(builder, annotation, compilationUnit);
+  }
+
+  Future<void> _moveToExistingLibraryDirective(ChangeBuilder builder,
+      Annotation annotation, LibraryDirective libraryDirective) async {
+    // Just move the annotation to the existing library directive.
+    var annotationRange = utils.getLinesRange(range.node(annotation));
+    await builder.addDartFileEdit(file, (builder) {
+      builder.addDeletion(annotationRange);
+      var annotationText = utils.getRangeText(annotationRange);
+      builder.addSimpleInsertion(
+          libraryDirective.firstTokenAfterCommentAndMetadata.offset,
+          annotationText);
+    });
+  }
+
+  Future<void> _moveToNewLibraryDirective(ChangeBuilder builder,
+      Annotation annotation, CompilationUnit compilationUnit) async {
+    var annotationRange = utils.getLinesRange(range.node(annotation));
+    // Create a new, unnamed library directive, and move the annotation to just
+    // above the directive.
+    var token = compilationUnit.beginToken;
+
+    if (token.type == TokenType.SCRIPT_TAG) {
+      // TODO(srawlins): Handle this case.
+      return;
+    }
+
+    if (token == annotation.beginToken) {
+      // Do not "move" the annotation. Just slip a library directive below it.
+      await builder.addDartFileEdit(file, (builder) {
+        builder.addSimpleInsertion(annotationRange.end, 'library;$eol$eol');
+      });
+      return;
+    }
+
+    int insertionOffset;
+    String prefix;
+    Token? commentOnFirstToken = token.precedingComments;
+    if (commentOnFirstToken != null) {
+      while (commentOnFirstToken!.next != null) {
+        commentOnFirstToken = commentOnFirstToken.next!;
+      }
+      // `token` is now the last of the leading comments (perhaps a Copyight
+      // notice, a Dart language version, etc.)
+      insertionOffset = commentOnFirstToken.end;
+      prefix = '$eol$eol';
+    } else {
+      insertionOffset = 0;
+      prefix = '';
+    }
+
+    await builder.addDartFileEdit(file, (builder) {
+      builder.addDeletion(annotationRange);
+      var annotationText = utils.getRangeText(annotationRange);
+      builder.addSimpleInsertion(
+          insertionOffset, '$prefix${annotationText}library;$eol$eol');
+    });
+  }
+}

pkg/analysis_server/lib/src/services/correction/error_fix_status.yaml

@@ -27,8 +27,8 @@
 # - 710 "needsEvaluation"
 #   - 282 for CompileTimeErrorCodes
 #   - 220 for ParserErrorCodes
-# -  70 "needsFix"
-# - 298 "hasFix"
+# -  69 "needsFix"
+# - 299 "hasFix"
 # -  64 "noFix"
 
 AnalysisOptionsErrorCode.INCLUDED_FILE_PARSE_ERROR:
@@ -1854,7 +1854,7 @@ LintCode.join_return_with_assignment:
 LintCode.leading_newlines_in_multiline_strings:
   status: hasFix
 LintCode.library_annotations:
-  status: needsFix
+  status: hasFix
 LintCode.library_names:
   status: needsEvaluation
 LintCode.library_prefixes:

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

@@ -847,6 +847,11 @@ class DartFixKind {
     DartFixKindPriority.DEFAULT,
     "Make '{0}' nullable",
   );
+  static const MOVE_ANNOTATION_TO_LIBRARY_DIRECTIVE = FixKind(
+    'dart.fix.moveAnnotationToLibraryDirective',
+    DartFixKindPriority.DEFAULT,
+    "Move this annotation to a library directive",
+  );
   static const ORGANIZE_IMPORTS = FixKind(
     'dart.fix.organize.imports',
     DartFixKindPriority.DEFAULT,

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

@@ -106,6 +106,7 @@ import 'package:analysis_server/src/services/correction/dart/make_final.dart';
 import 'package:analysis_server/src/services/correction/dart/make_return_type_nullable.dart';
 import 'package:analysis_server/src/services/correction/dart/make_variable_not_final.dart';
 import 'package:analysis_server/src/services/correction/dart/make_variable_nullable.dart';
+import 'package:analysis_server/src/services/correction/dart/move_annotation_to_library_directive.dart';
 import 'package:analysis_server/src/services/correction/dart/move_type_arguments_to_class.dart';
 import 'package:analysis_server/src/services/correction/dart/organize_imports.dart';
 import 'package:analysis_server/src/services/correction/dart/qualify_reference.dart';
@@ -493,6 +494,9 @@ class FixProcessor extends BaseProcessor {
     LintNames.leading_newlines_in_multiline_strings: [
       AddLeadingNewlineToString.new,
     ],
+    LintNames.library_annotations: [
+      MoveAnnotationToLibraryDirective.new,
+    ],
     LintNames.no_duplicate_case_values: [
       RemoveDuplicateCase.new,
     ],

pkg/analysis_server/lib/src/services/linter/lint_names.dart

@@ -66,6 +66,7 @@ class LintNames {
   static const String implicit_call_tearoffs = 'implicit_call_tearoffs';
   static const String leading_newlines_in_multiline_strings =
       'leading_newlines_in_multiline_strings';
+  static const String library_annotations = 'library_annotations';
   static const String no_duplicate_case_values = 'no_duplicate_case_values';
   static const String no_leading_underscores_for_library_prefixes =
       'no_leading_underscores_for_library_prefixes';

pkg/analysis_server/test/src/services/correction/fix/move_annotation_to_library_directive_test.dart

@@ -0,0 +1,137 @@
+// Copyright (c) 2022, 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:analysis_server/src/services/correction/fix.dart';
+import 'package:analysis_server/src/services/linter/lint_names.dart';
+import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
+import 'package:test_reflective_loader/test_reflective_loader.dart';
+
+import 'fix_processor.dart';
+
+void main() {
+  defineReflectiveSuite(() {
+    defineReflectiveTests(MoveAnnotationToLibraryDirectiveTest);
+  });
+}
+
+@reflectiveTest
+class MoveAnnotationToLibraryDirectiveTest extends FixProcessorLintTest {
+  @override
+  FixKind get kind => DartFixKind.MOVE_ANNOTATION_TO_LIBRARY_DIRECTIVE;
+
+  @override
+  String get lintCode => LintNames.library_annotations;
+
+  Future<void> test_existingLibraryDirective() async {
+    await resolveTestCode('''
+/// Doc comment.
+library;
+@pragma('dart2js:late:trust')
+import 'dart:async';
+
+void f(Completer c) {}
+''');
+    await assertHasFix('''
+/// Doc comment.
+@pragma('dart2js:late:trust')
+library;
+import 'dart:async';
+
+void f(Completer c) {}
+''');
+  }
+
+  Future<void> test_noExistingLibraryDirective_annotationIsFirst() async {
+    await resolveTestCode('''
+@pragma('dart2js:late:trust')
+import 'dart:async';
+
+void f(Completer c) {}
+''');
+    await assertHasFix('''
+@pragma('dart2js:late:trust')
+library;
+
+import 'dart:async';
+
+void f(Completer c) {}
+''');
+  }
+
+  Future<void>
+      test_noExistingLibraryDirective_annotherAnnotationIsFirst() async {
+    await resolveTestCode('''
+@deprecated
+@pragma('dart2js:late:trust')
+import 'dart:async';
+
+void f(Completer c) {}
+''');
+    await assertHasFix('''
+@pragma('dart2js:late:trust')
+library;
+
+@deprecated
+import 'dart:async';
+
+void f(Completer c) {}
+''');
+  }
+
+  Future<void> test_noExistingLibraryDirective_commentsAreFirst() async {
+    await resolveTestCode('''
+// Comment 1.
+
+// Comment 2.
+
+@pragma('dart2js:late:trust')
+import 'dart:async';
+
+void f(Completer c) {}
+''');
+    await assertHasFix('''
+// Comment 1.
+
+// Comment 2.
+
+@pragma('dart2js:late:trust')
+library;
+
+import 'dart:async';
+
+void f(Completer c) {}
+''');
+  }
+
+  Future<void>
+      test_noExistingLibraryDirective_commentsAreFirst_andAnnotations() async {
+    await resolveTestCode('''
+// Comment 1.
+
+// Comment 2.
+
+@deprecated
+@pragma('dart2js:late:trust')
+import 'dart:async';
+
+void f(Completer c) {}
+''');
+    // TODO(srawlins): Fix the 4 newlines below; should be 2.
+    await assertHasFix('''
+// Comment 1.
+
+// Comment 2.
+
+@pragma('dart2js:late:trust')
+library;
+
+
+
+@deprecated
+import 'dart:async';
+
+void f(Completer c) {}
+''');
+  }
+}

pkg/analysis_server/test/src/services/correction/fix/test_all.dart

@@ -131,6 +131,8 @@ import 'make_final_test.dart' as make_final;
 import 'make_return_type_nullable_test.dart' as make_return_type_nullable;
 import 'make_variable_not_final_test.dart' as make_variable_not_final;
 import 'make_variable_nullable_test.dart' as make_variable_nullable;
+import 'move_annotation_to_library_directive_test.dart'
+    as move_annotation_to_library_directive;
 import 'move_type_arguments_to_class_test.dart' as move_type_arguments_to_class;
 import 'organize_imports_test.dart' as organize_imports;
 import 'pubspec/test_all.dart' as pubspec;
@@ -359,6 +361,7 @@ void main() {
     make_return_type_nullable.main();
     make_variable_not_final.main();
     make_variable_nullable.main();
+    move_annotation_to_library_directive.main();
     move_type_arguments_to_class.main();
     organize_imports.main();
     pubspec.main();