vercel/ncc

Build fails with `composite: true` in `tsconfig.json`

Open

#1212 opened on Sep 10, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (8,841 stars) (273 forks)batch import
bughelp wanted

Description

I'm not sure if this is as designed or a bug. Any help is appreciated!

I have a npm workspace that uses TypeScript. All the packages have composite: true so they can be consumed by other packages using TypeScript references. When I try to use ncc to build one of the packages. the building fails. It succeeds if I set composite to false.

See the reproduction example in https://github.com/chubei-urus/ncc-demo.

Contributor guide

Tech stack
typescriptnodejs
Domain
toolingbuild system
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of TypeScript configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue is reproducible: set `composite: true` in tsconfig.json and run ncc. The build fails. First, confirm the failure using the provided reproduction repository at https://github.com/chubei urus/ncc demo. Then, investigate ncc's handling of TypeScript composite projects. Look into ncc's TypeScript compilation pipeline (likely in src/ or lib/) to see how it resolves project references. Check if there is a known limitation or if a fix is straightforward.