feat(dts-plugin): allow users to specify a cwd to generate the types (#3339)

nachoaldamav · web-flow · commit 8e172c84773d · 2024-12-12T15:01:06.000+08:00
diff --git a/.changeset/real-otters-explode.md b/.changeset/real-otters-explode.md
@@ -0,0 +1,6 @@
+---
+'@module-federation/dts-plugin': patch
+'@module-federation/sdk': patch
+---
+
+add `cwd` property to generate types
diff --git a/apps/website-new/docs/en/configure/dts.mdx b/apps/website-new/docs/en/configure/dts.mdx
@@ -14,6 +14,7 @@ interface PluginDtsOptions {
   generateTypes?: boolean | DtsRemoteOptions;
   consumeTypes?: boolean | DtsHostOptions;
   tsConfigPath?: string;
+  cwd?: string;
 }
 ```
 
@@ -215,3 +216,11 @@ Before loading type files, whether to delete the previously loaded `typesFolder`
 - Default value: `path.join(process.cwd(),'./tsconfig.json')`
 
 tsconfig configuration file path
+
+### cwd
+
+- Type: `string`
+- Required: No
+- Default value: `undefined`
+
+The working directory to run the compiler
diff --git a/packages/dts-plugin/src/core/lib/typeScriptCompiler.ts b/packages/dts-plugin/src/core/lib/typeScriptCompiler.ts
@@ -180,7 +180,12 @@ export const compileTs = async (
     const execPromise = util.promisify(exec);
     const cmd = `npx ${remoteOptions.compilerInstance} --project ${tempTsConfigJsonPath}`;
     try {
-      await execPromise(cmd);
+      await execPromise(cmd, {
+        cwd:
+          typeof remoteOptions.moduleFederationConfig.dts !== 'boolean'
+            ? (remoteOptions.moduleFederationConfig.dts?.cwd ?? undefined)
+            : undefined,
+      });
     } catch (err) {
       throw new Error(
         getShortErrorMsg(TYPE_001, typeDescMap, {
diff --git a/packages/sdk/src/types/plugins/ModuleFederationPlugin.ts b/packages/sdk/src/types/plugins/ModuleFederationPlugin.ts
@@ -166,6 +166,7 @@ export interface PluginDtsOptions {
   tsConfigPath?: string;
   extraOptions?: Record<string, any>;
   implementation?: string;
+  cwd?: string;
 }
 
 export type AsyncBoundaryOptions = {

Original file line number	Diff line number	Diff line change
`@@ -166,6 +166,7 @@ export interface PluginDtsOptions {`
`166`	`166`	`tsConfigPath?: string;`
`167`	`167`	`extraOptions?: Record<string, any>;`
`168`	`168`	`implementation?: string;`
	`169`	`+ cwd?: string;`
`169`	`170`	`}`
`170`	`171`
`171`	`172`	`export type AsyncBoundaryOptions = {`