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

[Type-definitions] Hack around the broken SVGGraphics import map (issue 16705) #16845

Closed
wants to merge 2 commits into from

Commits on Aug 16, 2023

  1. Configuration menu
    Copy the full SHA
    3c520d7 View commit details
    Browse the repository at this point in the history

Commits on Aug 17, 2023

  1. [Type-definitions] Hack around the broken SVGGraphics import map (i…

    …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.)
    Snuffleupagus committed Aug 17, 2023
    Configuration menu
    Copy the full SHA
    9019491 View commit details
    Browse the repository at this point in the history