Skip to content

@tanstack/svelte-devtools: published declarations omit .js extension on ./types imports, breaking node16/nodenext #564

Open

Description

@trackoor

TanStack Devtools version

@tanstack/svelte-devtools@0.1.8 (also main at 8f62544)

Framework/Library version

svelte@5.57.3, svelte-check@4.7.8, typescript@6.0.3 and typescript@7.0.2

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 (and TanStackDevtools.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/svelte-devtools@0.1.8 svelte@5.57.3 svelte-check@4.7.8 typescript@6.0.3
<!-- 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/

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions