Skip to content

Description of tsBuildInfoFile is misleading in generated tsconfig.json #48053

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

Closed
uhyo opened this issue Feb 27, 2022 · 2 comments Β· Fixed by #48072
Closed

Description of tsBuildInfoFile is misleading in generated tsconfig.json #48053

uhyo opened this issue Feb 27, 2022 · 2 comments Β· Fixed by #48072
Labels
Bug A bug in TypeScript Good First Issue Well scoped, documented and has the green light Help Wanted You can do this
Milestone

Comments

@uhyo
Copy link
Contributor

uhyo commented Feb 27, 2022

Bug Report

πŸ”Ž Search Terms

tsconfig tsBuildInfoFile Specify the folder

πŸ•— Version & Regression Information

4.5.5, 4.7.0-dev.20220227

⏯ Playground Link

N/A

πŸ’» Code

After running tsc --init the generated tsconfig.json includes the following line:

  // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */

πŸ™ Actual behavior

The description says "Specify the folder" and the sample value also indicates that you specify a folder for this option.

However, specifying a folder would result in a following error when running tsc:

error TS5033: Could not write file '/path/to/folder': EISDIR: illegal operation on a directory, open '/path/to/folder'.

πŸ™‚ Expected behavior

Actually you need to specify the file .

The official tsConfig doc also says β€œThis setting lets you specify a file”.

A fix would be, for example:

  // "tsBuildInfoFile": "./.tsbuildinfo",                          /* Specify the path to .tsbuildinfo incremental compilation file. */
@DanielRosenwasser DanielRosenwasser added Bug A bug in TypeScript Good First Issue Well scoped, documented and has the green light Help Wanted You can do this labels Feb 28, 2022
@DanielRosenwasser DanielRosenwasser added this to the Backlog milestone Feb 28, 2022
@juank1809
Copy link

Can I be assigned to this issue? I'd be glad to help

@Blopaa
Copy link
Contributor

Blopaa commented Mar 1, 2022

sorry, I didn't get to write anything but I started to help on this one, I think I have the solution, sorry for the inconvenience.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug A bug in TypeScript Good First Issue Well scoped, documented and has the green light Help Wanted You can do this
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants