search

7nohe / openapi-react-query-codegen

OpenAPI React Query Codegen is a code generator for creating React Query (also known as TanStack Query) hooks based on your OpenAPI schema.
https://openapi-react-query-codegen.vercel.app
MIT License
298 stars 30 forks source link

List react-query v4 as a peer dependency #134

Open IsaacLeeWebDev opened 3 months ago

IsaacLeeWebDev commented 3 months ago

Is your feature request related to a problem? Please describe.

Right now, this tool generates code that imports react-query like this:

import { UseQueryResult } from "@tanstack/react-query";

These imports don't work if you've installed a version of react-query before v4, whose imports have to look like this:

import { UseQueryResult } from "react-query";

Describe the solution you'd like List react-query v4 and up as a peer dependency of this package

Describe alternatives you've considered This tool could also support generating v3-style imports with a CLI option. That said, I could see how supporting old versions of react-query could go far beyond this one incompatibility, and I could see officially how providing that support could potentially significantly increase the maintenance demand of this package.

I suppose I could also run a string-replace to change @tanstack/react-query to react-query on every generated file.

Additional context

seriouslag commented 3 months ago

Our api does not support that version of react query. That package should be changed to use the package under the @tanstack name.

IsaacLeeWebDev commented 3 months ago

Our api does not support that version of react query. That package should be changed to use the package under the TanStack name.

That's fine! That's why I suggested listing the tanstack-named package as a peer dependency, so that those using older versions get a warning message when they install the package.