Couple of issues handling and features

[Muhammad-Altabba]

Hi,
Liked this library but faced some issues and needed some enhancements. The changes and can be checked at: main...Muhammad-Altabba:zod2md:multi-modifications.

Almost every commit fixes or enhancing something. Please feel free to cherry-pick the commit you like to merge an some new PR. And let me know if you like my collaboration.

Here is the list of issues and features:

1. the repos uses prettier to format the code but the prettier config is not published. So, I could infer the config and pushed it at:
   add prettier config allined with the already used styling (to unify styling among the team)

2. The .description('...') is not rendered for union and intersection. The code for it is here: render Description at union and intersection. And surely you may have another way for rendering.

3. The type ZodLazy is not handled. I provided an implementation that delays resolving the lazy schemas a bit. Here is the implementation that is good but might be written in a better way: handle ZodLazy

4. there is a warning when building the project that could be handled as in: fix circular dependency warnings during build.

5. For some strange reason, the check instance of does not work. At least when linking the project locally and sometimes when normally importing the project (I am using pnpm 10.4.0 and node 20.18.3). This could be handled at: fix an issue: does not always work

6. The used bundleRequire is not able to import the modules correctly when there is an import inside the provided typescript file that contain the Zod schemas. For this I needed to export more functions and types from zod2md so I can override the place where bundleRequire.

You might check how the library is used at: nucypher/taco-web#622. Where I used a modified version of zod2md that addressed the above.

Thanks for the great library! Keep up the good spirit! And let me know if you need someone to give a hand.

[matejchalk]

Hi @Muhammad-Altabba, thanks a lot for your contribution. 👏 I went through the code changes and while I'd like to suggest a few improvements, overall I really like what you've done. 👍 Would you be up for opening a PR? I could give you some feedback during code review and then we can merge in your contributions. 🙂

[Muhammad-Altabba]

Hi @matejchalk, sorry for the late reply.
If there are sill som interests and you did not already update your code making all the mentioned edits obsolete, what about you cherry-pick the ones that you would add directly. And then tell me about the ones that would need the least review so I can open a PR and see how it could go?

[Muhammad-Altabba]

Hello @matejchalk, are you still interested?

[matejchalk]

Hi, I haven't forgotten about you. 😅 It's just that I haven't had much time for this project, and I've been working on a large refactor to modularize the whole codebase (in modularize branch) that I need to finish first.

The codebase has already changed quite a bit since this issue was opened, mainly when I added Zod 4 support in #18. So I suspect a lot of your code changes will need updating, and some may not be relevant anymore.

1. the repos uses prettier to format the code but the prettier config is not published. So, I could infer the config and pushed it at:
   add prettier config allined with the already used styling (to unify styling among the team)

This is some low-hanging fruit which I still haven't done. As it's still relevant, would you like to open a small PR for the Prettier config?

2. The .description('...') is not rendered for union and intersection. The code for it is here: render Description at union and intersection. And surely you may have another way for rendering.

I'm not sure if this is still an issue, I'd have to investigate further. Zod v4 had some major changes with regard to the description, they now live in z.globalRegistry. In general, it helps to add the description at the end of the chain of schema transformations.

3. The type ZodLazy is not handled. I provided an implementation that delays resolving the lazy schemas a bit. Here is the implementation that is good but might be written in a better way: handle ZodLazy

I've since added support for z.lazy, it should work in both v3 and v4.

4. there is a warning when building the project that could be handled as in: fix circular dependency warnings during build.

This is probably still relevant for the main branch. I'm moving these files around as part of my refactor anyway. But I'm not sure when I'll be done, so I'd be happy to merge your fix if you submit a PR.

5. For some strange reason, the check instance of does not work. At least when linking the project locally and sometimes when normally importing the project (I am using pnpm 10.4.0 and node 20.18.3). This could be handled at: fix an issue: does not always work

The instanceof checks won't work if zod2md and the user code are using different zod installations. This is why zod has to be a peer dependency of zod2md, not a direct dependency. It should work for typical user setups, but it's possible to run into this problem in some more improvised setups.

6. The used bundleRequire is not able to import the modules correctly when there is an import inside the provided typescript file that contain the Zod schemas. For this I needed to export more functions and types from zod2md so I can override the place where bundleRequire.

Weird, I haven't run into any problem for files with imports in bundle-require. I'd need access to a reproduction in order to figure out what's going wrong. I'm also not opposed to using different implementations like jiti or even plain old dynamic import (once Node has stable TypeScript support).