@tanstack/svelte-devtools: published declarations omit .js extension on ./types imports, breaking node16/nodenext
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 85/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- typescript
- Domain
- developer-experience, tooling
Research direction
Read the three source entry points named in the issue: packages/svelte-devtools/src/index.ts, TanStackDevtools.svelte, and devtools.ts. Update their relative imports of ./types as described, then build the package and check the declarations under NodeNext or Node16 resolution with skipLibCheck disabled; done when the declarations resolve and the reported TS2835 errors are gone.
Written by the indexing model from the issue text.
Description
TanStack Devtools version
@tanstack/[email protected] (also main at 8f62544)
Framework/Library version
[email protected], [email protected], [email protected] and [email protected]
Describe the bug and the steps to reproduce it
@tanstack/svelte-devtools sets "type": "module" and builds with svelte-package, which preserves relative import specifiers verbatim in dist/esm/. Three files import ./types without a .js extension:
dist/esm/index.d.ts:export type { TanStackDevtoolsSveltePlugin, TanStackDevtoolsSvelteInit, } from './types';dist/esm/TanStackDevtools.svelte.d.ts(andTanStackDevtools.svelte):import type { TanStackDevtoolsSvelteInit } from './types';dist/esm/devtools.d.ts:import type { TanStackDevtoolsSvelteInit } from './types';
Under moduleResolution: "NodeNext" or "Node16" (which SvelteKit's packaging docs recommend for Svelte libraries), TypeScript requires explicit .js extensions on relative imports in ESM declarations. With skipLibCheck: true, ./types fails to resolve and both <TanStackDevtools /> props and the exported TanStackDevtoolsSveltePlugin / TanStackDevtoolsSvelteInit types silently degrade to any. With skipLibCheck: false, svelte-check and tsc fail with TS2835.
Steps to reproduce:
npm init -y
npm i @tanstack/[email protected] [email protected] [email protected] [email protected]
<!-- src/App.svelte -->
<script lang="ts">
import {
TanStackDevtools,
type TanStackDevtoolsSveltePlugin,
} from "@tanstack/svelte-devtools";
const badPlugin: TanStackDevtoolsSveltePlugin = 123;
</script>
<TanStackDevtools config={{ openHotkey: 123 }} plugins={[badPlugin]} />
{
"compilerOptions": {
"module": "NodeNext",
"moduleResolution": "NodeNext",
"target": "ES2022",
"strict": true,
"skipLibCheck": true,
"types": ["svelte"]
},
"include": ["src/**/*"]
}
Running npx svelte-check --tsconfig ./tsconfig.json reports:
svelte-check found 0 errors and 0 warnings
With "skipLibCheck": false, npx svelte-check --tsconfig ./tsconfig.json fails inside @tanstack/svelte-devtools (and tsc --noEmit --module nodenext --moduleResolution nodenext --skipLibCheck false reports the same TS2835 on index.d.ts under TypeScript 6.0.3 and 7.0.2):
node_modules/@tanstack/svelte-devtools/dist/esm/TanStackDevtools.svelte.d.ts:1:49
Error: Relative import paths need explicit file extensions in ECMAScript imports when '--moduleResolution' is 'node16' or 'nodenext'. Did you mean './types.js'?
import type { TanStackDevtoolsSvelteInit } from './types';
declare const TanStackDevtools: import("svelte").Component<TanStackDevtoolsSvelteInit, {}, "">;
node_modules/@tanstack/svelte-devtools/dist/esm/index.d.ts:2:80
Error: Relative import paths need explicit file extensions in ECMAScript imports when '--moduleResolution' is 'node16' or 'nodenext'. Did you mean './types.js'?
export { default as TanStackDevtools } from './TanStackDevtools.svelte';
export type { TanStackDevtoolsSveltePlugin, TanStackDevtoolsSvelteInit, } from './types';
Expected output (matching "module": "ESNext", "moduleResolution": "Bundler"):
src/App.svelte:7:9
Error: Type 'number' is not assignable to type 'TanStackDevtoolsSveltePlugin'. (ts)
src/App.svelte:10:29
Error: Type 'number' is not assignable to type 'KeyboardKey[]'. (ts)
svelte-check found 2 errors and 0 warnings in 1 file
Changing from './types' to from './types.js' in packages/svelte-devtools/src/index.ts, packages/svelte-devtools/src/TanStackDevtools.svelte (which already uses from './devtools.js' on the line above), and packages/svelte-devtools/src/devtools.ts resolves this.
Your Minimal, Reproducible Example - (Sandbox Highly Recommended)
https://gist.github.com/trackoor/e88698351ce89d44b8cf5c516d8e7871
Screenshots or Videos (Optional)
No response
Do you intend to try to help solve this bug with your own PR?
No, because I do not have time to dig into it
Terms & Code of Conduct
- I agree to follow this project's Code of Conduct
- I understand that if my bug cannot be reliable reproduced in a debuggable environment, it will probably not be fixed and this issue may even be closed.
Credit: https://ucsbplse.github.io/
- Dominant language
- TypeScript
- Stars
- 514
- Forks
- 105
- Avg merge
- 11h 38m
- Merged PRs (30d)
- 2
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from TanStack/devtools
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
devtools-vite: four transform hooks have no filter, and inject-plugin parses pre-bundled dependency chunksPossibly taken @shkumbinhasani claimed this 29 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 38/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 52/100
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
All issues in TanStack/devtools
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
oxc-project/tsrs#1010 ·
Maintainers usually reply within 1 day
-
area:infra area:storage bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
THU-MAIC/OpenMAIC#2311 · 1 comment ·
Maintainers usually reply within 1 day
-
docs documentation need-triage SaaS
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
enhancement from-app needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
nightly-labs/openbot#10973 ·
Maintainers usually reply within 1 day
-
status/need-triage
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
google-gemini/gemini-cli#30328 · 1 comment ·
Maintainers usually reply within 1 day