feat(eslint-plugin-query): add rule to ensure property order of infinite query functions #8072
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
documentation
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 6182304. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
More templates
@tanstack/angular-query-devtools-experimental
@tanstack/eslint-plugin-query
@tanstack/angular-query-experimental
@tanstack/query-async-storage-persister
@tanstack/query-broadcast-client-experimental
@tanstack/query-core
@tanstack/query-devtools
@tanstack/query-persist-client-core
@tanstack/query-sync-storage-persister
@tanstack/react-query-devtools
@tanstack/react-query
@tanstack/react-query-next-experimental
@tanstack/react-query-persist-client
@tanstack/solid-query
@tanstack/solid-query-devtools
@tanstack/solid-query-persist-client
@tanstack/svelte-query
@tanstack/svelte-query-devtools
@tanstack/svelte-query-persist-client
@tanstack/vue-query
@tanstack/vue-query-devtools
commit: |
schiller-manuel
force-pushed
the
feat/eslint-infinite-query-property-order
branch
2 times, most recently
from
6736760
to
4084d0b
Compare
TkDodo
requested changes
Sep 20, 2024
...t-plugin-query/src/rules/infinite-query-property-order/infinite-query-property-order.rule.ts
Outdated
Show resolved
Hide resolved
schiller-manuel
force-pushed
the
feat/eslint-infinite-query-property-order
branch
from
a08116f
to
4084d0b
Compare
…ite query functions
schiller-manuel
force-pushed
the
feat/eslint-infinite-query-property-order
branch
from
82228d7
to
a8ad7af
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #8072 +/- ##
=========================================
+ Coverage 0 44.97% +44.97%
=========================================
Files 0 199 +199
Lines 0 7362 +7362
Branches 0 1664 +1664
=========================================
+ Hits 0 3311 +3311
- Misses 0 3674 +3674
- Partials 0 377 +377 |
TkDodo
reviewed
Sep 20, 2024
Comment on lines
+9
to
+13
| export const checkedProperties = [ | ||
| 'queryFn', | ||
| 'getPreviousPageParam', | ||
| 'getNextPageParam', | ||
| ] as const |
There was a problem hiding this comment.
is this the full order that we must have in the object? Because it shouldn't matter if getNextPageParam comes before or after getPreviousPageParam - it only matters that they are after queryFn. So maybe it needs like a dependency tree:
const propertyDependencies = {
queryFn: ['getPreviousPageParam', 'getNextPageParam']
}
this would define that 'getPreviousPageParam' and 'getNextPageParam' depend on queryFn and thus must be after it. What do you think?
There was a problem hiding this comment.
yes ideally a tree like structure would be best. I decided against this in router (similar issue with validateSearch and params.parse) to keep this plugin simple.
TkDodo
approved these changes
Sep 20, 2024
|
Can’t NoInfer<> make type inference work regardless of the order of properties? Or how exactly can the order of properties cause incorrect type inference? |
|
this is explained here |
|
I see, thanks for sharing |
schiller-manuel
deleted the
feat/eslint-infinite-query-property-order
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.