[api-extractor] bundledPackages does not work if the package to be bundled has no version field
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 48/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- typescript
- Domain
- tooling
Research direction
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.
Written by the indexing model from the issue text.
Description
Summary
When using the bundledPackages option, if the target package has no version field, it is silently not bundled.
Repro steps
- Take any existing api-extractor setup in a monorepo.
- Remove the version field in the package.json of a local package (say, it’s called "foo"). Example foo/package.json:
{ "name": "foo" }. - Add
bundledPackages: ["foo"]to the api-extractor configuration. - 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).
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 |
- Dominant language
- TypeScript
- Stars
- 6.5k
- Forks
- 708
- Avg merge
- 5d 19h
- Merged PRs (30d)
- 48
Contributor guide
No contributing guide indexed for this repository
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 microsoft/rushstack
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
All issues in microsoft/rushstack
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
safetrustcr/dApp-SafeTrust#426 ·
-
area:workflow bug ready-for-agent
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
fil-donadoni/tolaria#4409 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Fission-AI/OpenSpec#1960 ·
-
Add dependabot Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
corsairdev/corsair#1764 ·