fix: fix build vue-next types (Tencent#5174)

zhangpaopao0609 · web-flow · commit 636926ade1f3 · 2025-03-13T15:44:53.000+08:00
* feat: builds tdesign-vue-next types

* feat: build:vue-next-tsc script

* chore: remove

* refactor: remove tsconfig.components.json

* fix: internal/builds prebuild

* refactor: typesRoot

* refactor: tsconfig.json include common

* refactor: glob
diff --git a/internal/builds/package.json b/internal/builds/package.json
@@ -0,0 +1,19 @@
+{
+  "name": "@tdesign/internal-builds",
+  "private": true,
+  "author": "tdesign",
+  "license": "MIT",
+  "scripts": {
+    "prebuild": "rollup -c rollup.config.ts",
+    "build:vue-next-tsc": "node dist/tdesign-vue-next/index.js"
+  },
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^16.0.0",
+    "@rollup/plugin-typescript": "^12.1.2",
+    "fs-extra": "^11.3.0",
+    "glob": "^11.0.1",
+    "rollup": "^2.79.1",
+    "rollup-plugin-delete": "^2.1.0",
+    "rollup-plugin-multi-input": "^1.4.1"
+  }
+}
diff --git a/internal/builds/rollup.config.ts b/internal/builds/rollup.config.ts
@@ -0,0 +1,29 @@
+import { defineConfig } from 'rollup';
+import json from '@rollup/plugin-json';
+import del from 'rollup-plugin-delete';
+import commonjs from '@rollup/plugin-commonjs';
+import typescript from '@rollup/plugin-typescript';
+import nodeResolve from '@rollup/plugin-node-resolve';
+// @ts-ignore
+import multiInput from 'rollup-plugin-multi-input';
+
+export default defineConfig({
+  input: ['src/**/*.ts'],
+  output: [
+    {
+      dir: 'dist',
+      format: 'cjs',
+    },
+  ],
+  plugins: [
+    multiInput(),
+    typescript({
+      resolveJsonModule: true,
+      allowSyntheticDefaultImports: true,
+    }),
+    nodeResolve({ preferBuiltins: true }),
+    commonjs(),
+    json(),
+    del({ targets: 'dist' }),
+  ],
+});
diff --git a/internal/builds/src/tdesign-vue-next/build-types.ts b/internal/builds/src/tdesign-vue-next/build-types.ts
@@ -0,0 +1,58 @@
+import { glob } from 'glob';
+import { run } from '@tdesign/internal-utils';
+import { readFile, copy, writeFile, remove } from 'fs-extra';
+import { resolve, getWorkSpaceRoot } from '@tdesign/internal-utils';
+
+const generateSourceTypes = async () => {
+  // 1. 编译 tsc
+  await run('tsc --outDir dist/types -p tsconfig.json --emitDeclarationOnly');
+
+  const workSpaceRoot = await getWorkSpaceRoot();
+  const typesRoot = resolve(workSpaceRoot, 'dist/types');
+
+  // 2. 删除 style 目录
+  const styleDirPaths = await glob(`${resolve(typesRoot, 'packages/**/style')}`);
+  await Promise.all(
+    styleDirPaths.map(async (styleDirPath) => {
+      await remove(styleDirPath);
+    }),
+  );
+
+  // 3. 复制 common 到 packages 下
+  await copy(resolve(typesRoot, 'packages/common'), resolve(typesRoot, 'packages/components/common'));
+};
+
+const generateTargetTypes = async (target: 'es' | 'esm' | 'lib' | 'cjs') => {
+  const workSpaceRoot = await getWorkSpaceRoot();
+  const typesRoot = resolve(workSpaceRoot, 'dist/types');
+
+  // 1. 复制 packages/components 到 packages/tdesign-vue-next/target 下
+  const targetDir = resolve(workSpaceRoot, `packages/tdesign-vue-next/${target}`);
+  await copy(resolve(typesRoot, `packages/components`), targetDir);
+
+  // 2. 替换 @tdesign/common-js 为 tdesign-vue-next/common/js
+  const dtsPaths = await glob(`${resolve(targetDir, '**/*.d.ts')}`);
+  const rewrite = dtsPaths.map(async (filePath) => {
+    const content = await readFile(filePath, 'utf8');
+    await writeFile(filePath, content.replace(/@tdesign\/common-js/g, `tdesign-vue-next/${target}/common/js`), 'utf8');
+  });
+  await Promise.all(rewrite);
+};
+
+const removeSourceTypes = async () => {
+  const workSpaceRoot = await getWorkSpaceRoot();
+  const distTypesRoot = resolve(workSpaceRoot, 'dist');
+  await remove(distTypesRoot);
+};
+
+export const buildTypes = async () => {
+  await removeSourceTypes();
+  await generateSourceTypes();
+  const targets = ['es', 'esm', 'lib', 'cjs'] as const;
+  await Promise.all(
+    targets.map(async (target) => {
+      await generateTargetTypes(target);
+    }),
+  );
+  await removeSourceTypes();
+};
diff --git a/internal/builds/src/tdesign-vue-next/index.ts b/internal/builds/src/tdesign-vue-next/index.ts
@@ -0,0 +1,3 @@
+import { buildTypes } from './build-types';
+
+buildTypes();
diff --git a/internal/utils/index.ts b/internal/utils/index.ts
@@ -1,2 +1,4 @@
 export * from './src/paths';
