feat: add oxc-transform as optional declaration generator

ice-lab · Nov 15, 2024 · 7a6f343 · 7a6f343
1 parent 073a6cb
commit 7a6f343
Show file tree

Hide file tree

Showing 9 changed files with 404 additions and 283 deletions.
diff --git a/.changeset/friendly-radios-walk.md b/.changeset/friendly-radios-walk.md
@@ -0,0 +1,5 @@
+---
+'@ice/pkg': minor
+---
+
+feat: add oxc-transform as optional declaration generator
diff --git a/examples/react-component/build.config.mts b/examples/react-component/build.config.mts
@@ -9,6 +9,9 @@ export default defineConfig({
     formats: ['esm', 'es2017', 'cjs'],
   },
   jsxRuntime: 'classic',
+  declaration: {
+    generator: 'oxc'
+  },
   sourceMaps: false,
   bundle: {
     formats: ['esm', 'es2017'],

diff --git a/packages/pkg/package.json b/packages/pkg/package.json
@@ -61,6 +61,7 @@
     "gzip-size": "^7.0.0",
     "lodash.merge": "^4.6.2",
     "magic-string": "^0.25.7",
+    "oxc-transform": "^0.35.0",
     "picocolors": "^1.0.0",
     "postcss": "^8.4.31",
     "postcss-plugin-rpx2vw": "^1.0.0",
@@ -69,7 +70,7 @@
     "rollup-plugin-visualizer": "^5.12.0",
     "semver": "^7.5.2",
     "tsc-alias": "^1.8.2",
-    "typescript": "^4.9.5"
+    "typescript": "^5.6.0"
   },
   "devDependencies": {
     "@types/babel__core": "^7.1.20",

diff --git a/packages/pkg/src/helpers/dts.ts b/packages/pkg/src/helpers/dts.ts
@@ -43,6 +43,7 @@ export interface DtsCompileOptions {
   alias: TaskConfig['alias'];
   rootDir: string;
   outputDir: string;
+  usingOxc: boolean;
 }
 
 function formatAliasToTSPathsConfig(alias: TaskConfig['alias']) {
@@ -116,7 +117,7 @@ async function getProjectTSConfig(rootDir: string): Promise<ts.ParsedCommandLine
   };
 }
 
-export async function dtsCompile({ files, rootDir, outputDir, alias }: DtsCompileOptions): Promise<DtsInputFile[]> {
+export async function dtsCompile({ files, rootDir, outputDir, alias, usingOxc }: DtsCompileOptions): Promise<DtsInputFile[]> {
   if (!files.length) {
     return [];
   }
@@ -132,18 +133,53 @@ export async function dtsCompile({ files, rootDir, outputDir, alias }: DtsCompil
     dtsPath: normalizePath(dtsPath),
   }));
 
+  const compileFunction = usingOxc ? compileFromOxc : compileFromTsc;
+  const dtsFiles = await compileFunction(_files, tsConfig)
+
+  if (!Object.keys(alias).length) {
+    // no alias config
+    return _files.map((file) => ({
+      ...file,
+      dtsContent: dtsFiles[file.dtsPath],
+    }));
+  }
+
+  // We use tsc-alias to resolve d.ts alias.
+  // Reason: https://github.com/microsoft/TypeScript/issues/30952#issuecomment-1114225407
+  const tsConfigLocalPath = path.join(rootDir, 'node_modules/.cache/ice-pkg/tsconfig.json');
+  await fse.ensureFile(tsConfigLocalPath);
+  await fse.writeJSON(tsConfigLocalPath, {
+    ...tsConfig,
+    compilerOptions: tsConfig.options,
+  }, { spaces: 2 });
+
+  const runFile = await prepareSingleFileReplaceTscAliasPaths({
+    configFile: tsConfigLocalPath,
+    outDir: outputDir,
+  });
+
+  const result = _files.map((file) => ({
+    ...file,
+    dtsContent: dtsFiles[file.dtsPath] ? runFile({ fileContents: dtsFiles[file.dtsPath], filePath: file.dtsPath }) : '',
+  }));
+
+  return result;
+}
+
+async function compileFromTsc(files: DtsInputFile[], tsConfig: ts.ParsedCommandLine): Promise<Record<string, string>> {
   // In order to only include the update files instead of all the files in the watch mode.
   function getProgramRootNames(originalFilenames: string[]) {
     // Should include all the resolved .d.ts file to avoid dts generate error:
     // TS4025: Exported variable '<name>' has or is using private name '<name>'.
     const dtsFilenames = originalFilenames.filter((filename) => filename.endsWith('.d.ts'));
-    const needCompileFileNames = _files.map(({ filePath }) => filePath);
+    const needCompileFileNames = files.map(({ filePath }) => filePath);
     return [...needCompileFileNames, ...dtsFilenames];
   }
 
-  const dtsFiles = {};
   const host = ts.createCompilerHost(tsConfig.options);
 
+  const dtsFiles: Record<string, string> = {};
+
   host.writeFile = (fileName, contents) => {
     dtsFiles[fileName] = contents;
   };
@@ -171,32 +207,23 @@ export async function dtsCompile({ files, rootDir, outputDir, alias }: DtsCompil
     });
   }
 
