generateForAnnotatedElement method
- Element element,
- ConstantReader annotation,
- 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
String generateForAnnotatedElement(
Element element,
ConstantReader annotation,
BuildStep buildStep,
) {
print('ComponentGenerator: Processing element ${element.name}');
helpers.validateClassElement(element, 'Component');
final classElement = element as ClassElement;
final className = element.name;
if (className == null) {
throw InvalidGenerationSourceError(
'@Component class must have a name',
element: element,
);
}
// Get the source file path from the build step
final sourceFilePath = buildStep.inputId.path;
// Verify the source file ends with _base.dart
if (!sourceFilePath.endsWith('_base.dart')) {
throw InvalidGenerationSourceError(
'@Component class must be in a file ending with _base.dart',
element: element,
);
}
// Generate complete reactive class with same name
return _generateCompleteReactiveClass(
classElement,
className,
annotation,
sourceFilePath,
);
}