Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta
  • Qualcosa non va?
#5,730 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
48/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
typescript
Ambito
tooling

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
TypeScript
Stelle
6.5k
Fork
708
Merge medio
4g 7h
PR unite (30g)
61

Preparare l'ambiente

Non abbiamo ancora controllato i file di configurazione di questo progetto. Parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di microsoft/rushstack

Tutte le issue di microsoft/rushstack

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.