Fix CI, fix doc comments, ignore deprecations (for now) (kevmoo#82)

Author: kevmoo

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.1.2-wip
+
+- Fixed some doc comment references.
+
 ## 1.1.1
 
 - Support the latest `package:analyzer` and `package:source_gen`.

README.md

@@ -1,5 +1,5 @@
 [![Pub package](https://img.shields.io/pub/v/source_gen_test.svg)](https://pub.dev/packages/source_gen_test)
-[![Build Status](https://github.com/kevmoo/source_gen_test/workflows/CI/badge.svg?branch=master)](https://github.com/kevmoo/source_gen_test/actions?query=workflow%3A%22CI%22+branch%3Amaster)
+[![CI](https://github.com/kevmoo/source_gen_test/actions/workflows/ci.yml/badge.svg)](https://github.com/kevmoo/source_gen_test/actions/workflows/ci.yml)
 [![package publisher](https://img.shields.io/pub/publisher/source_gen_test.svg)](https://pub.dev/packages/source_gen_test/publisher)
 
 Make it easy to test `Generators` derived from `package:source_gen` by

analysis_options.yaml

@@ -33,6 +33,7 @@ linter:
     - prefer_final_locals
     - require_trailing_commas
     - unnecessary_await_in_return
+    - unnecessary_ignore
     - use_if_null_to_convert_nulls_to_bools
     - use_raw_strings
     - use_string_buffers

example/example_generator.dart

@@ -13,6 +13,7 @@ class ExampleGenerator extends GeneratorForAnnotation<ExampleAnnotation> {
 
   @override
   Iterable<String> generateForAnnotatedElement(
+    // ignore: deprecated_member_use
     Element element,
     ConstantReader annotation,
     BuildStep buildStep,
@@ -23,6 +24,7 @@ class ExampleGenerator extends GeneratorForAnnotation<ExampleAnnotation> {
       log.info('This member might be not good.');
     }
 
+    // ignore: deprecated_member_use
     if (element is! ClassElement) {
       throw InvalidGenerationSourceError(
         'Only supports annotated classes.',

lib/src/annotations.dart

@@ -1,8 +1,6 @@
-// ignore_for_file: comment_references
-// Note: Should be importing the below libs instead, but we are avoiding imports
-// in this file to speed up analyzer parsing!
-// import 'package:source_gen/source_gen.dart';
-// import 'test_annotated_classes.dart';
+/// @docImport 'package:source_gen/source_gen.dart';
+/// @docImport 'test_annotated_classes.dart';
+library;
 
 /// Non-public, implementation base class of  [ShouldGenerate] and
 /// [ShouldThrow].
@@ -102,16 +100,16 @@ class ShouldThrow extends TestExpectation {
   final String errorMessage;
   final String? todo;
 
-  /// If `null`, expects [InvalidGenerationSourceError.element] to match the
+  /// If `null`, expects [InvalidGenerationSource.element] to match the
   /// element annotated with [ShouldThrow].
   ///
-  /// If a [String], expects [InvalidGenerationSourceError.element] to match an
+  /// If a [String], expects [InvalidGenerationSource.element] to match an
   /// element with the corresponding name.
   ///
-  /// If `true`, [InvalidGenerationSourceError.element] is expected to be
+  /// If `true`, [InvalidGenerationSource.element] is expected to be
   /// non-null.
   ///
-  /// If `false`, [InvalidGenerationSourceError.element] is not checked.
+  /// If `false`, [InvalidGenerationSource.element] is not checked.
   final dynamic element;
 
   const ShouldThrow(

lib/src/build_log_tracking.dart

@@ -23,7 +23,6 @@ void initializeBuildLogTracking() {
       '`initializeBuildLogTracking` should only be called once.',
     );
   }
-  // ignore: cancel_subscriptions
   StreamSubscription<void>? logSubscription;
 
   setUp(() {

lib/src/expectation_element.dart

@@ -71,6 +71,7 @@ const _mappers = {
   TypeChecker.fromRuntime(ShouldThrow): _shouldThrow,
 };
 
+// ignore: deprecated_member_use
 Iterable<TestExpectation> _expectationElements(Element element) sync* {
   for (var entry in _mappers.entries) {
     for (var annotation in entry.key.annotationsOf(element)) {

lib/src/generate_for_element.dart

@@ -1,4 +1,4 @@
-// ignore_for_file: implementation_imports
+// ignore_for_file: implementation_imports, deprecated_member_use
 
 import 'dart:async';
 

lib/src/init_library_reader.dart

@@ -87,6 +87,7 @@ class PathAwareLibraryReader extends LibraryReader {
   PathAwareLibraryReader({
     required this.directory,
     required this.fileName,
+    // ignore: deprecated_member_use
     required LibraryElement element,
   }) : super(element);
 

lib/src/test_annotated_classes.dart

@@ -354,6 +354,7 @@ class AnnotatedTest<T> {
         assert(exp.element is String);
         expectedElementName = exp.element as String;
       }
+      // ignore: deprecated_member_use
       elementMatcher = const TypeMatcher<Element>()
           .having((e) => e.name, 'name', expectedElementName);
     } else if (exp.element == true) {