Handle @stubbed markings from theia API versions #37
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.
Fixes: #34
This change handles
@stubbed
markings fromtheia.d.ts
versions,the markings are expected within the boundaries of corresponding 'jsdoc`
This change updates the parser in order to read the special
@stubbed
marking andmake this information available to the sequence generating the
html
reports.How to Test:
Replace
grab-theia-versions.ts#THEIA_URL_PATTERN
,to: 'https://raw.githubusercontent.com/alvsan09/test_theia.d.ts/${VERSION}/theia.d.ts'
The above URL points to a repository containing modified
theia.d.ts
files which are git tagged with versions i.e.v1.28.0, v1.29.0 and the latest master, the markings are in different places covering Classes, Interfaces, Enums, functions, etc..
filtered-status.html
is found at: https://gist.github.com/alvsan09/a329e2a1c91992577d1618e562688f41stubbed
NOTE: During the testing, it was noted that constructors require a special parsing, so
jsdoc
's are not directly read and therefore markings as well as documentation hover on constructors are currently not supported.Related to: #36
Example view: