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

Support tuples for JSDoc #4368

Closed
wants to merge 1 commit into from
Closed

Conversation

kungfooman
Copy link
Collaborator

Fixes #4197 (comment)

Issue open since 2015: jsdoc/jsdoc#1073
Issue open since 2019: jsdoc/jsdoc#1703

Based on that they couldn't care enough for the last 7 years, I just fixed the Catharsis#parse function myself.

I confirm I have read the contributing guidelines and signed the Contributor License Agreement.

@willeastcott
Copy link
Contributor

willeastcott commented Jun 29, 2022

This is an ingenious workaround. But I'm not particularly comfortable hacking around a missing feature in JSDoc. I have a goal to eliminate as many files and configuration from the root of the repo as possible - this keeps it simple and accessible to contributors - but this PR introduces a new root script just to fix the return type of an internal function. I just don't think it's worth it, to be honest - at least for now (I do appreciate that this can now be applied to other JSDoc blocks). On balance, for now, I'd rather kick that @returns tag back to something vanilla JSDoc can process.

@kungfooman
Copy link
Collaborator Author

I could add a folder called src_build which collects the small snippets (types-*.js) that support the build process? Then it can also have a little README.md giving an overview of whats going on.

I don't really feel like lagging behind in proper typing just because another project can't get their stuff together. What if the JSDoc project takes another 7 years or dies as a whole before that?

@kungfooman
Copy link
Collaborator Author

I am trying to add named/unnamed tuple support into catharsis (which is used by JSDoc), so eventually it may be supported and this hacky PR can be forgotten about 😅

hegemonic/catharsis#70

@kungfooman kungfooman closed this Aug 5, 2022
@willeastcott
Copy link
Contributor

Nice - that'd definitely be the ideal solution. Thanks @kungfooman!

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.

2 participants