[WIP] build: 构建产物调整, 使用 Bundless 的方式输出, 支持 tree shaking [BREAK CHANGE] #2754

lijinke666 · 2024-05-30T09:32:36Z

👀 PR includes

🔧 Chore

📝 Description

使用 father 进行打包, 按源码目录生成 bundless ESM 构建产物 (单个大文件 tree shaking 无法生效)
抽取公用打包配置
解决包文件循环依赖问题
s2-shared 需要跳过 bundless, 直接变成 bundle

📦 构建产物调整

ESModule/CommonJS

所有包的 ESModule (esm) 和 CommonJS (lib) 构建产物从 Bundle 调整为 Bundless, 其所依赖的子模块会被直接拷贝输出，不再做编译，以便于更好的支持代码 tree shaking, 减少包体积。

由于 @antv/s2-shared 是未发布的包, 只作用公用模块使用, 所以作为子目录拷贝进 s2-(react/react-componnents/vue) 中进行 Bundle 构建. 以兼容 Bundless 的方式.

UMD

所有包的 UMD (dist) 构建产物依然为 Bundle 单文件，文件名和全局变量名有所调整：

包名	文件名（修改前）	文件名（修改后）
`@antv/s2`	`dist/index.min.js` `dist/style.min.css`	`dist/s2.min.css` `dist/s2.min.css`
`@antv/s2-react`	`dist/index.min.js` `dist/style.min.css`	`dist/s2-react.min.css` `dist/s2-react.min.css`
`@antv/s2-vue`	`dist/index.min.js` `dist/style.min.css`	`dist/s2-vue.min.css` `dist/s2-vue.min.css`

包名	全局变量名（修改前）	全局变量名（修改后）
`@antv/s2`	`S2`	`S2`
`@antv/s2-react`	`S2-React`	`S2React`
`@antv/s2-vue`	`S2-Vue`	`S2Vue`

🖼️ Screenshot

Before	After

🔗 Related issue link

close #2404

🔍 Self-Check before the merge

Add or update relevant docs.
Add or update relevant demos.
Add or update test case.
Add or update relevant TypeScript definitions.

vercel · 2024-05-30T09:32:39Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
antvis-s2	❌ Failed (Inspect)			Jun 26, 2024 9:15am

github-actions · 2024-05-30T09:35:55Z

你好, @lijinke666 CI 执行失败, 请点击 [Details] 按钮查看, 并根据日志修复

Hello, @lijinke666 CI run failed, please click the [Details] button for detailed log information and fix it.

github-actions · 2024-05-30T09:37:47Z

Size Change: +24.8 kB (+7.61%) 🔍

Total Size: 350 kB

Filename	Size	Change
`./packages/s2-core/dist/index.min.js`	0 B	-228 kB (removed)	🏆
`./packages/s2-core/dist/style.min.css`	0 B	-402 B (removed)	🏆
`./packages/s2-react/dist/index.min.js`	0 B	-69.6 kB (removed)	🏆
`./packages/s2-react/dist/style.min.css`	0 B	-3.9 kB (removed)	🏆
`./packages/s2-vue/dist/index.min.js`	0 B	-21.8 kB (removed)	🏆
`./packages/s2-vue/dist/style.min.css`	0 B	-1.98 kB (removed)	🏆
`./packages/s2-core/dist/s2.min.css`	492 B	+492 B (new file)	🆕
`./packages/s2-core/dist/s2.min.js`	258 kB	+258 kB (new file)	🆕
`./packages/s2-react/dist/s2-react.min.css`	4.16 kB	+4.16 kB (new file)	🆕
`./packages/s2-react/dist/s2-react.min.js`	80.1 kB	+80.1 kB (new file)	🆕
`./packages/s2-vue/dist/s2-vue.min.css`	247 B	+247 B (new file)	🆕
`./packages/s2-vue/dist/s2-vue.min.js`	6.85 kB	+6.85 kB (new file)	🆕

_{compressed-size-action}

codecov-commenter · 2024-05-30T09:38:59Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.19%. Comparing base (ecdc9c8) to head (bb31640).
Report is 372 commits behind head on next.

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #2754      +/-   ##
==========================================
+ Coverage   75.77%   80.19%   +4.42%     
==========================================
  Files         257      176      -81     
  Lines       11994    10170    -1824     
  Branches     2464     2330     -134     
==========================================
- Hits         9088     8156     -932     
+ Misses       1398      597     -801     
+ Partials     1508     1417      -91

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

lijinke666 · 2024-06-20T08:49:13Z

build.config.base.mjs

