Skip to content
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.

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

Incomplete description of tsBuildInfoFile config default behavior #2393

Closed
henry-filosa opened this issue May 24, 2022 · 1 comment
Closed

Comments

@henry-filosa
Copy link

It seems to me that the default description of https://www.typescriptlang.org/tsconfig#tsBuildInfoFile is incomplete. It simply says that the default outfile is .tsbuildinfo, but this PR lays out much more complex behavior:

  • When tsconfig specifies compiler options incremental file with .tsbuildinfo extension is emitted.
  • Composite projects indirectly specify incremental as true and its error to specify incremental as false in the composite project
  • If project specifies tsBuildInfoFile options, it uses the path specified by that to write the build information.
  • If project specifies out or outFile option, the outFileWithoutExtension.tsbuildinfo file is written next to output js file.
  • If project specified outDir, config files base file name with extension as .tsbuildinfo is written in outDir
  • Otherswise config files base file name with extension as .tsbuildinfo is written next to the config file

Highlights added by me. This means that my incremental build file is tsconfig.tsbuildinfo as we follow the common convention of tsconfig.json. While this behavior is not a huge deal, I think it's preferable to have it documented. As it stands I had to delve into a years old PR to figure out why the documented behavior didn't match my observed behavior.

@typescript-bot
Copy link
Collaborator

Hello! As per #2804, we are automatically closing all open issues. Please see #2804 for a description of what issues and PRs can be accepted going forward.

@typescript-bot typescript-bot closed this as not planned Won't fix, can't repro, duplicate, stale Apr 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants