Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle @stubbed markings from theia API versions #37

Closed
wants to merge 1 commit into from

Conversation

alvsan09
Copy link

@alvsan09 alvsan09 commented Aug 26, 2022

Fixes: #34

This change handles @stubbed markings from theia.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 and
make 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..

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:
filtered_status_stubbed

@colin-grant-work
Copy link
Contributor

@alvsan09, based on your approach I've pushed a commit to #36 that checks for @stubbed and marks nodes appropriately. Since merging this PR and then that one would create many conflicts, would you mind giving your feedback on what I've done there?

@stubbed
Copy link

stubbed commented Aug 27, 2022

@colin-grant-work @alvsan09 hey guys can you stop mentioning me

@alvsan09
Copy link
Author

@alvsan09, based on your approach I've pushed a commit to #36 that checks for @stubbed and marks nodes appropriately. Since merging this PR and then that one would create many conflicts, would you mind giving your feedback on what I've done there?

That is fine, I will review it on #36

@alvsan09
Copy link
Author

Closing this PR as this functionality has now been included as part of PR #36

@alvsan09 alvsan09 closed this Aug 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow marking of stubbed API via the 'info.yml' file
3 participants