From 16c3736aaa49570c08072a24213a46ce9c3c0a62 Mon Sep 17 00:00:00 2001 From: Haoqun Jiang Date: Sat, 9 Nov 2024 15:56:58 +0800 Subject: [PATCH] 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 --- README.md | 2 +- tsconfig.json | 10 ---------- 2 files changed, 1 insertion(+), 11 deletions(-) diff --git a/README.md b/README.md index b6f6515..2b2199a 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/tsconfig.json b/tsconfig.json index 2c937f4..b7f7ebc 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -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