Skip to content

Document default tsBuildInfoFile defaults #2733

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 24, 2023
Merged

Document default tsBuildInfoFile defaults #2733

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f6f13ce
Document default tsBuildInfoFile defaults
everett1992 Mar 1, 2023
35b79a9
Clean up wording
jakebailey Jul 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions packages/tsconfig-reference/copy/en/options/tsBuildInfoFile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,12 @@ oneline: "The file to store `.tsbuildinfo` incremental build information in."
This setting lets you specify a file for storing incremental compilation information as a part of composite projects which enables faster
building of larger TypeScript codebases. You can read more about composite projects [in the handbook](/docs/handbook/project-references.html).

By default it is in the same folder as your emitted JavaScript and has a `.tsbuildinfo` file extension.
The default file name is based on the `outFile` option or your tsconfig file name.
The default depends on a combination of other settings:

- If `outFile` is set, the default is `<outFile>.tsbuildinfo`.
- If `rootDir` and `outDir` are set, then the file is `<outDir>/<relative path to config from rootDir>/<config name>.tsbuildinfo`
For example, if `rootDir` is `src`, `outDir` is `dest`, and the config is
`./tsconfig.json`, then the default is `./tsconfig.tsbuildinfo`
as the relative path from `src/` to `./tsconfig.json` is `../`.
- If `outDir` is set, then the default is `<outDir>/<config name>.tsbuildInfo`
- Otherwise, the default is `<config name>.tsbuildInfo`