better-docs icon indicating copy to clipboard operation
better-docs copied to clipboard

Published 20 hours ago • verified publisher icon SoftwareBrothers

Chore/jsdoc4 update

Open njetsy opened this issue 2 years ago • 8 comments

Some updates to improve compatibility with current versions of packages:

  • #233 Added support for JSDoc4.
  • #227 Added support for React 18 and updated React render functions.
  • #209 Added support for parcel v2 over parcel-bundler
  • #173 Fixed issue with live rendering not working for functional components/react 18.
  • #132 Fixed issue with live render resizing.
  • #219 Minimum version of node now v16.
  • #222 Updated packages to remove npm audit findings.
  • Fixed prop types not being recognized correctly with @component tag

This probably needs some more work or another look over but it should be a good start. I did not do any vue testing, but it is working with the latest version of parcel 2, react 18, and jsdoc 4. Both category and component tags confirmed working with live previews and prop-type recognition.

(Thanks for the amazing head start with this BTW!)

njetsy avatar Feb 25 '23 22:02 njetsy

Added in fix for #174. Subcategory now works for globals.

njetsy avatar Mar 02 '23 23:03 njetsy

@wojtek-krysiak Can anyone help us here? This PR would really be welcome by the community since it fixes so many issues.

absqueued avatar Mar 07 '23 20:03 absqueued

Yeah, this PR defs fixes issues I've been having with better-docs

pacholoamit avatar Mar 10 '23 16:03 pacholoamit

Another vote that this works. Installed this version with jsdoc 4.0.2 and the audit issues are resolved while my docs still work the same

wmurphyrd avatar Mar 29 '23 18:03 wmurphyrd

Any progress on this?

par5ul1 avatar Aug 08 '23 01:08 par5ul1

@njetsy @par5ul1 @wmurphyrd @pacholoamit @absqueued

Hi, I've just released this on new @dev channel: https://github.com/SoftwareBrothers/better-docs/releases/tag/v2.7.4-dev.1 There's no changelog available because semantic-release relies on feat: and fix: prefixed commits to build it. I'll fix it later when merging this PR to master. I haven't been able to test these changes, that's why it's prereleased for now. Keep in mind you can have issues with @component tag since it's unit tests failed and I temporarily disabled them to force this release. I'll try to play around with this library and hopefully bring it back to life soon...

You can install this via yarn add better-docs@dev.

The old beta prerelease channel will be archived soon. It diverged too much from the master branch for some reason...

dziraf avatar Dec 07 '23 20:12 dziraf

Thank you so much for the update!! I'll give the new version a go.

njetsy avatar Dec 08 '23 01:12 njetsy

@dziraf

Thank you again for releasing this! Everything is working perfectly in my setup.

As an FYI, I've only run into two issues when using the @component tag so far:

  1. If a @component renders a react-router <Outlet />, the build crashes.
  2. If there is no default export in a file, the build crashes.

In both cases I think parcel spits out an error during the bundling process.

njetsy avatar Dec 09 '23 16:12 njetsy