Merge branch 'master' into migrate-deprecated-classes-methods

Author: fshcheglov

example_usage/lib/library_source.info.dart

@@ -1,3 +1,10 @@
+## 4.0.0
+
+- **Breaking Change**: remove `TypeChecker.fromRuntime`, use
+  `TypeChecker.typeNamed` instead. This removes all use of `dart:mirror`, so
+  builders using `source_gen` can be AOT compiled for better performance.
+- Keep `// GENERATED FILE` comments on the first line.
+
 ## 3.1.0
 
 - Prepare to stop using `dart:mirrors`: deprecate `TypeChecker.fromRuntime`.

source_gen/CHANGELOG.md

@@ -430,7 +430,14 @@ String _defaultFormatOutput(String code, Version version) =>
 
 /// Prefixes a dart format width and formats [code].
 String _defaultFormatUnit(String code, Version version) {
-  code = '$dartFormatWidth\n$code';
+  if (code.startsWith('$defaultFileHeader\n')) {
+    code =
+        '$defaultFileHeader\n'
+        '$dartFormatWidth\n'
+        '${code.substring(defaultFileHeader.length)}';
+  } else {
+    code = '$dartFormatWidth\n$code';
+  }
   return _defaultFormatOutput(code, version);
 }
 

source_gen/lib/src/builder.dart

