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

Option to specify which jsdoc binary should be used #285

Open
coranos opened this issue Dec 9, 2022 · 5 comments
Open

Option to specify which jsdoc binary should be used #285

coranos opened this issue Dec 9, 2022 · 5 comments

Comments

@coranos
Copy link

coranos commented Dec 9, 2022

jsdoc has not had a release since 2017, and does not support BigInts

jsdoc/jsdoc#1918

@coranos
Copy link
Author

coranos commented Dec 9, 2022

nevermind, looks like its an administrative thing, the code is being updated.

@coranos coranos closed this as completed Dec 9, 2022
@75lb
Copy link
Member

75lb commented Dec 9, 2022

Hi, yes I'm aware jsdoc has not been updated in many years and it's a big part of the reason many issues on this project lie unresolved too.. There was one trivial jsdoc update recently (which i have now included), I will keep my eye out for more.

@coranos
Copy link
Author

coranos commented Dec 10, 2022

cool. can you add BigInt support? I created a PR, but not sure if anyone is home to merge it.

jsdoc/jsdoc#2024

@75lb
Copy link
Member

75lb commented Dec 10, 2022

I have had this issue before (waiting on jsdoc to merge fixes).. in the past, I maintained a separate fork of jsdoc which contained the fixes I needed to make jsdoc2md work.. I don't do that anymore, i used jsdoc directly..

Rather than hack jsdoc myself (again), I'd rather add support to jsdoc2md giving the user the option to specify which jsdoc binary should be used.. For example, a command like jsdoc2md --jsdoc-bin my-local-jsdoc-fork --files *.js would generate docs using the jsdoc fork you have modified locally.. this gives the user full control..

Needs a bit of investigation and an update to jsdoc-api.. Will get back to you..

@75lb 75lb changed the title consider forking jsdoc to add BigInt support Option to specify which jsdoc binary should be used Dec 10, 2022
@75lb 75lb reopened this Dec 10, 2022
@UmamiAppearance
Copy link

This is really odd. I always used JSDoc online documentation to reassure about the correct syntax, without ever considering to actually use the tool to generate documentation. Now I was curious if it can actually save some time when creating documentation. As I just wanted to create a README.md file I used jsdoc2md, or I must say try to use it as I straight ran into this issue.
Searching for a fitting binary or even creating a custom version kind of counteracts the time saving for me.

I can understand, that maintaining a separate fork is not very good option, but maybe it is an idea to apply patches for some problems bigger problems by using a tool like patch-package.

Best regards.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

3 participants