tsc error when trying to build using the getting started instructions about express-zod-api HOT 7 CLOSED

I closed the PR with a comment. I think you're right that this should be a recommended tsconfig setting, and there's no need to document the installation of the existing types.

Thank you!

from express-zod-api.

In order to unblock myself, I ran the following:

yarn add -D @types/compression @types/express-fileupload @types/winston

I may have missed something, and installing these types may not be the desired fix, but it's at least letting me progress.

from express-zod-api.

@brainthinks ,

Your dev environment tries to compile/validate node_modules.
Please ensure having the following option in your tsconfig.json:

{
  "compilerOptions": {
    "skipLibCheck": true,
  }
}

Or consider extending from a recommended base:
https://github.com/tsconfig/bases

Please let me know if this worked.

from express-zod-api.

Managed to reproduce the issue.
Not a bug, but rather lack of Typescript configuration.
I will mention it in the documentation.

from express-zod-api.

Wow, thank you for the immediate response and update! I had planned to offer a PR to you today, but you beat me to it.

Regarding the need to include the skipLibCheck configuration, this will indeed "fix" the issue and unblock newcomers like myself. I think it's worth noting though that I haven't needed to do this for any other dependency (yet). I do think that asking people to set it is a reasonable approach, even more so since this is the way it is configured in the recommended base. In my opinion, a small section in the README for installing the necessary deps to not need to skip lib checks would be helpful, but I can also understand leaving that out as an exercise to the readers (like myself) who want the ability to configure their project in a way that differs from what you recommend. If you agree that mentioning the installation of the types as an alternative is desirable, I'm happy to submit a PR for it.

Either way, thanks!

from express-zod-api.

It seems to be fine now, @brainthinks , the requirement on the necessary types is already there:

v18	v17

The ones that you had to install to unblock yourself

yarn add -D @types/compression @types/express-fileupload @types/winston

Are not necessary when skipLibCheck is enabled, because winston, compression and express-fileupload are optional peer dependencies.

But in case I didn't understand something, feel free to make a PR.

from express-zod-api.

Submitted - #1696

This is what I would have liked to see in the getting started section, for compatibility with the way I/we set up projects. I understand that this may not align with your vision, and adds slight overhead / maintenance burden.

Thanks for taking the time to look at this.

from express-zod-api.