Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

vite-config: dts extension rewrite mangles directory-barrel imports ('../utils' → '../utils.js' instead of '../utils/index.js')

Abierto
  • ¿Algo no está bien?
#401 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
72/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
typescript, vite
Área
build-system

Línea de trabajo

Comienza en packages/vite-config/src/index.ts, en ensureImportFileExtension y su manejo de beforeWriteFile. Reproduce el problema con un barrel de directorio e inspecciona los archivos .d.ts generados para ambas ramas ESM y CJS. Se considera terminado cuando las importaciones de directorios se conviertan en ../utils/index.js o ../utils/index.cjs, mientras que las importaciones de archivos normales permanezcan sin cambios, y se resuelva el fallo de resolución de tipos informado.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Describe the bug

tanstackViteConfig's declaration post-processing (ensureImportFileExtension in packages/vite-config/src/index.ts) appends .js / .cjs to every extensionless relative specifier in emitted .d.ts files, without checking whether the specifier targets a directory barrel.

Given a source file that imports from a directory with an index.ts:

// src/adapters/image.ts
import type { GeminiClientConfig } from '../utils' // src/utils/index.ts

the emitted declaration becomes:

// dist/esm/adapters/image.d.ts
import { GeminiClientConfig } from '../utils.js';

but the build only emits dist/esm/utils/index.d.ts — there is no dist/esm/utils.d.ts — so the specifier should have been '../utils/index.js'. Any consumer compiling with skipLibCheck: false fails with:

error TS2307: Cannot find module '../utils.js' or its corresponding type declarations.

The emitted JS is unaffected (rollup/rolldown resolves the barrel itself, pointing at the concrete module, e.g. '../utils/client.js'), so this is invisible at runtime and only breaks the type layer.

Both the ESM (.js) and CJS (.cjs) branches of ensureImportFileExtension have the same problem. Verified present in 0.4.1 and still present in the 0.5.2 source.

Why it goes unnoticed
  • The rewrite happens in beforeWriteFile, after type-checking — afterDiagnostic validates the source compile, and the rewritten output text is never re-checked.
  • Consumers overwhelmingly use skipLibCheck: true, which suppresses TS2307 inside .d.ts files; the affected types silently degrade instead of erroring.
  • publint doesn't catch it (it checks the export map, not deep declaration resolution). @arethetypeswrong/cli does flag it, as InternalResolutionError.
Real-world occurrence

Published packages built with this config ship the broken specifiers today, e.g. @tanstack/[email protected]:

  • dist/esm/adapters/image.d.ts → import { GeminiClientConfig } from '../utils.js' (only dist/esm/utils/index.d.ts exists)

and @tanstack/ai (dist/esm/activities/generate*/index.d.ts → '../middleware.js', where middleware is a directory barrel).

Steps to reproduce
  1. Scaffold a lib using tanstackViteConfig with srcDir: './src', entry ./src/index.ts.
  2. Add src/utils/index.ts exporting anything, and import it from a sibling as from '../utils'.
  3. vite build, then inspect the emitted .d.ts — the specifier is '../utils.js'.
  4. Compile a file importing the package with skipLibCheck: false → TS2307.
Suggested fix

Make the rewrite resolution-aware instead of purely textual. beforeWriteFile receives the output filePath, and the dist tree mirrors entryRoot/srcDir, so for each relative specifier the plugin can check whether the target resolves to a directory (or equivalently, whether <target>/index.d.ts rather than <target>.d.ts is being emitted) and append /index.js in that case:

'../utils'  → '../utils/index.js'  // when utils/ is a directory barrel
'../client' → '../client.js'      // unchanged for plain files

Happy to send a PR if the approach sounds right.

Lenguaje dominante
TypeScript
Estrellas
397
Forks
41
Merge medio
1 h 9 min
PR fusionados (30 d)
3

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de TanStack/config

Todos los issues de TanStack/config

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.