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

Remove experimental plugin #178

Merged
merged 3 commits into from
Sep 29, 2023
Merged

Conversation

paul-sachs
Copy link
Collaborator

@paul-sachs paul-sachs commented Sep 27, 2023

@tanstack/react-query v5 is introducing some major changes to their types and also introduce suspense specific APIs (useSuspenseQuery, useSuspenseInfiniteQuery, and useSuspenseQueries). These APIs are pretty easy to integrate with the original plugin (non-react specific) but would need an additional two APIs generated for every service method. This starts to create a lot of noise with our auto-complete options:

As an example, if we have a service method called say, we now must generate useSayQuery, useSayInfiniteQuery, useSayMutation, useSaySuspenseQuery, and useSaySuspenseInfiniteQuery. This is increasingly making a lot of noise when just trying to use the say method from a service. This is much worse with larger service method names.

In keeping with best practices (limiting the number of ways to do a single thing), we've decided to remove this plugin from the repo.

@paul-sachs
Copy link
Collaborator Author

@vctqs1 After experimenting with this plugin, we've decided to remove it to simplify the offerings. Obviously you can fork and maintain the plugin yourself, but in order to maintain the API for v5 of react-query, we're going to keep to the original plugin as the primary means of generating helpers.

@paul-sachs paul-sachs merged commit ee30d41 into main Sep 29, 2023
5 checks passed
@paul-sachs paul-sachs deleted the psachs/remove-experimental-plugin branch September 29, 2023 17:34
@paul-sachs paul-sachs mentioned this pull request Oct 6, 2023
paul-sachs added a commit that referenced this pull request Oct 6, 2023
## What's Changed
* Remove experimental plugin by @paul-sachs in
#178
* Add ESM wrapper to avoid dual package hazard by @timostamm in
#180
* Fix missing implicit types by @mckelveygreg in
#211

## New Contributors
* @mckelveygreg made their first contribution in
#211

**Full Changelog**:
v0.5.1...v0.5.2
@vctqs1
Copy link
Contributor

vctqs1 commented Oct 19, 2023

@paul-sachs hi, sorry, but Could I publish this experiment plugin in my own? Is it illegal?

@paul-sachs
Copy link
Collaborator Author

@vctqs1 yes, you can most certainly publish your own plugin and package. Feel free to form the repo.

@vctqs1
Copy link
Contributor

vctqs1 commented Oct 21, 2023

@paul-sachs thank you 👍🏻

@paul-sachs
Copy link
Collaborator Author

@vctqs1 I thought you might be interested in #220. It's proposing a simplified API, but with full support of the expanded tanstack/react-query@v5 API.

@vctqs1
Copy link
Contributor

vctqs1 commented Nov 8, 2023

@paul-sachs ohm thank you, im currently working on Tanstack v4. Because of some breaking changes of onError/onSuccess in v5, it's make me afraid to upgrade version for now
It'd be great as #220 said, we might support parallel and migrator for both versions

I also noticed about tree-shaking problem in current source. Yeah, but glad to heard that your team're gonna to do an enhancement on this proposal also.

Please help me know and loop on any update on this proposal, and progressing. Thank you

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.

3 participants