microsoft / microsoft/TypeScript
Module/interface augmentation doesn't preserve import for declaration emit
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.4k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
🔎 Search Terms
- project references
- module/interface augmentation
🕗 Version & Regression Information
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about project references.
⏯ Playground Link
No response
💻 Code
Full reduced test case (contents inlined below): https://github.com/OliverJAsh/ts-project-references-augmentation-bug
package.json:
{
"dependencies": {
"fp-ts": "^2.16.1",
"typescript": "^5.2.2"
}
}
app/tsconfig.json:
{
"compilerOptions": {
"rootDir": "../",
"outDir": "../target",
"composite": true
}
}
app/index.ts:
import * as ReadonlyTuple from 'fp-ts/ReadonlyTuple';
export const Apply = ReadonlyTuple.getApply({ concat: a => a });
demos/tsconfig.json:
{
"compilerOptions": {
"rootDir": "../",
"outDir": "../target"
},
"references": [
{ "path": "../app/tsconfig.json" },
]
}
demos/index.ts:
import { Apply } from "../app/index";
Apply;
🙁 Actual behavior
A module in the "app" project imports the file node_modules/fp-ts/lib/ReadonlyTuple.d.ts. This file uses module and interface augmentation. Excerpt:
export declare const URI = 'ReadonlyTuple'
/**
* @category type lambdas
* @since 2.5.0
*/
export type URI = typeof URI
declare module './HKT' {
interface URItoKind2<E, A> {
readonly [URI]: readonly [A, E]
}
}
When I later try to reference the "app" project from another project ("demos") using project references, I get a type error because the module/interface augmentation is not being applied:
$ yarn run tsc --build --verbose demos/tsconfig.json
yarn run v1.22.19
warning package.json: No license field
$ /Users/oliver/Code/reduced-test-cases/ts-project-references-augmentation-bug/node_modules/.bin/tsc --build --verbose demos/tsconfig.json
[13:49:06] Projects in this build:
* app/tsconfig.json
* demos/tsconfig.json
[13:49:06] Project 'app/tsconfig.json' is out of date because output file 'target/app/tsconfig.tsbuildinfo' does not exist
[13:49:06] Building project '/Users/oliver/Code/reduced-test-cases/ts-project-references-augmentation-bug/app/tsconfig.json'...
[13:49:06] Project 'demos/tsconfig.json' is out of date because output file 'target/demos/index.js' does not exist
[13:49:06] Building project '/Users/oliver/Code/reduced-test-cases/ts-project-references-augmentation-bug/demos/tsconfig.json'...
target/app/index.d.ts:1:63 - error TS2344: Type '"ReadonlyTuple"' does not satisfy the constraint 'keyof URItoKind2<any, any>'.
1 export declare const Apply: import("fp-ts/lib/Apply").Apply2C<"ReadonlyTuple", unknown>;
~~~~~~~~~~~~~~~
Found 1 error.
🙂 Expected behavior
No error. The module/interface augmentation should be applied in the dependant project when it consumes the type declarations of the referenced project.
Additional information about the issue
I am able to workaround the issue by adding an explicit import of fp-ts/ReadonlyTuple in demos/index.ts.
Contributor guide
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.
Assessment
This issue has not been assessed yet.