+export * from './src/paths-v2';
 export * from './src/package-json';
+export * from './src/exec';
diff --git a/internal/utils/package.json b/internal/utils/package.json
@@ -16,21 +16,33 @@
       "import": "./dist/es/paths.js",
       "default": "./dist/cjs/paths.js"
     },
+    "./paths-v2": {
+      "types": "./types/paths-v2.d.ts",
+      "import": "./dist/es/paths-v2.js",
+      "default": "./dist/cjs/paths-v2.js"
+    },
     "./package-json": {
       "types": "./types/package-json.d.ts",
       "import": "./dist/es/package-json.js",
       "default": "./dist/cjs/package-json.js"
+    },
+    "./exec": {
+      "types": "./types/exec.d.ts",
+      "import": "./dist/es/exec.js",
+      "default": "./dist/cjs/exec.js"
     }
   },
   "scripts": {
-    "build": "rollup -c rollup.config.ts && pnpm build:tsc", 
+    "prebuild": "rollup -c rollup.config.ts && pnpm build:tsc",
     "build:tsc": "tsc --declaration --emitDeclarationOnly --rootDir . --outDir types --resolveJsonModule --esModuleInterop ./src/*.ts index.ts"
   },
   "devDependencies": {
+    "@pnpm/find-workspace-dir": "^1000.1.0",
     "@rollup/plugin-node-resolve": "^16.0.0",
     "@rollup/plugin-typescript": "^12.1.2",
+    "execa": "^8.0.1",
     "rollup": "^2.79.1",
     "rollup-plugin-delete": "^2.1.0",
     "rollup-plugin-multi-input": "^1.4.1"
   }
-}
+}
diff --git a/internal/utils/rollup.config.ts b/internal/utils/rollup.config.ts
@@ -1,8 +1,9 @@
 import { defineConfig } from 'rollup';
-import typescript from '@rollup/plugin-typescript';
-import nodeResolve from '@rollup/plugin-node-resolve';
 import json from '@rollup/plugin-json';
 import del from 'rollup-plugin-delete';
+import commonjs from '@rollup/plugin-commonjs';
+import typescript from '@rollup/plugin-typescript';
+import nodeResolve from '@rollup/plugin-node-resolve';
 // @ts-ignore
 import multiInput from 'rollup-plugin-multi-input';
 
@@ -24,7 +25,8 @@ export default defineConfig({
       resolveJsonModule: true,
       allowSyntheticDefaultImports: true,
     }),
-    nodeResolve(),
+    nodeResolve({ preferBuiltins: true }),
+    commonjs(),
     json(),
     del({ targets: 'dist' }),
   ],
