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

JSDoc 4.0.0 #233

Closed
mdellanave opened this issue Nov 8, 2022 · 6 comments · Fixed by #247
Closed

JSDoc 4.0.0 #233

mdellanave opened this issue Nov 8, 2022 · 6 comments · Fixed by #247
Labels

Comments

@mdellanave
Copy link

Hi,
I'm trying to use better-docs (version 2.7.2) in my project with jsdoc 4.0.0 released a few days ago.

I have this error

FATAL: Unable to load template: Cannot find module 'taffydb'
Require stack:
- ..\node_modules\better-docs\publish.js
- ..\node_modules\jsdoc\cli.js
- ..\node_modules\jsdoc\jsdoc.js

With the previous version 3.6.11 it works.

Does better-docs needs an update to make it works with 4.0.0?

@jesusiglesias
Copy link

Same problem here.

Yes, better-docs needs an update to support Salty. Otherwise, it is necessary to follow up this guide.

https://github.com/jsdoc/jsdoc/tree/main/packages/jsdoc-salty#use-salty-in-a-jsdoc-template

@mdellanave
Copy link
Author

Thank you Jesus, is there any contributor who wants to take charge of the changes?

@kylegrabski
Copy link

THANK YOU FOR THIS!! I just rolled back to [email protected]

@cunneen
Copy link

cunneen commented Jun 15, 2023

Thanks to @drazisil for PR #247 linked above; I can use this with jsdoc@4 as follows:

yarn remove better-docs
yarn add -D 'git+https://github.com/drazisil/better-docs/#dfbd2e3158f119d247c2efbf72acc79d1ec4db5c'

I'm guessing it'd be something like this if you're using NPM:

npm uninstall better-docs
npm add -D 'git+https://github.com/drazisil/better-docs/#dfbd2e3158f119d247c2efbf72acc79d1ec4db5c'

@yura-master-web
Copy link

yarn add 'git+https://github.com/drazisil/better-docs/#dfbd2e3158f119d247c2efbf72acc79d1ec4db5c' -D
Usage Error: The git+https://github.com/drazisil/better-docs/#dfbd2e3158f119d247c2efbf72acc79d1ec4db5c string didn't match the required format (package-name@range). Did you perhaps forget to explicitly reference the package name?

$ yarn add [--json] [-E,--exact] [-T,--tilde] [-C,--caret] [-D,--dev] [-P,--peer] [-O,--optional] [--prefer-dev] [-i,--interactive] [--cached] [--mode #0]

Copy link

github-actions bot commented Dec 7, 2023

🎉 This issue has been resolved in version 2.7.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging a pull request may close this issue.

5 participants