@@ -0,0 +1,134 @@
+import { viteCommonjs } from '@originjs/vite-plugin-commonjs';


和之前的配置没变, 之前这几个包打包配置都是复制的, 重复率有点高, 抽了下, 现在使用 father 打包, 用不到了 (暂时保留, 以免有啥问题)

lijinke666 · 2024-06-20T08:50:17Z

packages/s2-core/src/cell/merged-cell.ts

@@ -2,12 +2,12 @@ import { isEmpty } from 'lodash';
 import { CellType } from '../common/constant';
 import { CellBorderPosition, type ViewMeta } from '../common/interface';
 import type { SpreadSheet } from '../sheet-type';
-import { getBorderPositionAndStyle } from '../utils';
-import { renderLine, renderPolygon } from '../utils/g-renders';
+import { getBorderPositionAndStyle } from '../utils/cell/cell';


路径/函数移动都是解决循环依赖.

lijinke666 · 2024-06-20T08:51:38Z

packages/s2-core/src/utils/cell/merged-cell.ts

@@ -0,0 +1,140 @@
+import { find, forEach, includes, isEqual } from 'lodash';


移位置, 忽略

lijinke666 · 2024-06-26T09:14:21Z

.fatherrc.ts

+    },
+    umd: {
+      alias: {
+        '@antv/s2': path.resolve(__dirname, 'packages/s2-core'),


避免 bundle 时找不到 antv/s2 的问题

lijinke666 · 2024-06-26T09:15:54Z

.fatherrc.ts

+
+export default (name: string) => {
+  const alias = {
+    '@antv/s2-shared': path.resolve(process.cwd(), './src/shared'),


增加一个 shared 的子目录, 将 s2-shared 跳过 Bundless 的处理, 直接编译

lijinke666 · 2024-06-26T09:17:40Z

s2-site/.dumi/global.ts

@@ -22,8 +22,10 @@ if (window) {

  // 本地通过 monorepoRedirect link 时不需要引入样式, 发布时引入, 避免样式丢失
  if (process.env.NODE_ENV === 'production') {
-    (window as any).s2CSS = require('@antv/s2/dist/style.min.css');


文档相关的改动直接忽略, 都是批量替换

lijinke666 · 2024-06-26T09:18:25Z

tsconfig.base.json

@@ -5,7 +5,7 @@
    "strictPropertyInitialization": false,
    "allowSyntheticDefaultImports": true,
    "module": "esnext",
-    "declaration": false,
+    "declaration": true,


使用 ts 自带的类型生成, s2-vue 除外, father 解析不了.

lijinke666 · 2024-09-24T11:36:51Z

因依赖拆包, 合并到 #2887 中一起处理

build: esm 模块按目录打包, 使用 bundless 的方式支持 tree shaking

af0ea45

github-actions bot added the next 2.0-next 版本的问题 label May 30, 2024

github-actions bot assigned lijinke666 May 30, 2024

github-actions bot requested review from wjgogogo and wuhaiyang May 30, 2024 09:32

github-actions bot added the 🚨 lint failed 静态检查失败 label May 30, 2024

build: 修复打包尺寸校验失败

bb31640

github-actions bot removed the 🚨 lint failed 静态检查失败 label May 30, 2024

vercel bot had a problem deploying to Preview May 30, 2024 09:56 Failure

build: 自动打开分析工具

72b91b2

vercel bot had a problem deploying to Preview May 30, 2024 10:05 Failure

lijinke666 changed the title ~~build: esm 模块按目录打包, 使用 bundless 的方式支持 tree shaking~~ [WIP] build: esm 模块按目录打包, 使用 bundless 的方式支持 tree shaking May 31, 2024

Merge remote-tracking branch 'origin/next' into build-esm-bundless

3f8687e

vercel bot had a problem deploying to Preview June 19, 2024 09:58 Failure

refactor: 解决所有循环依赖问题

9a5820b

vercel bot had a problem deploying to Preview June 20, 2024 02:51 Failure

build: 使用 bundless

338e40f

vercel bot had a problem deploying to Preview June 20, 2024 07:58 Failure

github-actions bot added the 🚨 lint failed 静态检查失败 label Jun 20, 2024

docs: 新增变更文档

deb3514

vercel bot had a problem deploying to Preview June 20, 2024 08:40 Failure

lijinke666 changed the title ~~[WIP] build: esm 模块按目录打包, 使用 bundless 的方式支持 tree shaking~~ build: 构建产物调整, 使用 Bundless 的方式输出, 支持 tree shaking [BREAK CHANGE] Jun 20, 2024

lijinke666 commented Jun 20, 2024

View reviewed changes

chore: 修复 size-limit 错误

2f03e1a

github-actions bot removed the 🚨 lint failed 静态检查失败 label Jun 20, 2024

vercel bot had a problem deploying to Preview June 20, 2024 10:13 Failure

lijinke666 changed the title ~~build: 构建产物调整, 使用 Bundless 的方式输出, 支持 tree shaking [BREAK CHANGE]~~ [WIP] build: 构建产物调整, 使用 Bundless 的方式输出, 支持 tree shaking [BREAK CHANGE] Jun 21, 2024

chore: 移除别名配置

4e02f6c

github-actions bot added the 🚨 lint failed 静态检查失败 label Jun 21, 2024

vercel bot had a problem deploying to Preview June 21, 2024 01:57 Failure

build: 预编译 s2-shared, 解决 bundless 的问题

d2197f7

vercel bot had a problem deploying to Preview June 21, 2024 09:15 Failure

Merge remote-tracking branch 'origin/next' into build-esm-bundless

b565b05

vercel bot had a problem deploying to Preview June 26, 2024 02:24 Failure

build: 修复 react-components 和 vue 打包失败

fe6b0ce

lijinke666 commented Jun 26, 2024

View reviewed changes

vercel bot had a problem deploying to Preview June 26, 2024 09:15 Failure

lijinke666 commented Jun 26, 2024

View reviewed changes

wjgogogo mentioned this pull request Jul 18, 2024

feat: 增加绘制透视组合图的能力 #2780

Merged

16 tasks

lijinke666 closed this Sep 24, 2024

github-actions bot removed the 🚨 lint failed 静态检查失败 label Sep 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] build: 构建产物调整, 使用 Bundless 的方式输出, 支持 tree shaking [BREAK CHANGE] #2754

[WIP] build: 构建产物调整, 使用 Bundless 的方式输出, 支持 tree shaking [BREAK CHANGE] #2754

lijinke666 commented May 30, 2024 •

edited

Loading

vercel bot commented May 30, 2024 •

edited

Loading

github-actions bot commented May 30, 2024 •

edited

Loading

github-actions bot commented May 30, 2024 •

edited

Loading

codecov-commenter commented May 30, 2024 •

edited

Loading

lijinke666 Jun 20, 2024

lijinke666 Jun 20, 2024 •

edited

Loading

lijinke666 Jun 20, 2024

lijinke666 Jun 26, 2024

lijinke666 Jun 26, 2024 •

edited

Loading

lijinke666 Jun 26, 2024

lijinke666 Jun 26, 2024

lijinke666 commented Sep 24, 2024

		@@ -0,0 +1,134 @@
		import { viteCommonjs } from '@originjs/vite-plugin-commonjs';

		@@ -0,0 +1,140 @@
		import { find, forEach, includes, isEqual } from 'lodash';

[WIP] build: 构建产物调整, 使用 Bundless 的方式输出, 支持 tree shaking [BREAK CHANGE] #2754

[WIP] build: 构建产物调整, 使用 Bundless 的方式输出, 支持 tree shaking [BREAK CHANGE] #2754

Conversation

lijinke666 commented May 30, 2024 • edited Loading

👀 PR includes

📝 Description

📦 构建产物调整

🖼️ Screenshot

🔗 Related issue link

🔍 Self-Check before the merge

vercel bot commented May 30, 2024 • edited Loading

github-actions bot commented May 30, 2024 • edited Loading

github-actions bot commented May 30, 2024 • edited Loading

codecov-commenter commented May 30, 2024 • edited Loading

Codecov Report

lijinke666 Jun 20, 2024

Choose a reason for hiding this comment

lijinke666 Jun 20, 2024 • edited Loading

Choose a reason for hiding this comment

lijinke666 Jun 20, 2024

Choose a reason for hiding this comment

lijinke666 Jun 26, 2024

Choose a reason for hiding this comment

lijinke666 Jun 26, 2024 • edited Loading

Choose a reason for hiding this comment

lijinke666 Jun 26, 2024

Choose a reason for hiding this comment

lijinke666 Jun 26, 2024

Choose a reason for hiding this comment

lijinke666 commented Sep 24, 2024

lijinke666 commented May 30, 2024 •

edited

Loading

vercel bot commented May 30, 2024 •

edited

Loading

github-actions bot commented May 30, 2024 •

edited

Loading

github-actions bot commented May 30, 2024 •

edited

Loading

codecov-commenter commented May 30, 2024 •

edited

Loading

lijinke666 Jun 20, 2024 •

edited

Loading

lijinke666 Jun 26, 2024 •

edited

Loading