generateForAnnotatedElement method

  1. @override
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
String generateForAnnotatedElement(
  Element element,
  ConstantReader annotation,
  BuildStep buildStep,
) {
  if (element.isPrivate) {
    throw InvalidGenerationSourceError(
      'Widgetbook annotations cannot be applied to private methods',
      element: element,
    );
  }

  final useCaseName = annotation.read('name').stringValue;
  final typeElement = annotation.read('type').typeValue.element!;

  final typeValue = annotation.read('type').typeValue;
  final componentName = typeValue.getDisplayString(
    withNullability: false,
  );

  final componentDefinitionPath = typeValue.element!.librarySource!.fullName;

  final data = WidgetbookUseCaseData(
    name: element.name!,
    useCaseName: useCaseName,
    componentName: componentName,
    importStatement: element.importStatement,
    componentImportStatement: typeElement.importStatement,
    dependencies: typeElement.dependencies,
    componentDefinitionPath: componentDefinitionPath,
    useCaseDefinitionPath: element.librarySource!.fullName,
  );

  return [data].toJson();
}