Run & review this pull request in StackBlitz Codeflow.

The latest updates on your projects. Learn more about Vercel for Git ↗︎

🦋 Changeset detected

Latest commit: f89e478

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Codecov Report

❌ Patch coverage is 3.78788% with 127 lines in your changes missing coverage. Please review.
✅ Project coverage is 22.43%. Comparing base (a650513) to head (f89e478).
⚠️ Report is 11 commits behind head on main.

@@            Coverage Diff             @@
##             main    #2399      +/-   ##
==========================================
- Coverage   22.46%   22.43%   -0.03%     
==========================================
  Files         324      325       +1     
  Lines       31971    32027      +56     
  Branches     1234     1234              
==========================================
+ Hits         7181     7186       +5     
- Misses      24781    24832      +51     
  Partials        9        9              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Open in StackBlitz

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/nuxt@2399

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/openapi-ts@2399

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/vite-plugin@2399

commit: f89e478

@ahmedrowaihi is attempting to deploy a commit to the Hey API Team on Vercel.

A member of the Team first needs to authorize it.

@ahmedrowaihi are you willing to improve this feature further? I have some ideas. Aside, can you pick a smaller spec for snapshots? We don't need the big one to demonstrate this feature. We'd get a much nicer diff, there's too much irrelevant stuff included now. I think a few endpoints would suffice to showcase this feature, what do you think?

@ahmedrowaihi are you willing to improve this feature further? I have some ideas.

I am all ears ! tell me

Aside, can you pick a smaller spec for snapshots? We don't need the big one to demonstrate this feature. We'd get a much nicer diff, there's too much irrelevant stuff included now. I think a few endpoints would suffice to showcase this feature, what do you think?

true, will use smaller one

I would suggest making this an optional function that's completely customizable as long as it returns a valid meta result. I believe those have to be objects?

The concern I have with having a boolean or an array of fields is that it deeply relies on the current operation model which might change. I'd almost say making it an object with toggleable fields would've been better as one could hover over them and get more contextual information... but! The problem this seems to be solving is so custom that offering any sort of cookie cutter preset might be useless. Are you using all of those fields for your own needs?

There's a reason why even TanStack doesn't provide too much guidance around this field. You can put anything in there. As such, I'd expect people to want to customize this option with their own function anyway. Accepting a function should simplify the implementation a great deal as well.

If there is a preset worth providing, we might consider exporting it from the package itself so people could compose multiple functions together. Again, it comes back to the assumption that they'll want custom logic here

I would suggest making this an optional function that's completely customizable as long as it returns a valid meta result. I believe those have to be objects?

I was about to write : meta: (operation): Object

The concern I have with having a boolean or an array of fields is that it deeply relies on the current operation model which might change. I'd almost say making it an object with toggleable fields would've been better as one could hover over them and get more contextual information... but! The problem this seems to be solving is so custom that offering any sort of cookie cutter preset might be useless. Are you using all of those fields for your own needs?

usually not all, partially, that's why this PR allows full operation model or partial

There's a reason why even TanStack doesn't provide too much guidance around this field. You can put anything in there. As such, I'd expect people to want to customize this option with their own function anyway. Accepting a function should simplify the implementation a great deal as well.

If there is a preset worth providing, we might consider exporting it from the package itself so people could compose multiple functions together. Again, it comes back to the assumption that they'll want custom logic here

reasonable

--
cooking ...

@mrlubos here you go

@ahmedrowaihi any idea why the snapshots are mismatched?

@ahmedrowaihi any idea why the snapshots are mismatched?

No idea, this happened also in previous PR, the snapshot setup seems like it needs a cleanup

@ahmedrowaihi double check you wiped all generated and snapshot folders before running it again, especially if you were adding/removing/renaming snapshots

@ahmedrowaihi double check you wiped all generated and snapshot folders before running it again, especially if you were adding/removing/renaming snapshots

I just did that right now, let's hope this one pass

finally it worked 🎉

@ahmedrowaihi I just merged an update to the docs, mind resolving the small conflict?

@mrlubos there is something wierd, looks like the plugin is generting broken index.ts file after last changes

@mrlubos there is something wierd, looks like the plugin is generting broken index.ts file after last changes

whenever I try to move snapshots without making path @TanStack repeated, I find it either bugging or it's inconsistent with other conventions in the snapshots folders.

TBH, having multiple @TanStack is not big deal as if we will add more tools for tanstack it would live in same dir

Thanks for catching those broken links to Svelte docs, great attention to detail