Repository navigation
Undocumented breaking change in 5.5.0-beta for reference directives #58324
Description
🔎 Search Terms
5.5.0-beta
🕗 Version & Regression Information
- This changed between versions 5.4 and 5.5
⏯ Playground Link
https://github.com/Jack-Works/reproduce
💻 Code
Clone the repo
git clone https://github.com/Jack-Works/reproduce/ --filter=blob:none
cd reproduce/typescript-5.5-dts
pnpm install
pnpm run old
pnpm run new🙁 Actual behavior
Global augmentation no longer works in 5.5.0-beta across different projects. (pnpm run new)
🙂 Expected behavior
Global augmentation works in 5.4 across different projects. (pnpm run old)
Additional information about the issue
Global augmentation across different projects is an important ability. Here are some examples:
- You have a components project that augments the global JSX type, and you access those elements from another project
- Theming a UI library
Activity
robpalme commentedon Apr 26, 2024
Hello Jack Works (@Jack-Works), thanks for highlighting this. Your repro is using reference directives in the project's public-facing entrypoint module.
/// <reference path="./env.d.ts" />It's true there is an intentional breaking change introduced by Jake Bailey (@jakebailey) in the PR for Do not preserve references in declaration emit, unless preserve=true. And this is not yet documented in the TS 5.5 Beta announcement. so that post should be updated.
The intended workaround for cases where you want the reference directive included in the published declaration file is to add
preserve=true./// <reference path="./env.d.ts" preserve=true/>I'd suggest re-titling this issue:
[-]Undocumented breaking change in 5.5.0-beta about module/global augmentation via .d.ts file across projects[/-][+]Undocumented breaking change in 5.5.0-beta for reference directives[/+]jakebailey commentedon Apr 26, 2024
Sorry about that; it definitely was meant to be there in the blog! We'll get it updated.
jakebailey commentedon Apr 27, 2024
Blog post has been updated: https://devblogs.microsoft.com/typescript/announcing-typescript-5-5-beta/#simplified-reference-directive-declaration-emit