fix(eslint-plugin-query): export Plugin interface #8392

vojty · 2024-12-03T16:12:33Z

Problem

I'm generating TS declaration files from a reusable ESlint config (plain JavaScript) like this:

import queryPlugin from '@tanstack/eslint-plugin-query';

export default [
  {
    plugins: {
      '@tanstack/query': queryPlugin,
    },
    settings: { ... },
    rules: {
      // @tanstack/query:recommended rules
      ...queryPlugin.configs.recommended.rules,
      ...
    },
  },
];

I've upgraded TypeScript to 5.7.2 and I'm getting the following error:

error TS9006: Declaration emit for this file requires using private name 'Plugin' from module '"<...>/node_modules/@tanstack/eslint-plugin-query/dist/esm/index"'. An explicit type annotation may unblock declaration emit.

2 import queryPlugin from '@tanstack/eslint-plugin-query';
  ~~~~~~

Solution

Exporting Plugin interface fixes this issue.

vojty · 2024-12-18T08:25:44Z

@TkDodo I'm sure you are busy but could you take a look at this small change, please? Thanks

nx-cloud · 2025-01-04T11:19:08Z

View your CI Pipeline Execution ↗ for commit 1f9a5ca.

Command	Status	Duration	Result
`nx affected --targets=test:sherif,test:knip,tes...`	✅ Succeeded	1m 30s	View ↗
`nx run-many --target=build --exclude=examples/*...`	✅ Succeeded	22s	View ↗

☁️ Nx Cloud last updated this comment at 2025-01-04 11:21:20 UTC

pkg-pr-new · 2025-01-04T11:20:26Z

Open in Stackblitz

More templates

@tanstack/angular-query-devtools-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-devtools-experimental@8392

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@8392

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@8392

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@8392

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@8392

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@8392

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@8392

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@8392

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@8392

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@8392

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@8392

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@8392

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@8392

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@8392

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@8392

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@8392

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@8392

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@8392

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@8392

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@8392

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@8392

commit: 1f9a5ca

codecov · 2025-01-04T11:21:32Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.22%. Comparing base (0503282) to head (1f9a5ca).
Report is 2 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #8392       +/-   ##
===========================================
+ Coverage   46.26%   88.22%   +41.95%     
===========================================
  Files         199       15      -184     
  Lines        7532      501     -7031     
  Branches     1720      186     -1534     
===========================================
- Hits         3485      442     -3043     
+ Misses       3668       45     -3623     
+ Partials      379       14      -365

Components	Coverage Δ
@tanstack/angular-query-devtools-experimental	`∅ <ø> (∅)`
@tanstack/angular-query-experimental	`∅ <ø> (∅)`
@tanstack/eslint-plugin-query	`88.22% <ø> (ø)`
@tanstack/query-async-storage-persister	`∅ <ø> (∅)`
@tanstack/query-broadcast-client-experimental	`∅ <ø> (∅)`
@tanstack/query-codemods	`∅ <ø> (∅)`
@tanstack/query-core	`∅ <ø> (∅)`
@tanstack/query-devtools	`∅ <ø> (∅)`
@tanstack/query-persist-client-core	`∅ <ø> (∅)`
@tanstack/query-sync-storage-persister	`∅ <ø> (∅)`
@tanstack/react-query	`∅ <ø> (∅)`
@tanstack/react-query-devtools	`∅ <ø> (∅)`
@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	`∅ <ø> (∅)`

fix(eslint-plugin-query): export Plugin interface

b271b8d

github-actions bot added the package: eslint-plugin-query label Dec 3, 2024

Merge branch 'main' into export-plugin-type

1f9a5ca

TkDodo approved these changes Jan 4, 2025

View reviewed changes

TkDodo merged commit 9a0ca9b into TanStack:main Jan 4, 2025
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(eslint-plugin-query): export Plugin interface #8392

fix(eslint-plugin-query): export Plugin interface #8392

vojty commented Dec 3, 2024

vojty commented Dec 18, 2024

nx-cloud bot commented Jan 4, 2025 •

edited

Loading

pkg-pr-new bot commented Jan 4, 2025

codecov bot commented Jan 4, 2025 •

edited

Loading

fix(eslint-plugin-query): export Plugin interface #8392

fix(eslint-plugin-query): export Plugin interface #8392

Conversation

vojty commented Dec 3, 2024

Problem

Solution

vojty commented Dec 18, 2024

nx-cloud bot commented Jan 4, 2025 • edited Loading

pkg-pr-new bot commented Jan 4, 2025

codecov bot commented Jan 4, 2025 • edited Loading

Codecov Report

nx-cloud bot commented Jan 4, 2025 •

edited

Loading

codecov bot commented Jan 4, 2025 •

edited

Loading