fix: use writeFile of ts api to rename declaration files (#933)

Author: Timeless0911

packages/plugin-dts/src/tsc.ts

@@ -165,13 +165,44 @@ export async function emitDts(
     }
   };
 
-  const system = { ...ts.sys };
+  const renameDtsFile = (fileName: string): string => {
+    if (bundle) {
+      return fileName;
+    }
+    return fileName.replace(/\.d\.ts$/, dtsExtension);
+  };
+
+  const system: ts.System = {
+    ...ts.sys,
+    writeFile: (fileName, contents, writeByteOrderMark) => {
+      ts.sys.writeFile(renameDtsFile(fileName), contents, writeByteOrderMark);
+    },
+  };
 
   // build mode
   if (!isWatch) {
     // normal build - npx tsc
     if (!build && !compilerOptions.composite) {
-      const host: ts.CompilerHost = ts.createCompilerHost(compilerOptions);
+      const originHost: ts.CompilerHost =
+        ts.createCompilerHost(compilerOptions);
+      const host: ts.CompilerHost = {
+        ...originHost,
+        writeFile: (
+          fileName,
+          contents,
+          writeByteOrderMark,
+          onError,
+          sourceFiles,
+        ) => {
+          originHost.writeFile(
+            renameDtsFile(fileName),
+            contents,
+            writeByteOrderMark,
+            onError,
+            sourceFiles,
+          );
+        },
+      };
 
       const program: ts.Program = ts.createProgram({
         rootNames: fileNames,
@@ -202,8 +233,26 @@ export async function emitDts(
       );
     } else if (!build && compilerOptions.composite) {
       // incremental build with composite true - npx tsc
-      const host: ts.CompilerHost =
+      const originHost: ts.CompilerHost =
         ts.createIncrementalCompilerHost(compilerOptions);
+      const host: ts.CompilerHost = {
+        ...originHost,
+        writeFile: (
+          fileName,
+          contents,
+          writeByteOrderMark,
+          onError,
+          sourceFiles,
+        ) => {
+          originHost.writeFile(
+            renameDtsFile(fileName),
+            contents,
+            writeByteOrderMark,
+            onError,
+            sourceFiles,
+          );
+        },
+      };
 
       const program = ts.createIncrementalProgram({
         rootNames: fileNames,

packages/plugin-dts/src/utils.ts

@@ -378,9 +378,7 @@ export async function processDtsFiles(
     );
   }
 
-  const dtsFiles = await glob(convertPath(join(dir, '/**/*.d.ts')), {
-    absolute: true,
-  });
+  const dtsFiles = await globDtsFiles(dir);
 
   await Promise.all(
     dtsFiles.map(async (file) => {
@@ -399,9 +397,6 @@ export async function processDtsFiles(
             rootDir,
           );
         }
-
-        const newFile = file.replace('.d.ts', dtsExtension);
-        await fsP.rename(file, newFile);
       } catch (error) {
         logger.error(`Failed to rename declaration file ${file}: ${error}`);
       }
@@ -471,15 +466,19 @@ export async function calcLongestCommonPath(
   return lca;
 }
 
-export async function cleanDtsFiles(dir: string): Promise<void> {
+export const globDtsFiles = async (dir: string): Promise<string[]> => {
   const patterns = ['/**/*.d.ts', '/**/*.d.cts', '/**/*.d.mts'];
-  const files = await Promise.all(
+  const dtsFiles = await Promise.all(
     patterns.map((pattern) =>
       glob(convertPath(join(dir, pattern)), { absolute: true }),
     ),
   );
 
-  const allFiles = files.flat();
+  return dtsFiles.flat();
+};
+
+export async function cleanDtsFiles(dir: string): Promise<void> {
+  const allFiles = await globDtsFiles(dir);
 
   await Promise.all(allFiles.map((file) => fsP.rm(file, { force: true })));
 }

pnpm-lock.yaml

@@ -0,0 +1,6 @@
+{
+  "name": "dts-build-auto-extension-test",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module"
+}

tests/integration/dts/build/auto-extension/package.json

@@ -0,0 +1,21 @@
+import { defineConfig } from '@rslib/core';
+import { generateBundleCjsConfig } from 'test-helper';
+
+export default defineConfig({
+  lib: [
+    generateBundleCjsConfig({
+      bundle: false,
+      dts: {
+        autoExtension: true,
+        distPath: './dist/types',
+        bundle: false,
+        build: true,
+      },
+    }),
+  ],
+  source: {
+    entry: {
+      index: ['./src/**'],
+    },
+  },
+});

tests/integration/dts/build/auto-extension/rslib.config.ts

@@ -0,0 +1 @@
+export * from './sum';

tests/integration/dts/build/auto-extension/src/index.ts

@@ -0,0 +1,10 @@
+export const num1 = 1;
+export const num2 = 2;
+export const num3 = 3;
+
+export const str1 = 'str1';
+export const str2 = 'str2';
+export const str3 = 'str3';
+
+export const numSum = num1 + num2 + num3;
+export const strSum = str1 + str2 + str3;

tests/integration/dts/build/auto-extension/src/sum.ts

@@ -0,0 +1,15 @@
+{
+  "extends": "@rslib/tsconfig/base",
+  "compilerOptions": {
+    "baseUrl": "./",
+    "rootDir": "src",
+    "declaration": true,
+    "declarationDir": "./dist/types"
+  },
+  "include": ["src"],
+  "references": [
+    {
+      "path": "../__references__"
+    }
+  ]
+}

tests/integration/dts/build/auto-extension/tsconfig.json

@@ -5,11 +5,17 @@ export default defineConfig({
   lib: [
     generateBundleEsmConfig({
       bundle: false,
+      dts: {
+        autoExtension: true,
+        distPath: './dist/types',
+        bundle: false,
+      },
     }),
     generateBundleCjsConfig({
       bundle: false,
       dts: {
         autoExtension: true,
+        distPath: './dist/types',
         bundle: false,
       },
     }),

tests/integration/dts/bundle-false/auto-extension/rslib.config.ts

@@ -0,0 +1,6 @@
+{
+  "name": "dts-composite-auto-extension-test",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module"
+}