[api-minor] Fix broken/missing JSDocs and typedefs, to allow updating TypeScript to the latest version (issue 14342)
#14373
Conversation
Snuffleupagus
force-pushed
the
update-TypeScript
branch
2 times, most recently
from
5dd9c00 to
771b33f
Compare
web/interfaces.js
Outdated
| /** @typedef {import("../src/display/api").PDFPageProxy} PDFPageProxy */ | ||
| // eslint-disable-next-line max-len | ||
| /** @typedef {import("../src/display/display_utils").PageViewport} PageViewport */ | ||
| // eslint-disable-next-line max-len | ||
| /** @typedef {import("./annotation_layer_builder").AnnotationLayerBuilder} AnnotationLayerBuilder */ | ||
| // eslint-disable-next-line max-len | ||
| /** @typedef {import("./pdf_rendering_queue").RenderingStates} RenderingStates */ | ||
| // eslint-disable-next-line max-len | ||
| /** @typedef {import("./struct_tree_builder").StructTreeLayerBuilder} StructTreeLayerBuilder */ | ||
| /** @typedef {import("./text_highlighter").TextHighlighter} TextHighlighter */ | ||
| // eslint-disable-next-line max-len | ||
| /** @typedef {import("./text_layer_builder").TextLayerBuilder} TextLayerBuilder */ | ||
| /** @typedef {import("./ui_utils").EventBus} EventBus */ | ||
| /** @typedef {import("./xfa_layer_builder").XfaLayerBuilder} XfaLayerBuilder */ | ||
|
|
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
/cc @michael-yx-wu @ineiti @tamuratak Would (either of) you perhaps be able to help with testing this patch?
Snuffleupagus
force-pushed
the
update-TypeScript
branch
2 times, most recently
from
eace896 to
aee8dc0
Compare
Snuffleupagus
force-pushed
the
update-TypeScript
branch
4 times, most recently
from
632af99 to
9cbede0
Compare
Snuffleupagus
changed the title
typedefs, to allow updating TypeScript to the latest version (issue 14342)typedefs, to allow updating TypeScript to the latest version (issue 14342)
Snuffleupagus
force-pushed
the
update-TypeScript
branch
from
9cbede0 to
51b2500
Compare
…t to the latest version (issue 14342) This patch circumvents the issues seen when trying to update TypeScript to version `4.5`, by "simply" fixing the broken/missing JSDocs and `typedef`s such that `gulp typestest` now passes. As always, given that I don't really know anything about TypeScript, I cannot tell if this is a "correct" and/or proper way of doing things; we'll need TypeScript users to help out with testing! *Please note:* I'm sorry about the size of this patch, but given how intertwined all of this unfortunately is it just didn't seem easy to split this into smaller parts. However, one good thing about this TypeScript update is that it helped uncover a number of pre-existing bugs in our JSDocs comments.
…s` file This patch, first of all, removes circular dependencies in the TypeScript definitions. Secondly, it also moves `RenderingStates` into `web/ui_utils.js` to break another type-dependency and directly use the `XfaLayerBuilder` during XFA-printing. Finally, note that this patch *slightly* reduces the size of the default viewer (e.g. in the `MOZCENTRAL` build) by not having to bundle code which is completely unused.
Snuffleupagus
force-pushed
the
update-TypeScript
branch
from
51b2500 to
e19020c
Compare
|
/botio test |
From: Bot.io (Linux m4)ReceivedCommand cmd_test from @Snuffleupagus received. Current queue size: 0 Live output at: http://54.241.84.105:8877/b608bf6e9da800d/output.txt |
From: Bot.io (Windows)ReceivedCommand cmd_test from @Snuffleupagus received. Current queue size: 0 Live output at: http://54.193.163.58:8877/7a1929342b0c382/output.txt |
From: Bot.io (Linux m4)FailedFull output at http://54.241.84.105:8877/b608bf6e9da800d/output.txt Total script time: 22.62 mins
Image differences available at: http://54.241.84.105:8877/b608bf6e9da800d/reftest-analyzer.html#web=eq.log |
From: Bot.io (Windows)FailedFull output at http://54.193.163.58:8877/7a1929342b0c382/output.txt Total script time: 35.81 mins
Image differences available at: http://54.193.163.58:8877/7a1929342b0c382/reftest-analyzer.html#web=eq.log |
|
/botio-windows browsertest |
From: Bot.io (Windows)ReceivedCommand cmd_browsertest from @Snuffleupagus received. Current queue size: 0 Live output at: http://54.193.163.58:8877/608d2d0209fde61/output.txt |
From: Bot.io (Windows)FailedFull output at http://54.193.163.58:8877/608d2d0209fde61/output.txt Total script time: 37.79 mins
Image differences available at: http://54.193.163.58:8877/608d2d0209fde61/reftest-analyzer.html#web=eq.log |
|
/botio-linux preview |
From: Bot.io (Linux m4)ReceivedCommand cmd_preview from @Snuffleupagus received. Current queue size: 0 Live output at: http://54.241.84.105:8877/718c8bd1d34909b/output.txt |
From: Bot.io (Linux m4)SuccessFull output at http://54.241.84.105:8877/718c8bd1d34909b/output.txt Total script time: 4.38 mins Published |
|
Hopefully this PR should also help reduce the number of problems whenever someone looks into issue #14017, however we (once again) need TypeScript users to help out there! |
|
Thank you for doing this! It's a nice improvement and it's good that the upgrade blocker is resolved now. |
|
Wow - great work @Snuffleupagus ! I'm not sure I would've been able to do it in a reasonable amount of time... |
This patch circumvents the issues seen when trying to update TypeScript to version
4.5, by "simply" fixing the broken/missing JSDocs andtypedefs such thatgulp typestestnow passes.As always, given that I don't really know anything about TypeScript, I cannot tell if this is a "correct" and/or proper way of doing things; we'll need TypeScript users to help out with testing!
Please note: I'm sorry about the size of this patch, but given how intertwined all of this unfortunately is it just didn't seem easy to split this into smaller parts.
However, one good thing about this TypeScript update is that it helped uncover a number of pre-existing bugs in our JSDocs comments.