chore: 优化类型声明文件打包配置 (#1396)

wjgogogo · web-flow · commit 98ac16568713 · 2022-05-31T18:50:56.000+08:00
* chore: 使用api-extractor 生成 core 声明文件

* chore: 关闭tsdoc警告

* feat: s2-react 适配 api-extractor

* feat: s2-vue 适配 api-extractor

* fix: 去除s2-shared误加入到dependencies
diff --git a/.eslintignore b/.eslintignore
@@ -6,6 +6,8 @@ package.json
 esm
 lib
 dist
+temp
 .idea
 *.d.ts
 .eslintrc*
+/scripts/*
diff --git a/.gitignore b/.gitignore
@@ -21,10 +21,11 @@ temp/
 s2-site/.cache/
 s2-site/public
 
-# s2-core
+# packages
 packages/s2-*/lib/
 packages/s2-*/esm/
 packages/s2-*/dist/
+packages/s2-*/temp/
 packages/s2-*/coverage/
 packages/s2-*/stats.html
 
diff --git a/package.json b/package.json
@@ -93,6 +93,7 @@
     "@babel/core": "^7.17.9",
     "@commitlint/cli": "^16.2.3",
     "@commitlint/config-conventional": "^16.2.1",
+    "@microsoft/api-extractor": "^7.24.2",
     "@originjs/vite-plugin-commonjs": "^1.0.3",
     "@rollup/plugin-alias": "^3.1.9",
     "@rollup/plugin-commonjs": "^21.1.0",
diff --git a/packages/s2-core/__tests__/unit/interaction/root-spec.ts b/packages/s2-core/__tests__/unit/interaction/root-spec.ts
@@ -241,7 +241,7 @@ describe('RootInteraction Tests', () => {
     let flag = false;
     const hoverTimer = setTimeout(() => {
       flag = true;
-    }, 100);
+    }, 100) as unknown as number;
 
     rootInteraction.setState({
       cells: [getCellMeta(mockCell)],
@@ -272,7 +272,7 @@ describe('RootInteraction Tests', () => {
     let flag = false;
     const hoverTimer = setTimeout(() => {
       flag = true;
-    }, 100);
+    }, 100) as unknown as number;
 
     rootInteraction.setState({
       cells: [getCellMeta(mockCell)],
@@ -475,7 +475,7 @@ describe('RootInteraction Tests', () => {
 
   describe('RootInteraction Hover Timer Tests', () => {
     test('should save hover timer', () => {
-      const timer = setTimeout(() => jest.fn(), 200);
+      const timer = setTimeout(() => jest.fn(), 200) as unknown as number;
 
       rootInteraction.setHoverTimer(timer);
 
@@ -486,7 +486,7 @@ describe('RootInteraction Tests', () => {
       let flag = false;
       const timer = setTimeout(() => {
         flag = true;
-      }, 200);
+      }, 200) as unknown as number;
 
       rootInteraction.setHoverTimer(timer);
       rootInteraction.clearHoverTimer();
diff --git a/packages/s2-core/package.json b/packages/s2-core/package.json
@@ -38,12 +38,16 @@
   ],
   "scripts": {
     "start": "yarn test:live",
-    "clean": "rimraf lib esm dist",
-    "build": "run-s clean build:esm build:cjs build:umd",
-    "build:esm": "cross-env FORMAT=esm rollup -c rollup.config.js",
+    "clean": "rimraf lib esm dist temp",
+    "build": "npm-run-all clean --parallel build:umd build:cjs build:esm --sequential build:dts",
+    "build:esm": "cross-env FORMAT=es rollup -c rollup.config.js",
     "build:cjs": "cross-env FORMAT=cjs rollup -c rollup.config.js",
     "build:umd": "cross-env FORMAT=umd rollup -c rollup.config.js",
     "build:analysis": "cross-env FORMAT=esm ANALYSIS=true rollup -c rollup.config.js",
+    "build:dts": "run-s dts:*",
+    "dts:build":"ttsc -p tsconfig.declaration.json",
+    "dts:extract":"cross-env LIB=s2-core node ../../scripts/dts.js",
+    "dts:clean":"rimraf temp",
     "bundle:size": "bundlesize",
     "watch": "rimraf esm && yarn build:esm -w",
     "test:live": "node ./scripts/test-live.mjs",
diff --git a/packages/s2-core/rollup.config.js b/packages/s2-core/rollup.config.js
@@ -8,19 +8,18 @@ import { terser } from 'rollup-plugin-terser';
 import typescript from 'rollup-plugin-typescript2';
 import { visualizer } from 'rollup-plugin-visualizer';
 import peerDepsExternal from 'rollup-plugin-peer-deps-external';
-import ttypescript from 'ttypescript';
 
 const format = process.env.FORMAT;
 const enableAnalysis = process.env.ANALYSIS;
 
 const OUT_DIR_NAME_MAP = {
-  esm: 'esm',
+  es: 'esm',
   cjs: 'lib',
   umd: 'dist',
 };
 
 const outDir = OUT_DIR_NAME_MAP[format];
-const isEsmFormat = format === 'esm';
+
 const isUmdFormat = format === 'umd';
 
 const output = {
@@ -42,17 +41,12 @@ const plugins = [
   commonjs(),
   resolve(),
   typescript({
-    outDir,
     abortOnError: true,
     tsconfig: 'tsconfig.json',
     tsconfigOverride: {
-      exclude: ['__tests__'],
-      compilerOptions: {
-        declaration: isEsmFormat,
-        declarationMap: isEsmFormat,
-      },
+      outDir,
+      include: ['src'],
     },
-    typescript: ttypescript,
   }),
   postcss({
     minimize: isUmdFormat,
diff --git a/packages/s2-core/src/interaction/base-interaction/hover.ts b/packages/s2-core/src/interaction/base-interaction/hover.ts
@@ -1,6 +1,6 @@
 import { Event as CanvasEvent } from '@antv/g-canvas';
 import { getCellMeta } from 'src/utils/interaction/select-event';
-import { isEmpty, forEach, isEqual, isBoolean } from 'lodash';
+import { isEmpty, forEach, isBoolean } from 'lodash';
 import { BaseEvent, BaseEventImplement } from '../base-event';
 import { ColCell, RowCell } from '@/cell';
 import { S2Event } from '@/common/constant';
@@ -95,7 +95,7 @@ export class HoverEvent extends BaseEvent implements BaseEventImplement {
     if (hoverFocusDuration === 0) {
       handleHoverFocus();
     } else {
-      const hoverTimer = setTimeout(
+      const hoverTimer: number = window.setTimeout(
         () => handleHoverFocus(),
         hoverFocusDuration,
       );
diff --git a/packages/s2-core/src/interaction/root.ts b/packages/s2-core/src/interaction/root.ts
@@ -50,7 +50,7 @@ export class RootInteraction {
 
   // hover有keep-hover态，是个计时器，hover后800毫秒还在当前cell的情况下，该cell进入keep-hover状态
   // 在任何触发点击，或者点击空白区域时，说明已经不是hover了，因此需要取消这个计时器。
-  private hoverTimer: NodeJS.Timeout = null;
+  private hoverTimer: number = null;
 
   public eventController: EventController;
 
@@ -503,7 +503,7 @@ export class RootInteraction {
     clearTimeout(this.hoverTimer);
   }
 
-  public setHoverTimer(timer: NodeJS.Timeout) {
+  public setHoverTimer(timer: number) {
     this.hoverTimer = timer;
   }
 
diff --git a/packages/s2-core/tsconfig.declaration.json b/packages/s2-core/tsconfig.declaration.json
@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "declarationDir": "temp",
+    "declaration": true,
+    "emitDeclarationOnly": true
+  },
+  "include": ["src"]
+}
diff --git a/packages/s2-core/tsconfig.json b/packages/s2-core/tsconfig.json
@@ -7,5 +7,6 @@
       "src/*": ["./src/*"],
       "tests/*": ["./__tests__/*"],
     }
-  }
+  },
+  "exclude": ["node_modules", "coverage", "esm", "lib", "dist","temp"]
 }
diff --git a/packages/s2-react/package.json b/packages/s2-react/package.json
@@ -37,15 +37,18 @@
   ],
   "scripts": {
     "start": "cross-env PLAYGROUND=true vite",
-    "clean": "rimraf lib esm dist",
-    "build": "run-s clean build:esm build:cjs build:umd build:declaration",
+    "clean": "rimraf lib esm dist temp",
+    "build": "npm-run-all clean --parallel build:umd build:cjs build:esm --sequential build:dts",
     "build:esm": "cross-env FORMAT=es vite build",
     "build:cjs": "cross-env FORMAT=cjs vite build",
     "build:umd": "cross-env FORMAT=umd vite build",
     "build:analysis": "cross-env FORMAT=es ANALYSIS=true vite build",
-    "build:declaration": "ttsc -p tsconfig.declaration.json",
+    "build:dts": "run-s dts:*",
+    "dts:build-shared":"yarn workspace @antv/s2-shared build:dts",
+    "dts:build":"ttsc -p tsconfig.declaration.json",
+    "dts:extract":"cross-env LIB=s2-react node ../../scripts/dts.js",
+    "dts:clean":"rimraf temp",
     "bundle:size": "bundlesize",
-    "watch": "rimraf esm && concurrently \"yarn build:esm -w\" \"yarn build:declaration -w\"",
     "test": "jest --passWithNoTests",
     "test:coverage": "yarn test --coverage",
     "test:ci": "yarn test --maxWorkers=3",
diff --git a/packages/s2-react/src/components/index.ts b/packages/s2-react/src/components/index.ts
@@ -2,9 +2,14 @@ export { BaseSheet } from './sheets/base-sheet';
 export { TableSheet } from './sheets/table-sheet';
 export { GridAnalysisSheet } from './sheets/grid-analysis-sheet';
 export { StrategySheet } from './sheets/strategy-sheet';
-export { AdvancedSort } from './advanced-sort';
-export { DrillDown } from './drill-down';
+export {
+  AdvancedSort,
+  type AdvancedSortProps,
+  type AdvancedSortCfgProps,
+} from './advanced-sort';
+export { DrillDown, type DrillDownProps, type DataSet } from './drill-down';
 export { TooltipComponent } from './tooltip';
-export { Switcher } from './switcher';
+export type { TooltipRenderProps } from './tooltip/interface';
+export { Switcher, type SwitcherProps } from './switcher';
 export * from './sheets';
 export * from './sheets/interface';
diff --git a/packages/s2-react/tsconfig.declaration.json b/packages/s2-react/tsconfig.declaration.json
@@ -1,10 +1,9 @@
 {
   "extends": "./tsconfig.json",
-  "include": ["src"],
   "compilerOptions": {
-    "declarationDir": "esm",
+    "declarationDir": "temp",
     "declaration": true,
-    "declarationMap": true,
     "emitDeclarationOnly": true
-  }
+  },
+  "include": ["src"]
 }
diff --git a/packages/s2-shared/package.json b/packages/s2-shared/package.json
@@ -1,17 +1,18 @@
 {
-  "private":"true",
+  "private": "true",
   "name": "@antv/s2-shared",
   "version": "1.0.0",
   "main": "./src/index.ts",
   "types": "./src/index.ts",
   "description": "internal utility functions and constants shared across s2 packages.",
   "license": "MIT",
   "scripts": {
-    "build":"echo 'no need to build'",
-    "test":"jest"
+    "build": "echo 'no need to build'",
+    "build:dts": "tsc -p tsconfig.declaration.json",
+    "test": "jest"
   },
   "devDependencies": {
-    "@antv/s2":"*",
+    "@antv/s2": "*",
     "lodash": "^4.17.21"
   }
 }
diff --git a/packages/s2-shared/tsconfig.declaration.json b/packages/s2-shared/tsconfig.declaration.json
@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "declarationDir": "temp",
+    "declaration": true,
+    "emitDeclarationOnly": true
+  },
+  "include": ["src"]
+}
diff --git a/packages/s2-vue/package.json b/packages/s2-vue/package.json
@@ -37,15 +37,18 @@
   ],
   "scripts": {
     "start": "cross-env PLAYGROUND=true vite",
-    "clean": "rimraf lib esm dist",
-    "build": "run-s clean build:esm build:cjs build:umd build:declaration",
+    "clean": "rimraf lib esm dist temp",
+    "build": "npm-run-all clean --parallel build:umd build:cjs build:esm --sequential build:dts",
     "build:esm": "cross-env FORMAT=es vite build",
     "build:cjs": "cross-env FORMAT=cjs vite build",
     "build:umd": "cross-env FORMAT=umd vite build",
     "build:analysis": "cross-env FORMAT=es ANALYSIS=true vite build",
-    "build:declaration": "vue-tsc -p tsconfig.declaration.json",
+    "build:dts": "run-s dts:*",
+    "dts:build-shared":"yarn workspace @antv/s2-shared build:dts",
+    "dts:build":"vue-tsc -p tsconfig.declaration.json",
+    "dts:extract":"cross-env LIB=s2-vue node ../../scripts/dts.js",
+    "dts:clean":"rimraf temp",
     "bundle:size": "bundlesize",
-    "watch": "rimraf esm && concurrently \"yarn build:esm -w\" \"yarn build:declaration -w\"",
     "test": "jest --passWithNoTests",
     "test:coverage": "yarn test --coverage",
     "test:ci": "yarn test --maxWorkers=3",
diff --git a/packages/s2-vue/tsconfig.declaration.json b/packages/s2-vue/tsconfig.declaration.json
@@ -1,10 +1,9 @@
 {
   "extends": "./tsconfig.json",
-  "include": ["src"],
   "compilerOptions": {
+    "declarationDir": "temp",
     "declaration": true,
-    "declarationDir": "esm",
-    "declarationMap": true,
     "emitDeclarationOnly": true
-  }
+  },
+  "include": ["src"]
 }
diff --git a/scripts/api-extractor.json b/scripts/api-extractor.json
@@ -0,0 +1,56 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+
+  "mainEntryPointFilePath": "<projectFolder>/temp/index.d.ts",
+
+  "bundledPackages": ["@antv/s2-shared"],
+
+  "compiler": {
+    "tsconfigFilePath": "<projectFolder>/tsconfig.json"
+  },
+
+  "dtsRollup": {
+    "enabled": true,
+    "untrimmedFilePath": "",
+    "publicTrimmedFilePath": "<projectFolder>/esm/index.d.ts"
+  },
+
+  "apiReport": {
+    "enabled": false
+  },
+
+  "docModel": {
+    "enabled": true
+  },
+  "tsdocMetadata": {
+    "enabled": false
+  },
+
+  "messages": {
+    "compilerMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    },
+
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "none"
+      }
+    },
+
+    "extractorMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      },
+
+      "ae-missing-release-tag": {
+        "logLevel": "none"
+      },
+
+      "ae-extra-release-tag": {
+        "logLevel": "none"
+      }
+    }
+  }
+}
diff --git a/scripts/dts.js b/scripts/dts.js
diff --git a/scripts/rewritePackage.js b/scripts/rewritePackage.js
diff --git a/tsconfig.base.json b/tsconfig.base.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ export class RootInteraction {`
`50`	`50`
`51`	`51`	`// hover有keep-hover态，是个计时器，hover后800毫秒还在当前cell的情况下，该cell进入keep-hover状态`
`52`	`52`	`// 在任何触发点击，或者点击空白区域时，说明已经不是hover了，因此需要取消这个计时器。`
`53`		`- private hoverTimer: NodeJS.Timeout = null;`
	`53`	`+ private hoverTimer: number = null;`
`54`	`54`
`55`	`55`	`public eventController: EventController;`
`56`	`56`
`@@ -503,7 +503,7 @@ export class RootInteraction {`
`503`	`503`	`clearTimeout(this.hoverTimer);`
`504`	`504`	`}`
`505`	`505`
`506`		`- public setHoverTimer(timer: NodeJS.Timeout) {`
	`506`	`+ public setHoverTimer(timer: number) {`
`507`	`507`	`this.hoverTimer = timer;`
`508`	`508`	`}`
`509`	`509`
Original file line number	Diff line number	Diff line change
`@@ -7,5 +7,6 @@`
`7`	`7`	`"src/": ["./src/"],`
`8`	`8`	`"tests/": ["./__tests__/"],`
`9`	`9`	`}`
`10`		`- }`
	`10`	`+ },`
	`11`	`+ "exclude": ["node_modules", "coverage", "esm", "lib", "dist","temp"]`
`11`	`12`	`}`