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

Chore/jsdoc4 update #242

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

njetsy
Copy link

@njetsy njetsy commented Feb 25, 2023

Some updates to improve compatibility with current versions of packages:

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
Copy link
Author

njetsy commented Mar 2, 2023

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

Copy link

@absqueued absqueued left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@njetsy everything looks good to me.

NAB: Some files formatting is odd. Eg. publish.js Line 372, react-wrapper.js Line 74.

@absqueued
Copy link

absqueued commented Mar 7, 2023

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

@pacholoamit
Copy link

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

@wmurphyrd
Copy link

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

@par5ul1
Copy link

par5ul1 commented Aug 8, 2023

Any progress on this?

@dziraf
Copy link

dziraf commented Dec 7, 2023

@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...

@njetsy
Copy link
Author

njetsy commented Dec 8, 2023

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

@njetsy
Copy link
Author

njetsy commented Dec 9, 2023

@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.

absqueued added a commit to optimumfuturist/swc-webpack-npm-starter that referenced this pull request Jul 22, 2024
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.

6 participants