generateForAnnotatedElement method

  1. @override
FutureOr<String> generateForAnnotatedElement(
  1. Element element,
  2. ConstantReader annotation,
  3. BuildStep buildStep
)

Implement to return source code to generate for element.

This method is invoked based on finding elements annotated with an instance of T. The annotation is provided as a ConstantReader.

Supported return values include a single String or multiple String instances within an Iterable or Stream. It is also valid to return a Future of String, Iterable, or Stream. When multiple values are returned through an iterable or stream they will be deduplicated. Typically each value will be an independent unit of code and the deduplication prevents re-defining the same member multiple times. For example if multiple annotated elements may need a specific utility method available it can be output for each one, and the single deduplicated definition can be shared.

Implementations should return null when no content is generated. Empty or whitespace-only String instances are also ignored.

Implementation

@override
FutureOr<String> generateForAnnotatedElement(Element element, ConstantReader annotation, BuildStep buildStep) async {

  // Extracting Data from all Elements and filling the data into a model to use everywhere
  ExtractedInfoModel dataModel = ExtractedInfoModel(
    element: element,
    source: element.source?.uri.path ?? Strings.unknown,
    type: element.metadata.first.element?.name?.getAnnotationType ?? AnnotationTypes.unknown,
    name: element.name ?? Strings.unknown,
    as: annotation.getAs,
    initialRoute: annotation.getIsInitial,
    unknownRoute: annotation.getIsUnknownRoute,
  );

  // Logging details about founded Annotation
  GeneratorLog.info(title: 'Annotation Found in', data: dataModel.source);
  GeneratorLog.info(title: 'Annotation Name', data: dataModel.name, as: dataModel.as);
  GeneratorLog.info(title: 'Annotation Type', data: dataModel.type);
  GeneratorLog.space();

  // Adding the Element in the main Generator
  CodeGenerator().addElement(dataModel);
  return Strings.empty;
}