Skip to content

Commit

Permalink
chore: remove the FIXME comment on outDir field
Browse files Browse the repository at this point in the history
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
  • Loading branch information
haoqunjiang committed Nov 9, 2024
1 parent 354b7df commit 16c3736
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 11 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ TSConfigs for Vue projects to extend.

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).

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

## Installation

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

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

0 comments on commit 16c3736

Please sign in to comment.