Subpath bundles duplicate PostContext, and the root import can't be tree-shaken

未关闭
#417 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

@fabiankaegy 已经在做这个了。

开始于 2026年10月30日。

  • #418 来自 @fabiankaegy —— 未关闭

评估

难度
4/5
预计耗时
3-5 天
新手友好度
25/100
Issue 类型
缺陷
描述清晰度
需要澄清
活跃度
活跃
技术栈
react, rollup, typescript, webpack
领域
build-system

调研方向

The build is configured in webpack.config.js and package.json; read those to see how entries are bundled and why no sideEffects field exists. Inspect dist/components/post-context/index.js and dist/components/post-title/index.js to confirm each creates its own context. Done means either an ESM build with sideEffects added, or cross-entry imports externalized so React context is shared across subpaths.

由索引模型根据 Issue 内容生成。

描述

Follow-up to #97. The subpath exports it added help a lot, but two problems remain in 1.23.0. Together they force a choice between bundle size and correct behaviour.

1. The package root can't be tree-shaken

dist/index.js is one CommonJS webpack bundle, and package.json has no sideEffects field. A consumer that imports a single component from @10up/block-components gets the whole library and all of its dependencies (@tanstack/react-query, @dnd-kit/*, react-window, @leeoniya/ufuzzy, @emotion/* and so on).

On a large client site with about 60 custom blocks, each block's editor script that imported anything from the root was about 125 KB gzipped larger. Switching those imports to @10up/block-components/components/* and /hooks/* cut the editor JS from 4.8 MB to 2.5 MB gzipped, and most block scripts dropped from about 130 KB to 1–16 KB.

2. Subpath bundles each carry their own copy of shared internals

webpack.config.js builds every api/, components/, hooks/ and stores/ folder as a separate entry, and only @wordpress/* is externalized. Shared modules are therefore inlined into every entry that uses them. React context is where this breaks things. In dist/ (1.23.0):

$ grep -c createContext dist/components/post-context/index.js dist/components/post-title/index.js
dist/components/post-context/index.js:1
dist/components/post-title/index.js:1

post-title, post-featured-image, post-author, post-meta, hooks/use-post and hooks/use-primary-term each create their own copy of the post context. So this:

import { PostContext } from '@10up/block-components/components/post-context';
import { PostTitle } from '@10up/block-components/components/post-title';

<PostContext postId={ 123 } postType="post">
	<PostTitle />
</PostContext>

wires PostTitle to a different context object than the provider. It never sees postId: 123, so it falls back to the context default. To stay correct, anything using PostContext has to import the whole family from the root, which brings back the full bundle from problem 1. In our case that meant 9 files (and their blocks) still ship the full library.

The icon store is fine: every copy runs select( 'tenup/icons' ) || register( store ), so all copies share one store by name. Module-level state that isn't keyed by a global name isn't shared.

Possible fixes
  • Ship an unbundled ESM build (for example tsc output, or Rollup with preserveModules) alongside the CommonJS one. Declare "sideEffects" limited to the store registration modules. Then root imports tree-shake, shared modules exist once, and the subpath exports keep working.
  • Or, keeping the current webpack build: externalize cross-entry imports so an entry requires another entry instead of inlining it. For example, components/post-title would import @10up/block-components/components/post-context at runtime. At minimum this matters for modules that hold React context.

Happy to help test either approach.

主要语言
TypeScript
星标
330
派生
54
PR 合并指标
30 天内没有已合并 PR

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

10up/block-components 的其他 Issue

查看 10up/block-components 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。