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

fix(types): Add jsdoc plugin to handle ts-style imports #8225

Merged
merged 3 commits into from
Apr 5, 2023

Conversation

mister-ben
Copy link
Contributor

Description

The typedef import syntax we had to introduce for tsc output isn't compatible with jsdoc itself, see e.g. jsdoc/jsdoc#1645 . This is breaking the docs:api task.

Specific Changes proposed

Adds a jsdoc plugin to transform the import syntax to be understood by jsdoc.
Fixes a few other errors in jsdoc.

Requirements Checklist

  • Feature implemented / Bug fixed
  • Reviewed by Two Core Contributors

@mister-ben mister-ben changed the title Fix ts imports fix(types): Add jsdoc plugin to handle ts-style imports Apr 4, 2023
@codecov
Copy link

codecov bot commented Apr 4, 2023

Codecov Report

Merging #8225 (f2e74c7) into main (882f3af) will increase coverage by 0.12%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #8225      +/-   ##
==========================================
+ Coverage   82.11%   82.23%   +0.12%     
==========================================
  Files         112      112              
  Lines        7402     7430      +28     
  Branches     1785     1791       +6     
==========================================
+ Hits         6078     6110      +32     
+ Misses       1324     1320       -4     
Impacted Files Coverage Δ
src/js/big-play-button.js 27.58% <ø> (ø)
src/js/clickable-component.js 90.00% <ø> (ø)
src/js/close-button.js 92.85% <ø> (ø)
src/js/component.js 93.09% <ø> (ø)
...-bar/audio-track-controls/audio-track-menu-item.js 3.03% <ø> (ø)
src/js/control-bar/fullscreen-toggle.js 94.11% <ø> (ø)
src/js/control-bar/live-display.js 100.00% <ø> (ø)
src/js/control-bar/mute-toggle.js 94.59% <ø> (ø)
src/js/control-bar/picture-in-picture-toggle.js 83.87% <ø> (+4.56%) ⬆️
src/js/control-bar/play-toggle.js 84.84% <ø> (ø)
... and 56 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@mister-ben
Copy link
Contributor Author

Hmm, it's outputting filenames like module-videojs-videojs.html#.AudioTrack, global.html#TextTrackMenuItem

@mister-ben mister-ben marked this pull request as draft April 4, 2023 17:05
@misteroneill misteroneill added the ts TypeScript label Apr 4, 2023
@mister-ben mister-ben marked this pull request as ready for review April 4, 2023 21:00
@mister-ben mister-ben requested a review from gkatsev April 4, 2023 21:00
@mister-ben
Copy link
Contributor Author

Moved all the type imports inline, has resolved the build errors and netlify output.

@misteroneill misteroneill merged commit 61bd74d into videojs:main Apr 5, 2023
edirub pushed a commit to edirub/video.js that referenced this pull request Jun 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ts TypeScript
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants