fix(docz): dependency issues

adbayb commented 3 years ago

Description

A PR to address several high priority issues. It been tested by emulating new npm release through a local registry (please note that if you found several package version updates in some commits: it's totally normal and I've cleaned all tested version metadata to prepare a future release through this commit https://github.com/adbayb/docz/commit/24027115300b9b79d1811558044fb71357bd9fc5).

However, @renatobenks It could be great if you can publish a new alpha version to let issue authors confirms their issue resolution 😄

Main updates (fixes):

[x] Fixes https://github.com/doczjs/docz/issues/1642 via https://github.com/adbayb/docz/commit/5f5a5d08efbad69616a38446202e06baa12812b2 and https://github.com/adbayb/docz/commit/abbf8beca9d34a40f21fdfdf928e969429700ba3
[x] Fixes https://github.com/doczjs/docz/issues/1635 via https://github.com/adbayb/docz/commit/5f5a5d08efbad69616a38446202e06baa12812b2
I've fixed the get-pkg-repo to prevent incrementing to the broken patch version (hotfix docz side until a clean fix is done get-pkg-repo side)
[x] Fixes https://github.com/pedronauck/gatsby-starter-docz/issues/4 via https://github.com/adbayb/docz/commit/e48cd4a01c53f5a3b47bd2549809a954e6baaf84
[x] Fix unknown argument while running gatsby by preventing empty argument via https://github.com/adbayb/docz/commit/40dead8e84b643a21482a2531143aeb69431d694

👉 Some other issue reporting might be solved as well (I have not tested other issue resolution).

Other updates (chore):

[x] Make dev environment works using monorepo capabilities via https://github.com/adbayb/docz/commit/e48cd4a01c53f5a3b47bd2549809a954e6baaf84 and https://github.com/adbayb/docz/commit/822a0b7bf138fa8a6b103a6304b1c2bf04e39bda
[x] Clean some unused dependencies, collocate dependencies where they're needed and hoist dev dependencies to make local environment easier to maintain via https://github.com/adbayb/docz/commit/9ccdc44625c4e13e229936e5f2940a82c0f2a84e and https://github.com/adbayb/docz/commit/b33752748fa6c8bb28f944d773137be458c85651
[x] Fix lint errors via https://github.com/adbayb/docz/commit/a8fa53410ebcbe185059a21a763c2ba81b357b26

Opportunities (for future PRs)

[ ] Update all dependencies (especially gatsby ones)
[ ] Test with React 17 and update peerDependencies to accept newer version range

renatobenks commented 3 years ago

Awesome @adbayb, I'll gonna spend some time reviewing it, because I wanna stress some tests here, but great work!

So far I've seen, a couple issues are going to be fixed indeed!

adbayb commented 3 years ago

Hello @renatobenks 👋 , any update on this? 🙏

renatobenks commented 3 years ago

I'll be finishing some tests today, but once it's done, let's merge it, is that sounds good?

adbayb commented 3 years ago

Sounds good, thank you @renatobenks 🙏

adbayb commented 3 years ago

Any news @renatobenks ?

renatobenks commented 3 years ago

Sorry for the big delay here, but I'm managing a new release for this one. I just need to ensure a few things first with @pedronauck, once I'm still not so sure about removing a few dependencies, even though it seems a good idea. But in general, so far so good in all my tests (which we need to automate ASAP from now on), and also, it'll be a great contribution for us all!

Thank you a lot @adbayb for the heads up on here 🙂

renatobenks commented 3 years ago

hey @adbayb, are you willing to revert the removed dependencies? Let me know, because if not so, we could merge it right away, and right after that, evaluate those dependencies better before launching a new version. Otherwise, we'd be able to launch a new patch version, just after emerging this one. But in both cases, we wanna merge this PR.

adbayb commented 3 years ago

Hello @renatobenks 👋 , devDependencies are not removed: they are hoisted at the monorepo level (no impact consumer side since dev dependencies are not installed). But I can rollback it if you're more confortable with 👍

renatobenks commented 3 years ago

Actually, I'm concerned about the "unused" dependencies, from dev or not, but let me list all of them for you, so yeah, I'd feel more comfortable with you rolling back, to publish a new version.

adbayb commented 3 years ago

@renatobenks Done https://github.com/doczjs/docz/pull/1647/commits/90ab65d4376285fa9c7788fea6bcf51ffd7bbd86 Hope it'll help make your dependency review easier afterwards.

adbayb commented 3 years ago

@renatobenks Thank you for your review. Do you plan a release soon?

renatobenks commented 3 years ago

Yeap, I'm releasing today a new alpha version to the next patch, v2.3.2 respectively, and in the meantime, you can be using this one until having the final patch version, which we're pretending to launch as soon as we finish a couple of automated tests that we're working on.

Let us know if you have any issues towards this end.

adbayb commented 3 years ago

Thank you @renatobenks 🙏 . Unfortunately, I can't find the newly alpha. It seems that the latest one is the 2.0.0-rc.23 (publication date: 02/09/2019). Same for the next tag (the alpha.0 is not new). What's the right version please? Thanks in advance.

renatobenks commented 3 years ago

Hey @adbayb, this upcoming version it's on https://www.npmjs.com/package/docz/v/2.3.3-alpha.0 (https://github.com/doczjs/docz/tree/v2.3.3-alpha.0), still as alpha because I would like to get some people's feedback about how it goes, before launching it as a final patch, so please, let me know how it moves, that I'll be making some extra work for validation from here as well.

adbayb commented 3 years ago

Thanks @renatobenks , I've tested the alpha release: it works just fine in our company codebase 🚀

drewlustro commented 2 years ago

This is a lovely patch @adbayb, thank you for contributing it!

The react-docgen upgrade, in particular, made Prop table generation significantly more reliable for us.

Thanks again ❤️

renatobenks commented 2 years ago

We're about to release a new alpha version to that patch because I found a significant problem for those who are not using typescript and have it as not enabled.

doczjs / docz