Skip to content

Commit a11d4ee

Browse files
Document default tsBuildInfoFile defaults (#2733)
Co-authored-by: Caleb ツ Everett <[email protected]> Co-authored-by: Jake Bailey <[email protected]>
1 parent 06b2ee6 commit a11d4ee

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

packages/tsconfig-reference/copy/en/options/tsBuildInfoFile.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,12 @@ oneline: "The file to store `.tsbuildinfo` incremental build information in."
66
This setting lets you specify a file for storing incremental compilation information as a part of composite projects which enables faster
77
building of larger TypeScript codebases. You can read more about composite projects [in the handbook](/docs/handbook/project-references.html).
88

9-
By default it is in the same folder as your emitted JavaScript and has a `.tsbuildinfo` file extension.
10-
The default file name is based on the `outFile` option or your tsconfig file name.
9+
The default depends on a combination of other settings:
10+
11+
- If `outFile` is set, the default is `<outFile>.tsbuildinfo`.
12+
- If `rootDir` and `outDir` are set, then the file is `<outDir>/<relative path to config from rootDir>/<config name>.tsbuildinfo`
13+
For example, if `rootDir` is `src`, `outDir` is `dest`, and the config is
14+
`./tsconfig.json`, then the default is `./tsconfig.tsbuildinfo`
15+
as the relative path from `src/` to `./tsconfig.json` is `../`.
16+
- If `outDir` is set, then the default is `<outDir>/<config name>.tsbuildInfo`
17+
- Otherwise, the default is `<config name>.tsbuildInfo`

0 commit comments

Comments
 (0)