Skip to content

Commit 16c3736

Browse files
committed
chore: remove the FIXME comment on outDir field
Starting in TypeScript 5.6, `.tsbuildinfo` file is always written in a `--build` invocation[^1]. So the entire community need to embrace the new behavior and explicitly set `tsbuildInfoFile` if they want to avoid polluting the project root. So I think it's no longer our responsibility to find a workaround for the users. Closes #27 [^1]: https://devblogs.microsoft.com/typescript/announcing-typescript-5-6-beta/#tsbuildinfo-is-always-written
1 parent 354b7df commit 16c3736

File tree

2 files changed

+1
-11
lines changed

2 files changed

+1
-11
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ TSConfigs for Vue projects to extend.
44

55
Requires TypeScript >= 5.0. For TypeScript v4.5 to v4.9, please use [v0.1.x](https://www.npmjs.com/package/@vue/tsconfig/v/0.1.3).
66

7-
[See below for the changes in v0.3.x.](#migrating-from-typescript--50)
7+
[See below for the breaking changes in v0.3.x.](#migrating-from-typescript--50)
88

99
## Installation
1010

tsconfig.json

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,6 @@
33
// Most non-library projects don't need to emit declarations.
44
// So we add this option by default to make the config more friendly to most users.
55
"noEmit": true,
6-
// When type-checking with solution-style tsconfigs, though with `noEmit: true`, there won't
7-
// be any `.d.ts` files emitted, but tsc still writes a `.tsbuildinfo` file to the `outDir`
8-
// for each project. If we don't explicitly set the `outDir`, it will be in the same folder
9-
// as the `tsconfig.json` file, which would look messy.
10-
// Setting it to `./dist/` isn't ideal either, because it would pollute the `dist` folder.
11-
// So we set it to a hidden folder in `node_modules` to avoid polluting the project root.
12-
// FIXME:
13-
// This caused a regression: https://github.com/vuejs/tsconfig/issues/27
14-
// Need to find a better solution.
15-
// "outDir": "./node_modules/.cache/vue-tsbuildinfo",
166

177
// As long as you are using a build tool, we recommend you to author and ship in ES modules.
188
// Even if you are targeting Node.js, because

0 commit comments

Comments
 (0)