source_gen
source_gen copied to clipboard
dart-lang
Add a note about not importable annotations
The build systems run on the Dart VM only, so there are limitations on
what imports can be used by builders. Add documentation describing how
to work around this limitation by overriding the TypeChecker with
something other than fromRuntime.
Should we just provide a
GeneratorForMatchingAnnotationwhich takes a TypeChecker?
Just as a factory even, would be great. A follow-up is good here.
Should we just provide a
GeneratorForMatchingAnnotationwhich takes a TypeChecker?Just as a factory even, would be great. A follow-up is good here.
The existing design imposes an extends already - you are intended to override generateForAnnotatedElement.
It would be nice to change that and allow composition but 🤷♂️
Given the current design, I think @override fits. WDYT?
Given the current design, I think
@overridefits. WDYT?
Ya the design I would envision is making a base class that just takes a type checker, and then the existing class would just extend that to make the type checker for you.
I wouldn't change anything about how it works generally, just which class you extend would change (and what you pass to the super constructor)
which class you extend would change (and what you pass to the super constructor)
Adding another class to the public API would increase the surface area of the package and IMO make things harder to find.
Adding another class to the public API would increase the surface area of the package and IMO make things harder to find.
🤷♂️ I don't really agree, I think its significantly better than doing the whole GeneratorForAnnotation<void> thing and then overriding the type checker. Overriding the type checker in that way is definitely a bit funky, and you are relying essentially on how that thing is being used internally in the super class...
I'm not able to find a design I like here with another class (especially because I can't think of a nice name).
With a breaking change I could imagine something different, maybe where we drop the generic and you need a constructor when forwards to super.forType(someType) or super.forTypeChecker(someTypeChecker). If we're going with a breaking change we may as well drop the need for extends entirely though...
I still really don't like the GeneratorForAnnotation<void> suggestion personally. Should we instead just tell people to split up their annotation libraries so they don't have those imports?
Should we instead just tell people to split up their annotation libraries so they don't have those imports?
I don't know if that is always feasible - some annotations could use dart:ui classes as arguments.
@jakemac53 - is this implementation of GeneratorForMatchingAnnotation match what you were thinking?