feat(dts-plugin): add dts.generateTypes.deleteTsConfig field (#4225)

Author: 2heal1

.changeset/serious-peaches-attend.md

@@ -0,0 +1,5 @@
+---
+'@module-federation/dts-plugin': patch
+---
+
+feat(dts-plugin): add dts.generateTypes.deleteTsConfig field

apps/website-new/docs/en/configure/dts.mdx

@@ -39,6 +39,7 @@ interface DtsRemoteOptions {
   extractThirdParty?: boolean;
   extractRemoteTypes?: boolean;
   abortOnError?: boolean;
+  deleteTsConfig?: boolean;
 }
 ```
 
@@ -50,7 +51,8 @@ When configuring `generateTypes` to `true`, the following configuration will be
   "abortOnError": false,
   "extractThirdParty": false,
   "extractRemoteTypes": false,
-  "compileInChildProcess": true
+  "compileInChildProcess": true,
+  "deleteTsConfig": true
 }
 ```
 
@@ -125,12 +127,20 @@ Whether to delete the generated type folder
 
 #### compilerInstance
 
-- Type: `'tsc' | 'vue-tsc' | 'tspc' | string`
+- Type: `'tsc' | 'tsgo' | 'vue-tsc' | 'tspc' | string`
 - Required: No
 - Default value: `'tsc'`
 
 Instance of compiled type
 
+#### deleteTsConfig
+
+- Type: `boolean`
+- Required: No
+- Default value: `true`
+
+Whether to delete the temporary tsconfig configuration file.
+
 ### consumeTypes
 
 - Type: `boolean | DtsHostOptions`

apps/website-new/docs/zh/configure/dts.mdx

@@ -38,6 +38,7 @@ interface DtsRemoteOptions {
   extractThirdParty?: boolean;
   extractRemoteTypes?: boolean;
   abortOnError?: boolean;
+  deleteTsConfig?: boolean;
 }
 ```
 
@@ -49,7 +50,8 @@ interface DtsRemoteOptions {
   "abortOnError": false,
   "extractThirdParty": false,
   "extractRemoteTypes": false,
-  "compileInChildProcess": true
+  "compileInChildProcess": true,
+  "deleteTsConfig": true
 }
 ```
 
@@ -125,12 +127,20 @@ tsconfig 配置文件路径
 
 #### compilerInstance
 
-- 类型：`'tsc' | 'vue-tsc' | 'tspc' | string`
+- 类型：`'tsc' | 'tsgo' | 'vue-tsc' | 'tspc' | string`
 - 是否必填：否
 - 默认值：`'tsc'`
 
 编译类型的示例
 
+#### deleteTsConfig
+
+- 类型：`boolean`
+- 是否必填：否
+- 默认值：`true`
+
+是否删除临时 tsconfig 配置文件。
+
 ### consumeTypes
 
 - 类型：`boolean | DtsHostOptions`

packages/dts-plugin/src/core/configurations/remotePlugin.test.ts

@@ -83,6 +83,7 @@ describe('hostPlugin', () => {
           implementation: '',
           generateAPITypes: false,
           context: process.cwd(),
+          deleteTsConfig: true,
           outputDir: '',
           abortOnError: true,
           extractRemoteTypes: false,
@@ -152,6 +153,7 @@ describe('hostPlugin', () => {
           generateAPITypes: false,
           implementation: '',
           context: process.cwd(),
+          deleteTsConfig: true,
           outputDir: '',
           abortOnError: true,
           extractRemoteTypes: false,

packages/dts-plugin/src/core/configurations/remotePlugin.ts

@@ -23,6 +23,7 @@ const defaultOptions = {
   extractRemoteTypes: false,
   extractThirdParty: false,
   outputDir: '',
+  deleteTsConfig: true,
 } satisfies Partial<RemoteOptions>;
 
 function getEffectiveRootDir(

packages/dts-plugin/src/core/lib/typeScriptCompiler.test.ts

@@ -53,6 +53,7 @@ describe('typeScriptCompiler', () => {
     hostRemoteTypesFolder: '@mf-types',
     abortOnError: true,
     outputDir: 'outputDir',
+    deleteTsConfig: true,
   };
 
   it('retrieveMfTypesPath correctly calculate path', () => {
@@ -127,6 +128,9 @@ describe('typeScriptCompiler', () => {
                     children: [
                       {
                         children: [
+                          {
+                            name: 'HostOptions.d.ts',
+                          },
                           {
                             name: 'RemoteOptions.d.ts',
                           },

packages/dts-plugin/src/core/lib/typeScriptCompiler.ts

@@ -23,6 +23,7 @@ import { TEMP_DIR } from '@module-federation/sdk';
 
 import { RemoteOptions } from '../interfaces/RemoteOptions';
 import { TsConfigJson } from '../interfaces/TsConfigJson';
+import { logger } from '../../server';
 
 const STARTS_WITH_SLASH = /^\//;
 
@@ -198,6 +199,7 @@ export const compileTs = async (
       ? (remoteOptions.moduleFederationConfig.dts?.cwd ?? undefined)
       : undefined,
   );
+  logger.debug(`tempTsConfigJsonPath: ${tempTsConfigJsonPath}`);
   try {
     const mfTypePath = retrieveMfTypesPath(tsConfig, remoteOptions);
     const thirdPartyExtractor = new ThirdPartyExtractor({
@@ -269,7 +271,9 @@ export const compileTs = async (
       await thirdPartyExtractor.copyDts();
     }
 
-    await rm(tempTsConfigJsonPath);
+    if (remoteOptions.deleteTsConfig) {
+      await rm(tempTsConfigJsonPath);
+    }
   } catch (err) {
     throw err;
   }

packages/dts-plugin/src/server/Publisher.ts

@@ -6,7 +6,6 @@ import {
   UpdateSubscriberAPIPayload,
 } from './message/API';
 import { getIdentifier, fileLog } from './utils';
-import { FetchTypesPayload } from './message/Action';
 import { RemoteInfo } from '../core/interfaces/HostOptions';
 
 interface PublisherContext {