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

[api-extractor] bundledPackages does not work if the package to be bundled has no version field

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

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
48/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
typescript
Área
tooling

Línea de trabajo

Start at apps/api-extractor/src/analyzer/ExportAnalyzer.ts around lines 298-301 and reproduce the bundledPackages scenario with a local package whose package.json lacks version. Trace how the optional packageId is handled, then add coverage for the missing-version case; done means the behavior is explicit rather than silently leaving the package unbundled.

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

Descripción

Summary

When using the bundledPackages option, if the target package has no version field, it is silently not bundled.

Repro steps

  1. Take any existing api-extractor setup in a monorepo.
  2. Remove the version field in the package.json of a local package (say, it’s called "foo"). Example foo/package.json: { "name": "foo" }.
  3. Add bundledPackages: ["foo"] to the api-extractor configuration.
  4. Run the api-extractor.

Expected result: there are no instances of from "foo" in the output.

Actual result: there are instances of from "foo" in the output.

Details

The root of the issue is we depend on the TypeScript’s packageId field to get the name of a resolved module to match that name against the bundlePackages option configuration. But TypeScript does not generate a packageId field if a package is missing a name or version field (TypeScript issue).

https://github.com/microsoft/rushstack/blob/4e87cfd81cb47b77b8ab214897e80ad0cfb5a50f/apps/api-extractor/src/analyzer/ExportAnalyzer.ts#L298-L301

It’s not obvious how to get the module name without TypeScript’s help, so the root fix is probably upstream. That said, api-extractor does silently produce a highly unexpected result, primarily due to the casual use of the optional chaining operator.

Perhaps a strict crash is something we should have instead:

if (!resolvedModule.packageId) throw new InternalError("Compiler did not generate the packageId");

Given that we know the scenario, we could even suggest a remedy:

if (!resolvedModule.packageId) throw Error('Compiler did not generate the packageId. This is most likely a package you have has no version field. Try to add `version: ""` field for all your packages. https://github.com/microsoft/TypeScript/issues/63307');

Standard questions

Question Answer
@microsoft/api-extractor version? 7.57.7
Operating system? Mac
API Extractor scenario? rollups (.d.ts)
Would you consider contributing a PR? Yes
TypeScript compiler version? 5.9.3
Node.js version (node -v)? 22.22.0
Lenguaje dominante
TypeScript
Estrellas
6.5k
Forks
708
Merge medio
2 d 1 h
PR fusionados (30 d)
46

Preparar el entorno

Aún no hemos revisado los archivos de configuración de este proyecto. Empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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 microsoft/rushstack

Todos los issues de microsoft/rushstack

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.