-  if (!Object.keys(alias).length) {
-    // no alias config
-    return _files.map((file) => ({
-      ...file,
-      dtsContent: dtsFiles[file.dtsPath],
-    }));
-  }
-
-  // We use tsc-alias to resolve d.ts alias.
-  // Reason: https://github.com/microsoft/TypeScript/issues/30952#issuecomment-1114225407
-  const tsConfigLocalPath = path.join(rootDir, 'node_modules/.cache/ice-pkg/tsconfig.json');
-  await fse.ensureFile(tsConfigLocalPath);
-  await fse.writeJSON(tsConfigLocalPath, {
-    ...tsConfig,
-    compilerOptions: tsConfig.options,
-  }, { spaces: 2 });
+  return dtsFiles
+}
 
-  const runFile = await prepareSingleFileReplaceTscAliasPaths({
-    configFile: tsConfigLocalPath,
-    outDir: outputDir,
-  });
+async function compileFromOxc(absFiles: DtsInputFile[], tsConfig: ts.ParsedCommandLine): Promise<Record<string, string>> {
+  if (!tsConfig.options.isolatedDeclarations) {
+    consola.warn(`Enable isolatedDeclarations in tsconfig.json for correct .d.ts file generation`)
+  }
+  const oxc = await import('oxc-transform');
+  const dtsFiles: Record<string, string> = {};
+  for (const file of absFiles) {
+    const fileContent = fse.readFileSync(file.filePath, 'utf-8');
+    const { code } = oxc.isolatedDeclaration(file.filePath, fileContent, {
+      sourcemap: false,
+    });
 
-  const result = _files.map((file) => ({
-    ...file,
-    dtsContent: dtsFiles[file.dtsPath] ? runFile({ fileContents: dtsFiles[file.dtsPath], filePath: file.dtsPath }) : '',
-  }));
+    dtsFiles[file.dtsPath] = code;
+  }
 
-  return result;
+  return dtsFiles
 }
diff --git a/packages/pkg/src/tasks/declaration.ts b/packages/pkg/src/tasks/declaration.ts
@@ -56,6 +56,7 @@ class DeclarationRunner extends Runner<OutputResult> {
       rootDir: context.buildContext.rootDir,
       outputDir: buildConfig.outputDir,
       alias: buildConfig.alias,
+      usingOxc: buildConfig.generator === 'oxc',
     }]);
 
     await worker.terminate();

diff --git a/packages/pkg/src/types.ts b/packages/pkg/src/types.ts
@@ -112,6 +112,14 @@ export interface DeclarationUserConfig {
    * @default 'multi'
    */
   outputMode?: 'multi' | 'unique';
+
+  /**
+   * The generator to generate .d.ts file
+   * - `'tsc'` use typescript
+   * - `'oxc'` use oxc-transform to generate isolated declaration
+   * @default 'tsc'
+   */
+  generator?: 'tsc' | 'oxc';
 }
 
 export interface UserConfig {