diff --git a/internal/utils/src/exec.ts b/internal/utils/src/exec.ts
@@ -0,0 +1,15 @@
+import { execaCommand, SyncOptions } from 'execa';
+import { getWorkSpaceRoot } from './paths-v2';
+
+const run = async (command: string, options: SyncOptions = {}) => {
+  const workspaceDir = await getWorkSpaceRoot();
+  const { stdout, stderr } = await execaCommand(command, {
+    cwd: workspaceDir,
+    stdio: 'inherit',
+    ...options,
+  });
+
+  return { stdout, stderr };
+};
+
+export { run };
diff --git a/internal/utils/src/paths-v2.ts b/internal/utils/src/paths-v2.ts
@@ -0,0 +1,23 @@
+// paths.ts 是用于之前处理路径的，但因为是直接使用的相对路径，在根目录下使用（比如根目录下执行 rollup 打包）路径是没问题的
+// 但如果在非根目录下使用，就会有问题，但又不能直接废弃，因此这里重新写一份
+import { findWorkspaceDir } from '@pnpm/find-workspace-dir';
+import { posix } from 'path';
+
+const resolve = posix.resolve;
+
+// root
+export const getWorkSpaceRoot = async () => {
+  return await findWorkspaceDir(process.cwd());
+};
+// packages
+export const getPackagesRoot = async () => {
+  return resolve(await getWorkSpaceRoot(), 'packages');
+};
+// packages/components
+export const getComponentsRoot = async () => {
+  return resolve(await getPackagesRoot(), 'components');
+};
+// packages/tdesign-vue-next
+export const getTdesignVueNextRoot = async () => {
+  return resolve(await getPackagesRoot(), 'tdesign-vue-next');
+};
diff --git a/internal/utils/types/index.d.ts b/internal/utils/types/index.d.ts
@@ -1,2 +1,4 @@
 export * from './src/paths';
+export * from './src/paths-v2';
 export * from './src/package-json';
+export * from './src/exec';
diff --git a/internal/utils/types/src/exec.d.ts b/internal/utils/types/src/exec.d.ts
@@ -0,0 +1,9 @@
+import { SyncOptions } from 'execa';
+declare const run: (
+  command: string,
+  options?: SyncOptions,
+) => Promise<{
+  stdout: string;
+  stderr: string;
+}>;
+export { run };
diff --git a/internal/utils/types/src/paths-v2.d.ts b/internal/utils/types/src/paths-v2.d.ts
@@ -0,0 +1,4 @@
+export declare const getWorkSpaceRoot: () => Promise<string>;
+export declare const getPackagesRoot: () => Promise<string>;
+export declare const getComponentsRoot: () => Promise<string>;
+export declare const getTdesignVueNextRoot: () => Promise<string>;
diff --git a/package.json b/package.json
@@ -15,7 +15,7 @@
   },
   "scripts": {
     "pnpm:devPreinstall": "pnpm run init",
-    "postinstall": "husky install && pnpm -C internal/utils build",
+    "postinstall": "husky install && pnpm -C internal/utils prebuild && pnpm -C internal/builds prebuild",
     "init": "git submodule init && git submodule update",
     "start": "pnpm dev",
     "dev": "pnpm -C packages/tdesign-vue-next/site dev",
@@ -25,12 +25,8 @@
     "generate:usage": "node script/generate-usage/index.js",
     "generate:component": "node script/init/index.js",
     "generate:coverage-badge": "pnpm test:unit-coverage && tsx script/test/generate-coverage.js",
-    "build": "cross-env NODE_ENV=production rollup -c script/rollup.config.js && pnpm build:tsc",
-    "build:tsc": "run-p build:tsc-*",
-    "build:tsc-es": "tsc --outDir packages/tdesign-vue-next/es/ -p tsconfig.components.json",
-    "build:tsc-esm": "tsc --outDir packages/tdesign-vue-next/esm/ -p tsconfig.components.json",
-    "build:tsc-lib": "tsc --outDir packages/tdesign-vue-next/lib/ -p tsconfig.components.json",
-    "build:tsc-cjs": "tsc --outDir packages/tdesign-vue-next/cjs/ -p tsconfig.components.json",
+    "build:vue-next-tsc": "pnpm -C internal/builds build:vue-next-tsc",
+    "build": "cross-env NODE_ENV=production rollup -c script/rollup.config.js && pnpm build:vue-next-tsc",
     "lint:fix": "eslint --ext .vue,.js,.ts,.tsx ./packages --max-warnings 0 --fix --cache",
     "lint": "pnpm lint:tsc && eslint --ext .vue,.js,.ts,.tsx ./packages --max-warnings 0 --cache",
     "lint:tsc": "tsc --noEmit",
diff --git a/tsconfig.components.json b/tsconfig.components.json
diff --git a/tsconfig.json b/tsconfig.json
@@ -51,12 +51,11 @@
   ],
   "exclude": [
     "node_modules",
-    "packages/common",
     "dist",
     "lib",
     "cjs",
     "esm",
     "es",
     "global.d.ts"
   ]
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { buildTypes } from './build-types';`
	`2`	`+`
	`3`	`+buildTypes();`