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

fix(hooks): generate other https methods #74

Merged
merged 3 commits into from
Apr 20, 2024

Conversation

seriouslag
Copy link
Collaborator

@seriouslag seriouslag commented Apr 17, 2024

Before this patch, only GET queries and POST mutations were created.

We now generate mutation hooks for PUT, PATCH, and DELETE

This patch also fixes an issue where if prettier was installed, it would format the generated service files, changing the quotes around and breaking our checks to determine the HTTP method type.
Example before prettier: 'GET'
Example after prettier: "GET"

The prettier style of writing functionality was added by the underlying service file generator @hey-api/openapi-ts
I updated the checks to not care about quotes.

Added prettier as a dependency of the example app so that prettier will now run on the generated service files to act as a test for that feature.

fixes: #70
fixes: #75

Before this patch, only GET queries and POST mutations were created.

We now generate mutation hooks for PUT, PATCH, and DELETE
@seriouslag seriouslag requested a review from 7nohe April 17, 2024 16:24
@seriouslag seriouslag added the bug Something isn't working label Apr 17, 2024
prettier was replacing the quotes with double quotes causing th checks to break.
@seriouslag seriouslag force-pushed the hooks/generate-other-http-methods branch from 6267a8b to 3e89bf5 Compare April 20, 2024 00:29
@seriouslag
Copy link
Collaborator Author

Released a test version with this patch under: @seriouslag/openapi-react-query-codegen@next

@@ -16,6 +16,7 @@
"@tanstack/react-query": "^5.18.1",
"axios": "^1.6.7",
"form-data": "~4.0.0",
"prettier": "^3.2.5",
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this package necessary for this modification? I am considering Biome as a tool for linting and formatting in terms of performance and ease of implementation.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I created the PR #76.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is needed as a test for users of the repo, as described.
Prettier and eslint are used for the underlying @hey-api/openapi-ts, don't know why we would use biome over those tools.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. I just ran it again and indeed confirmed that Prettier is working. This is fine as it is.
However, I believe that the generated code should not be changed depending on whether Prettier is installed or not. Therefore, it might be a good idea to add comments like eslint-disable to the generated code, similar to what was done with the previous openapi-typescript-codegen.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, adding that would be good in my opinion.

@7nohe 7nohe merged commit 7f98d56 into main Apr 20, 2024
4 checks passed
@7nohe 7nohe deleted the hooks/generate-other-http-methods branch April 20, 2024 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

queries not working after upgrading from 0.5.3 to 1.0.6 V1 ommits put and delete requests
2 participants