feat(dts-plugin): support exclude extract specify third party dts (#3692)

Author: 2heal1

.changeset/proud-rings-kiss.md

@@ -0,0 +1,7 @@
+---
+'@module-federation/third-party-dts-extractor': patch
+'@module-federation/dts-plugin': patch
+'@module-federation/sdk': patch
+---
+
+feat(dts-plugin): support exclude extract specify third party dts

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

@@ -61,7 +61,6 @@ const readTsConfig = (
     context,
     additionalFilesToCompile,
     outputDir,
-    moduleFederationConfig,
   }: Required<RemoteOptions>,
   mapComponentsToExpose: Record<string, string>,
 ): TsConfigJson => {
@@ -116,9 +115,18 @@ const readTsConfig = (
     rawTsConfigJson.compilerOptions || {};
   rawTsConfigJson.compilerOptions = restCompilerOptions;
 
+  const outDirWithoutTypesFolder = resolve(
+    context,
+    outputDir || configContent.options.outDir || 'dist',
+  );
+
   const filesToCompile = [
     ...Object.values(mapComponentsToExpose),
-    ...configContent.fileNames.filter((filename) => filename.endsWith('.d.ts')),
+    ...configContent.fileNames.filter(
+      (filename) =>
+        filename.endsWith('.d.ts') &&
+        !filename.startsWith(outDirWithoutTypesFolder),
+    ),
     ...additionalFilesToCompile,
   ];
 

packages/dts-plugin/src/core/lib/DTSManager.general.spec.ts

@@ -8,10 +8,6 @@ import { ThirdPartyExtractor } from '@module-federation/third-party-dts-extracto
 import { HostOptions, RemoteInfo } from '../interfaces/HostOptions';
 import { RemoteOptions } from '../interfaces/RemoteOptions';
 import { downloadTypesArchive } from './archiveHandler';
-import {
-  retrieveHostConfig,
-  retrieveRemoteInfo,
-} from '../configurations/hostPlugin';
 
 vi.mock('axios');
 vi.mock('fs/promises');
@@ -452,6 +448,7 @@ describe('DTSManager General Tests', () => {
         inferPkgDir: vi.fn(),
         collectPkgs: vi.fn(),
         copyDts: vi.fn().mockResolvedValue(undefined),
+        exclude: [],
       }));
 
       // Add the existing alias to the loadedRemoteAPIAlias set

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

@@ -318,9 +318,9 @@ class DTSManager {
     );
     try {
       const existedFile = fs.readFileSync(apiTypeFileName, 'utf-8');
-      const existedImports = new ThirdPartyExtractor('').collectTypeImports(
-        existedFile,
-      );
+      const existedImports = new ThirdPartyExtractor({
+        destDir: '',
+      }).collectTypeImports(existedFile);
       existedImports.forEach((existedImport) => {
         const alias = existedImport
           .split('./')

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

@@ -177,10 +177,14 @@ export const compileTs = async (
   );
   try {
     const mfTypePath = retrieveMfTypesPath(tsConfig, remoteOptions);
-    const thirdPartyExtractor = new ThirdPartyExtractor(
-      resolve(mfTypePath, 'node_modules'),
-      remoteOptions.context,
-    );
+    const thirdPartyExtractor = new ThirdPartyExtractor({
+      destDir: resolve(mfTypePath, 'node_modules'),
+      context: remoteOptions.context,
+      exclude:
+        typeof remoteOptions.extractThirdParty === 'object'
+          ? remoteOptions.extractThirdParty.exclude
+          : undefined,
+    });
     const execPromise = util.promisify(exec);
     const cmd = `npx ${remoteOptions.compilerInstance} --project ${tempTsConfigJsonPath}`;
     try {

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

@@ -133,6 +133,11 @@ export function cloneDeepOptions(options: DTSManagerOptions) {
     if (typeof value === 'function') {
       return false;
     }
+    if (key === 'extractThirdParty' && Array.isArray(value)) {
+      return value.map((item) => {
+        return item.toString();
+      });
+    }
   });
 }
 

packages/sdk/src/types/plugins/ModuleFederationPlugin.ts

@@ -167,7 +167,11 @@ export interface DtsRemoteOptions {
   compileInChildProcess?: boolean;
   compilerInstance?: 'tsc' | 'vue-tsc' | 'tspc' | string;
   generateAPITypes?: boolean;
-  extractThirdParty?: boolean;
+  extractThirdParty?:
+    | boolean
+    | {
+        exclude?: Array<string | RegExp>;
+      };
   extractRemoteTypes?: boolean;
   abortOnError?: boolean;
 }

packages/third-party-dts-extractor/src/ThirdPartyExtractor.spec.ts

@@ -6,7 +6,11 @@ import { ThirdPartyExtractor } from './ThirdPartyExtractor';
 describe('ThirdPartyExtractor', () => {
   const projectRoot = join(__dirname, '..', '..', '..');
   const destDir = join(projectRoot, 'dist', 'third-party-extractor');
-  const thirdPartyExtractor = new ThirdPartyExtractor(destDir, projectRoot);
+  const thirdPartyExtractor = new ThirdPartyExtractor({
+    destDir,
+    context: projectRoot,
+    exclude: ['ignore-pkg', /ignore-pkg2-/, /ignore-pkg3/.toString()],
+  });
 
   it('should correctly infer pkg dir with types field in package.json', () => {
     const tsupDir = thirdPartyExtractor.inferPkgDir('tsup');
@@ -52,4 +56,14 @@ describe('ThirdPartyExtractor', () => {
     expect(fs.existsSync(join(destDir, 'tsup'))).toEqual(true);
     expect(fs.existsSync(join(destDir, '@types/react'))).toEqual(true);
   });
+
+  it('exclude pkg', async () => {
+    const excludePkg = ['ignore-pkg', 'ignore-pkg2-subpath', 'ignore-pkg3'];
+    excludePkg.forEach((pkg) => {
+      thirdPartyExtractor.addPkgs(pkg, `${pkg}-dir`);
+    });
+    expect(
+      Object.keys(thirdPartyExtractor.pkgs).some((p) => excludePkg.includes(p)),
+    ).toEqual(false);
+  });
 });

packages/third-party-dts-extractor/src/ThirdPartyExtractor.ts

@@ -10,23 +10,49 @@ const ignoredPkgs = ['typescript'];
 const isNodeUtils = (pkgJsonPath: string, importPath: string) => {
   return pkgJsonPath === importPath;
 };
+
+type ThirdPartyExtractorOptions = {
+  destDir: string;
+  context?: string;
+  exclude?: Array<string | RegExp>;
+};
+
 class ThirdPartyExtractor {
   pkgs: Record<string, string>;
   pattern: RegExp;
   context: string;
   destDir: string;
+  exclude: Array<string | RegExp>;
 
-  constructor(destDir: string, context = process.cwd()) {
+  constructor({
+    destDir,
+    context = process.cwd(),
+    exclude = [],
+  }: ThirdPartyExtractorOptions) {
     this.destDir = destDir;
     this.context = context;
     this.pkgs = {};
     this.pattern = /(from|import\()\s*['"]([^'"]+)['"]/g;
+    this.exclude = exclude;
   }
 
   addPkgs(pkgName: string, dirName: string): void {
     if (ignoredPkgs.includes(pkgName)) {
       return;
     }
+
+    if (
+      this.exclude.some((pattern) => {
+        if (typeof pattern === 'string') {
+          return new RegExp(pattern).test(pkgName);
+        } else {
+          return pattern.test(pkgName);
+        }
+      })
+    ) {
+      return;
+    }
+
     this.pkgs[pkgName] = dirName;
   }