feat: Support awsuiSystem jsdoc tags
#59
Conversation
just-boris
force-pushed
the
components-without-typedoc
branch
from
2285ec3 to
76f2e86
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #59 +/- ##
==========================================
+ Coverage 90.02% 90.52% +0.50%
==========================================
Files 16 16
Lines 461 517 +56
Branches 130 136 +6
==========================================
+ Hits 415 468 +53
- Misses 46 49 +3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| if (maybeList.kind !== ts.SyntaxKind.SyntaxList) { | ||
| return []; | ||
| } | ||
| const rawComments: Array<string | undefined> = []; |
There was a problem hiding this comment.
Here begins manual comments parsing from Typescript AST.
There is no high level API for that: microsoft/TypeScript#38106 so I followed manual TypeDoc implementation as a reference.
Why not using Typedoc, if they have this feature? – because they do not expose this in a consumable way.
So, we will have this code for now until there is a first-class feature for that
just-boris
force-pushed
the
components-without-typedoc
branch
2 times, most recently
from
6fa3a4d to
29b2c10
Compare
just-boris
force-pushed
the
components-without-typedoc
branch
from
29b2c10 to
ef9c77b
Compare
| return tag ? tag.text ?? '' : undefined; | ||
| } | ||
|
|
||
| function getMultipleCommentTag(description: ExtractedDescription, name: string) { |
There was a problem hiding this comment.
Nitpick: can we name this getMultipleCommentTags in plural? (or even just getCommentTags —getMultipleCommentTag suggested me that there are multiple comments to parse, instead of (potentially) multiple tags to output)
| name, | ||
| releaseStatus: 'stable', | ||
| description: componentDescription.text, | ||
| systemTag: getMultipleCommentTag(componentDescription, 'awsuiSystem'), |
2 participants
Issue #, if available:
Description of changes:
Implement design described in this quip: GPxrABVyujLV
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.