[Type-definitions] Hack around the broken SVGGraphics import map (issue 16705)
#16845
Conversation
This reverts commit d9350c3.
…ssue 16705) Previous attempts at "importing" the `@typedef` caused the JSDoc-generation to fail, however it seems that prepending it with `@ignore` causes JSDoc to completely skip the rest of the line while TypeScript will (seemingly) parse the `@typedef` as usual. While both `gulp jsdoc` and `gulp typestest` pass with this patch, it's unfortunately nothing more than a crude work-around for the actual issue. This way of "fixing" issue 16705 does feel very undesirable, for a number of reasons: - It does nothing to address the underlying issue, i.e. that the Type-generation doesn't understand the import maps, which means that the same problem could resurface somewhere else in the code-base next week/month. - It feels very arbitrary/brittle, since a future update of JSDoc and/or TypeScript could very easily break this hack. - It further increases the maintenance burden for the Type-generation, when the opposite would be desirable here. (Since it's already very difficult to get TypeScript users to *actively* help with maintaining this code.)
|
/botio preview |
From: Bot.io (Windows)ReceivedCommand cmd_preview from @Snuffleupagus received. Current queue size: 0 Live output at: http://54.193.163.58:8877/446d621c9ad6acb/output.txt |
From: Bot.io (Linux m4)ReceivedCommand cmd_preview from @Snuffleupagus received. Current queue size: 0 Live output at: http://54.241.84.105:8877/240e63226e036b7/output.txt |
From: Bot.io (Linux m4)SuccessFull output at http://54.241.84.105:8877/240e63226e036b7/output.txt Total script time: 1.44 mins Published |
From: Bot.io (Windows)SuccessFull output at http://54.193.163.58:8877/446d621c9ad6acb/output.txt Total script time: 11.35 mins Published |
|
In issue #16705 only a single TypeScript user has, so far, actually attempted to help debug/fix this problem. Hence this unfortunately once again highlights the problem with the type-definitions, which is that many (or most) TypeScript users seem unable (or unwilling) to actively help maintain the types. With this in mind, if you're using the PDF.js library in a commercial setting and depend on working type-definitions, please consider https://github.com/sponsors/Snuffleupagus/ |
|
@Snuffleupagus I submitted a proper solution in #16890 |
Previous attempts at "importing" the
@typedefcaused the JSDoc-generation to fail, however it seems that prepending it with@ignorecauses JSDoc to completely skip the rest of the line while TypeScript will (seemingly) parse the@typedefas usual.While both
gulp jsdocandgulp typestestpass with this patch, it's unfortunately nothing more than a crude work-around for the actual issue.This way of "fixing" issue #16705 does feel very undesirable, for a number of reasons: