Repository navigation
Commit ef359b9
docs(design): plugin-distribution names esbuild, as os plugin build bundles (#27723)
Fixes #27700
Clause-②: no
Metadata-protocol: none
## 维护者速读
- 改了什么:`docs/design/plugin-distribution.md` 两处把打包工具写成 `tsup` 的句子,改为
esbuild(树形注释一处,§5 第 1 步一处)。
- 为什么改:`os plugin build` 实际用 esbuild 打包入口到 `dist/index.mjs`,设计说明却指引读者去用
`tsup`。
- 风险与回滚:纯文档、不进任何包的发布内容,无运行时风险;回滚即 revert 这一个提交。
- 先看:`docs/design/plugin-distribution.md` 第 164 行起的 §5 第 1
步新句子是否与你对构建流程的理解一致。
- 两分钟验证:运行 `git grep -n -w tsup --
docs/design/plugin-distribution.md`,预期没有任何输出。
- 需要你做的:无,席位落地。
## What changes
Two sentences in `docs/design/plugin-distribution.md` named `tsup`; `os
plugin build` bundles with esbuild. Each replacement is written from
what `packages/cli/src/commands/plugin/build.ts` does, not by swapping
the word:
- Tree comment (`.osplugin` layout, L113): "pre-built ESM bundle (tsup)"
becomes "pre-built ESM bundle (esbuild → dist/index.mjs)". The build
writes the single `dist/index.mjs` (`outfile` and the staged archive
entry).
- §5 step 1 (L164): "run `tsup` (externalize `@objectstack/*`)" becomes
"esbuild-bundle the entry to `dist/index.mjs` (externalize
`@objectstack/*`, inline every other dependency)". In the code
`external: ['@objectstack/*']` is the only external, so every other
dependency is inlined; this agrees with §4.3 "Bundled only".
Only those two places are edited. The ADR-0025 half of the original card
is #27684 (triage re-scope), and `docs/adr/**` is untouched.
## Tests
Docs-only change; no package test applies.
<details>
<summary>Gate readings</summary>
- `git grep -n -w tsup -- docs/design/plugin-distribution.md` exits 1
with no output (0 hits), against 2 hits on `origin/main` `2feee8371a`.
- `node scripts/pm/dispatch-gates.mjs --commands --repo
objectstack-ai/objectstack` derived 15 families for this diff; all 15
were run locally and exited 0 (`--ran` reconciliation: 15 derived, 15
run, 0 NOT-MEASURED). The CI-side families are read from this PR's
check-runs.
- Raw control-character scan of the file: no hits.
</details>
## Acceptance notes
- `skip-changeset` is declared at creation: `docs/design/` is in no
package's `files[]` (`git grep 'docs/design' --
'packages/*/package.json'` has no hit), so the diff publishes nothing.
- No out-of-scope findings.
## Verification
`git grep -n -w tsup -- docs/design/plugin-distribution.md` prints
nothing.
---
_Generated by [Claude
Code](https://claude.ai/code/session_01QSeKYmTYfaPbLQD4BJfomW)_
Co-authored-by: Claude <noreply@anthropic.com>1 parent df0e1a0 commit ef359b9
1 file changed
Lines changed: 3 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
110 | 110 | | |
111 | 111 | | |
112 | 112 | | |
113 | | - | |
| 113 | + | |
114 | 114 | | |
115 | 115 | | |
116 | 116 | | |
| |||
161 | 161 | | |
162 | 162 | | |
163 | 163 | | |
164 | | - | |
| 164 | + | |
| 165 | + | |
165 | 166 | | |
166 | 167 | | |
167 | 168 | | |
| |||
0 commit comments