feat: add oxc-transoform as experimental declaration compiler

Author: XGHeaven

.changeset/friendly-radios-walk.md

@@ -0,0 +1,5 @@
+---
+'@ice/pkg': minor
+---
+
+feat: add oxc-transoform as experimental declaration compiler

examples/react-component/build.config.mts

@@ -18,7 +18,9 @@ export default defineConfig({
     // formats: [],
   },
   // jsxRuntime: 'classic',
-  // declaration: false,
+  declaration: {
+    generator: 'oxc'
+  },
   sourceMaps: false,
   bundle: {
     formats: ['esm', 'es2017'],

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",

packages/pkg/src/config/userConfig.ts

@@ -75,8 +75,15 @@ function getUserConfig() {
     },
     {
       name: 'declaration',
-      validation: 'boolean',
+      validation: 'boolean|object',
       defaultValue: true,
+      setConfig: (config: TaskConfig, declarationConfig: UserConfig['declaration']) => {
+        if (config.type === 'declaration') {
+          if (typeof declarationConfig === 'object') {
+            config.generator = declarationConfig.generator
+          }
+        }
+      },
     },
     // TODO: validate values recursively
     {

packages/pkg/src/helpers/dts.ts

@@ -7,6 +7,7 @@ import { prepareSingleFileReplaceTscAliasPaths } from 'tsc-alias';
 import fse from 'fs-extra';
 import * as path from 'path';
 import merge from 'lodash.merge';
+import oxc from 'oxc-transform';
 
 export type FileExt = 'js' | 'ts' | 'tsx' | 'jsx' | 'cjs' | 'mjs' | 'mts' | 'cts';
 
@@ -44,6 +45,7 @@ interface DtsCompileOptions {
   alias: TaskConfig['alias'];
   rootDir: string;
   outputDir: string;
+  usingOxc: boolean;
 }
 
 async function getTSConfig(
@@ -92,7 +94,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 [];
   }
@@ -108,18 +110,50 @@ export async function dtsCompile({ files, rootDir, outputDir, alias }: DtsCompil
     dtsPath: normalizePath(dtsPath),
   }));
 
+  const compileFunction = usingOxc ? compileFromOxc : compileFromTsc;
+  const dtsFiles = compileFunction(_files.map(file => file.filePath), tsConfig)
+
+  if (!Object.keys(alias).length) {
+    // no alias config
+    return _files;
+  }
+
+  // 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(absFiles: string[], 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 = absFiles;
     return [...needCompileFileNames, ...dtsFilenames];
   }
 
-  const dtsFiles = {};
   const host = ts.createCompilerHost(tsConfig.options);
 
+  const dtsFiles: Record<string, string> = {};
+
   host.writeFile = (fileName, contents) => {
     dtsFiles[fileName] = contents;
   };
@@ -147,29 +181,22 @@ export async function dtsCompile({ files, rootDir, outputDir, alias }: DtsCompil
     });
   }
 
-  if (!Object.keys(alias).length) {
-    // no alias config
-    return _files;
-  }
-
-  // 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: string[], tsConfig: ts.ParsedCommandLine): Promise<Record<string, string>> {
+  if (!tsConfig.options.isolatedDeclarations) {
+    consola.warn(`Please enable isolatedDeclarations in tsconfig.json when using oxc generator`)
+  }
+  const dtsFiles: Record<string, string> = {};
+  for (const file of absFiles) {
+    const fileContent = fse.readFileSync(file, 'utf-8');
+    const { code } = oxc.isolatedDeclaration(file, fileContent, {
+      sourcemap: false,
+    });
 
-  const result = _files.map((file) => ({
-    ...file,
-    dtsContent: dtsFiles[file.dtsPath] ? runFile({ fileContents: dtsFiles[file.dtsPath], filePath: file.dtsPath }) : '',
-  }));
+    dtsFiles[file] = code;
+  }
 
-  return result;
+  return dtsFiles
 }

packages/pkg/src/tasks/declaration.ts

@@ -1,7 +1,7 @@
 import path from 'node:path';
 import { Worker, MessagePort } from 'node:worker_threads';
 import { fileURLToPath } from 'node:url';
-import { OutputResult, TaskRunnerContext, WatchChangedFile } from '../types.js';
+import { DeclarationTaskConfig, OutputResult, TaskRunnerContext, WatchChangedFile } from '../types.js';
 import globby from 'globby';
 import { Runner } from '../helpers/runner.js';
 import { Rpc } from '../helpers/rpc.js';
@@ -38,9 +38,10 @@ class DeclarationRunner extends Runner<OutputResult> {
       rootDir: context.buildContext.rootDir,
       outputDir: context.buildTask.config.outputDir,
       alias: context.buildTask.config.alias,
+      usingOxc: (context.buildTask.config as DeclarationTaskConfig).generator === 'oxc',
     }]);
 
-    worker.terminate();
+    await worker.terminate();
 
     return {
       taskName: context.buildTask.name,

packages/pkg/src/types.ts

@@ -103,6 +103,17 @@ export interface BundleUserConfig {
   browser?: boolean;
 }
 
+
+export interface DeclarationUserConfig {
+  /**
+   * 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 {
   /**
    * Entry for a task
@@ -134,7 +145,7 @@ export interface UserConfig {
    * Generate .d.ts files from TypeScript files in your project.
    * @default true
    */
-  declaration?: boolean;
+  declaration?: boolean | DeclarationUserConfig;
 
   /**
    * Configure JSX transform type.
@@ -156,6 +167,19 @@ export interface UserConfig {
    * "bundle mode" means bundle everything up by using Rollup
    */
   bundle?: BundleUserConfig;
+
+  /**
+   * Experimental features
+   * Is not ready for procution. If you found any bugs, please report to https://github.com/ice-lab/icepkg/issues
+   */
+  experimental?: ExperimentalUserConfig;
+}
+
+export interface ExperimentalUserConfig {
+  /**
+   * Using oxc-transform to genreation [isolated declaration](https://www.typescriptlang.org/tsconfig/#isolatedDeclarations).
+   */
+  enableOxcIsolatedDeclaration?: boolean;
 }
 
 export type PluginUserConfig = string | [string, any?] | Plugin;
@@ -248,7 +272,7 @@ export interface TransformTaskConfig extends _TaskConfig, TransformUserConfig {
   define?: Record<string, string>;
 }
 
-export interface DeclarationTaskConfig extends _TaskConfig {
+export interface DeclarationTaskConfig extends _TaskConfig, DeclarationUserConfig {
   type: 'declaration';
 }
 

packages/pkg/tests/projects/default.test.ts

@@ -60,5 +60,5 @@ runProjectTest('default', [
     config: {
       sourceMaps: true
     }
-  }
+  },
 ])