codethief
commented
4 days ago When the docs say
Referenced projects must have the new composite setting enabled.
what they mean is that if project A references project B, the latter must have composite: true. In your example, however, your two projects (tsconfig.app.json and tsconfig.node.json) don't reference each other.¹ They are merely referenced by the main ("solution-style") tsconfig.json, in which case you don't need the composite: true. I agree that the docs could be a bit more explicit about this.
¹) In your case (tsconfig.app.json and tsconfig.node.json) this is likely not needed since Node/config code will likely never import application code or vice versa. However, references will be needed as soon as one project needs to import code from another project (that is type-checked with a different tsconfig). For an example please see the tsconfigs in https://github.com/microsoft/TypeScript/tree/main/src and its subfolders.
haoqunjiang
🔎 Search Terms
composite, project references, solution-style tsconfig
🕗 Version & Regression Information
⏯ Playground Link
https://vite.new/react-ts
💻 Code
The above link is a project created from the vite react-ts template (https://vite.new/react-ts). It uses project references in
tsconfig.json, but nocomposite: truespecified in bothtsconfig.app.jsonandtsconfig.node.json.On the other hand, the TypeScript handbook says:
🙁 Actual behavior
The project builds (
npm run build) successfully withoutcomposite: true.🙂 Expected behavior
If I understand correctly, the documentation means I have to specify
composite: truewhen usingreferences. I'd expect an error or warning if I didn't follow the guide.Additional information about the issue
I'm curious whether it's a bug or a feature. If it's a bug, what's the expected behavior? If it's a feature, I'd like to see the documentation updated accordingly.