generateForAnnotatedElement method

  1. @override
Future<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.

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

Implementation

@override
Future<String?> generateForAnnotatedElement(
    Element element, ConstantReader annotation, BuildStep buildStep) async {
  log.fine('Running SerializerGenerator');

  if (element.kind != ElementKind.CLASS) {
    throw 'Only classes can be annotated with a @Serializable() annotation.';
  }

  var ctx = await buildContext(element as ClassElement, annotation, buildStep,
      buildStep.resolver, !autoSnakeCaseNames);

  if (ctx == null) {
    log.severe('Invalid builder context');
    throw 'Invalid builder context';
  }

  var serializers = annotation.peek('serializers')?.listValue ?? [];

  if (serializers.isEmpty) {
    log.severe("No Serializers");
    return null;
  }

  // Check if any serializer is recognized
  if (!serializers.any((s) => Serializers.all.contains(s.toIntValue()))) {
    log.severe("No recognizable Serializers");
    return null;
  }

  var lib = Library((b) {
    generateClass(
        serializers.map((s) => s.toIntValue() ?? 0).toList(), ctx, b);
    generateFieldsClass(ctx, b);
  });

  var buf = lib.accept(DartEmitter(useNullSafetySyntax: true));
  return buf.toString();
}