"Referenced projects must have the new composite setting enabled" does not hold true #60465
Comments
haoqunjiang
changed the title
|
When the docs say
what they mean is that if project A references project B, the latter must have ¹) In your case ( |
|
I see. So solution-style references don't require |
|
Yes, at least that's been my understanding. |
|
I found that the TypeScript 5.7 RC release blog has confirmed this behavior:
|
We are only using `references` in a solution-style tsconfig. According to discussions at microsoft/TypeScript#60465, such usage doesn't require `composite: true` to be set in sub-configs. Removing this field loosens the constraints on these configs that all files to be explicitly listed in `files` or `includes`. After this change, type errors in source code would only be reported twice if they're also imported by unit test specs, in constrast to always be reported twice prior to the change. I know this is not ideal yet, but it's still an improvement, and might help catch some edge cases such as vuejs#437 (comment) In the long run, we should still keep an eye on vuejs#549 (pending vuejs/language-tools#4750). Cross-referencing might be a more intuitive configuration, and should be the desirable configuration if we opt into Vitest Browser Mode.
We are only using `references` in a solution-style tsconfig. According to discussions at microsoft/TypeScript#60465, such usage doesn't require `composite: true` to be set in sub-configs. Removing this field loosens the constraints on these configs that all files to be explicitly listed in `files` or `includes`. After this change, type errors in source code would only be reported twice if they're also imported by unit test specs, in contrast to always be reported twice prior to the change. I know this is not ideal yet, but it's still an improvement, and might help catch some edge cases such as vuejs#437 (comment) In the long run, we should still keep an eye on vuejs#549 (pending vuejs/language-tools#4750). Cross-referencing might be a more intuitive configuration, and should be the desirable configuration if we opt into Vitest Browser Mode.
|
This really needs to be clarified in the docs. The fact that you can use project references without composite, and without requiring create-vue already creates projects using this. |
🔎 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.
The text was updated successfully, but these errors were encountered: