🐝: decouple annotation classes in renderer #269
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tim-evans
reviewed
Oct 28, 2019
| @@ -233,6 +233,22 @@ function getNumberOfRequiredBackticks(text: string) { | |||
| }, 1); | |||
| } | |||
|
|
|||
| function isBold(annotation?: any) { | |||
There was a problem hiding this comment.
Type predicates may be very helpful here.
There was a problem hiding this comment.
Yep, that's what I was looking for. But now I'm not sure if this is the right approach. If we theoretically had access to document.schema.Bold then it would be better to rely on that.
|
Tracking discussion can be found here: https://docs.google.com/document/d/e/2PACX-1vS-KB02JBJjVe_fl1w3w0ONjm8jLWlHH98kTqNIlxfriEcjGvtz1Nm8l2BT5Ea7vjT8Wq9NJh3i2T1D/pub |
|
I chatted with @bachbui briefly, but it has occurred to me that we could rewrite this for more maximal reuse: function is<T extends AnnotationConstructor>(
AnnotationClass: T,
annotation: Annotation<any>
): annotation is InstanceType<T> {
let OtherClass = annotation.constructor as AnnotationConstructor;
return annotation.type === AnnotationClass.type &&
OtherClass.vendorPrefix === AnnotationClass.vendorPrefix;
} |
|
This can be closed by the new |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently there is logic in the Commonmark Renderer that checks for specific annotation classes in the rendering logic. We should decouple this, as this means this renderer will only work with specific Sources. Instead, the renderer should expose its own types or interfaces for annotations rather than using the annotation classes from a source directly. This fix resolves the immediate issue instead of fleshing out the aforementioned feature, which can be done at a later date.