@@ -57,17 +57,19 @@ abstract class GeneratorForAnnotation<T> extends Generator {
   /// annotations. You can override this by setting [throwOnUnresolved] to
   /// `false`.
   ///
-  /// With `source_gen` 4.0.0 this class will stop using mirrors for matching
-  /// annotations and will fall back to comparing the name of `T`. Pass
-  /// [inPackage] and [inSdk] to tighten the check; see [TypeChecker.typeNamed].
+  /// [TypeChecker.typeNamed] on `T` is used to match the annotation. By default
+  /// it matches any annotation with the same name. Pass [inPackage] and [inSdk]
+  /// to tighten the check; see [TypeChecker.typeNamed] for details.
+  ///
   /// To use a custom annotation check, override [typeChecker].
   const GeneratorForAnnotation({
     this.throwOnUnresolved = true,
     this.inPackage,
     this.inSdk,
   });
 
-  TypeChecker get typeChecker => TypeChecker.typeNamed(T);
+  TypeChecker get typeChecker =>
+      TypeChecker.typeNamed(T, inPackage: inPackage, inSdk: inSdk);
 
   @override
   FutureOr<String> generate(LibraryReader library, BuildStep buildStep) async {

source_gen/lib/src/generator_for_annotation.dart

@@ -2,7 +2,7 @@
 // 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 'dart:mirrors' hide SourceLocation;
+// ignore_for_file: deprecated_member_use until analyzer 7 support is dropped.
 
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/ast/ast.dart';
@@ -32,20 +32,6 @@ abstract class TypeChecker {
   /// ```
   const factory TypeChecker.any(Iterable<TypeChecker> checkers) = _AnyChecker;
 
-  /// Create a new [TypeChecker] backed by a runtime [type].
-  ///
-  /// This implementation uses `dart:mirrors` (runtime reflection).
-  @Deprecated('''
-Will be removed in 4.0.0 to drop `dart:mirrors` dependency.
-
-Recommended: replace `fromRuntime(Foo)` with
-`typeNamed(Foo, inPackage: 'foo_package')`. This is a slighly weaker check than
-`fromRuntime(Foo)` as it matches any annotation named `Foo` in
-`package:foo_package`.
-
-If you need an exact match, use `fromUrl`.''')
-  const factory TypeChecker.fromRuntime(Type type) = _MirrorTypeChecker;
-
   /// Create a new [TypeChecker] for types matching the name of [type].
   ///
   /// Optionally, also pass [inPackage] to restrict to a specific package by
@@ -252,29 +238,6 @@ class _LibraryTypeChecker extends TypeChecker {
   String toString() => urlOfElement(_type.element!);
 }
 
-// Checks a runtime type against a static type.
-class _MirrorTypeChecker extends TypeChecker {
-  static Uri _uriOf(ClassMirror mirror) => normalizeUrl(
-    (mirror.owner as LibraryMirror).uri,
-  ).replace(fragment: MirrorSystem.getName(mirror.simpleName));
-
-  // Precomputed type checker for types that already have been used.
-  static final _cache = Expando<TypeChecker>();
-
-  final Type _type;
-
-  const _MirrorTypeChecker(this._type) : super._();
-
-  TypeChecker get _computed =>
-      _cache[this] ??= TypeChecker.fromUrl(_uriOf(reflectClass(_type)));
-
-  @override
-  bool isExactly(Element element) => _computed.isExactly(element);
-
-  @override
-  String toString() => _computed.toString();
-}
-
 // Checks a runtime type name and optional package against a static type.
 class _NameTypeChecker extends TypeChecker {
   final Type _type;

source_gen/lib/src/type_checker.dart

@@ -1,5 +1,5 @@
 name: source_gen
-version: 3.1.0
+version: 4.0.0
 description: >-
   Source code generation builders and utilities for the Dart build system
 repository: https://github.com/dart-lang/source_gen/tree/master/source_gen

source_gen/pubspec.yaml

@@ -1058,8 +1058,8 @@ final int foo = 42
 ''';
 
 const _testGenPartContent = '''
-$dartFormatWidth
 // GENERATED CODE - DO NOT MODIFY BY HAND
+$dartFormatWidth
 
 part of 'test_lib.dart';
 
@@ -1072,8 +1072,8 @@ part of 'test_lib.dart';
 ''';
 
 const _testGenPartContentForLibrary = '''
-$dartFormatWidth
 // GENERATED CODE - DO NOT MODIFY BY HAND
+$dartFormatWidth
 
 part of 'test_lib.dart';
 
@@ -1085,8 +1085,8 @@ part of 'test_lib.dart';
 ''';
 
 const _testGenStandaloneContent = '''
-$dartFormatWidth
 // GENERATED CODE - DO NOT MODIFY BY HAND
+$dartFormatWidth
 
 // **************************************************************************
 // CommentGenerator
@@ -1097,8 +1097,8 @@ $dartFormatWidth
 ''';
 
 const _testGenPartContentForClassesAndLibrary = '''
-$dartFormatWidth
 // GENERATED CODE - DO NOT MODIFY BY HAND
+$dartFormatWidth
 
 part of 'test_lib.dart';
 
@@ -1112,8 +1112,8 @@ part of 'test_lib.dart';
 ''';
 
 const _testGenNoLibrary = '''
-$dartFormatWidth
 // GENERATED CODE - DO NOT MODIFY BY HAND
+$dartFormatWidth
 
 part of 'test_lib.dart';
 

source_gen/test/builder_test.dart

@@ -50,8 +50,8 @@ void main() {
       _inputMap,
       outputs: {
         'a|lib/file.g.dart': '''
-$dartFormatWidth
 // GENERATED CODE - DO NOT MODIFY BY HAND
+$dartFormatWidth
 
 // **************************************************************************
 // Generator: Repeating
@@ -148,8 +148,8 @@ main() {}''',
       },
       outputs: {
         'a|lib/file.g.dart': '''
-$dartFormatWidth
 // GENERATED CODE - DO NOT MODIFY BY HAND
+$dartFormatWidth
 
 // **************************************************************************
 // Generator: Deprecated
@@ -192,8 +192,8 @@ $dartFormatWidth
       },
       outputs: {
         'a|lib/file.g.dart': '''
-$dartFormatWidth
 // GENERATED CODE - DO NOT MODIFY BY HAND
+$dartFormatWidth
 
 // **************************************************************************
 // Generator: Deprecated

source_gen/test/generator_for_annotation_test.dart

@@ -332,24 +332,6 @@ void main() {
     });
   }
 
-  group('TypeChecker.forRuntime', () {
-    commonTests(
-      checkIterable: () => const TypeChecker.typeNamed(Iterable),
-      checkEnum: () => const TypeChecker.typeNamed(Enum),
-      checkEnumMixin: () => const TypeChecker.typeNamed(MyEnumMixin),
-      checkMap: () => const TypeChecker.typeNamed(Map),
-      checkMapMixin: () => const TypeChecker.typeNamed(MyMapMixin),
-      checkHashMap: () => const TypeChecker.typeNamed(HashMap),
-      checkGenerator: () => const TypeChecker.typeNamed(Generator),
-
-      checkGeneratorForAnnotation:
-          () => const TypeChecker.typeNamed(
-            GeneratorForAnnotation,
-            inPackage: 'source_gen',
-          ),
-    );
-  });
-
   group('TypeChecker.typeNamed without package', () {
     commonTests(
       checkIterable: () => const TypeChecker.typeNamed(Iterable),