feat(plugin): 产物自带样式 —— 第三方只取 entry 也能正常显示
第三方系统装完后样式全丢。复现出来的根因是产物形态:CSS 被抽成独立文件, 仓库契约要求消费方自己读 `style` 并注入 <link>(文档写了、官方参考消费方也照做了), 但第三方很容易只取 `entry`:插件能跑、页面却是白板(布局全靠 CSS)。 实测:只取 entry 时文档里插件样式表数量 0,.pt-panel 宽度从 356px 变成撑满的 1368px。 改法:vite.config.ts 新增 selfInjectStyles() 插件,在 generateBundle 阶段 把抽出的 CSS 内联进 JS,脚本一加载就注入 <style data-funjia-plugin=…>。 - 保留 style 字段与 CSS 文件不变:按文档注入的宿主照常工作;CSP 禁止内联样式时 那条路仍是唯一出路。 - 不重复注入:先检测有没有本插件的 <style data-funjia-plugin=…>, 或 href 指向本样式文件的 <link>,有就跳过。 - 走 generateBundle 而非「写完盘再改」:后者注入发生在 vite 打印体积之后, 日志 98KB / 索引 109KB 对不上账。 - 拿不到 CSS 资源时 this.warn 显式报出,不静默少注入。 - verify.mjs 加断言盯着它(产物必须含注入器)。 验证:第三方最小消费方 4 项断言全过;宿主路径 4 项全过(CSS 恰好一份、无重复注入); 对已发布产物跑 13 项打印断言全过。产物已发布为 funjia.print-tag@1.0.3。 注意:本工程从此不再等同于 funjia-plugin-starter 的默认产物形态 —— 其他插件若也会被第三方接入,值得把这套 self-inject 搬过去。
This commit is contained in:
+33
-1
@@ -8,6 +8,10 @@
|
||||
- 上架位置:`funjia-plugin-repository` 插件仓库的 `repository/plugins/funjia.print-tag/<版本>/`
|
||||
(版本号在 `plugin.config.json` 里改,当前见该文件)
|
||||
|
||||
> **产物自带样式。** JS 里内联了那份 CSS 并会在加载时自动注入,
|
||||
> 所以消费方**只取 `entry` 也能正常显示** —— 不依赖它记得读 `style` 并注入 `<link>`。
|
||||
> 详见下面「产物形态」一节。
|
||||
|
||||
仓库根目录那份 `src/` 是**原独立 Web 版**,两者并存、互不影响。
|
||||
|
||||
---
|
||||
@@ -121,6 +125,7 @@ POST /api/sn-codes/verify 校验 → { valid, reason, exists, record
|
||||
plugin/
|
||||
├── plugin.config.json ★ 元数据唯一真源(id / 版本 / 产物名 / 扩展点声明)
|
||||
├── postcss.config.js 截断 PostCSS 查找链(否则会加载仓库根目录的 Tailwind 配置)
|
||||
├── vite.config.ts 构建配置;含 selfInjectStyles() —— 让产物自带样式(见 §5)
|
||||
├── src/
|
||||
│ ├── index.ts ★ 插件入口:生命周期 + 注册菜单/路由/2 个命令
|
||||
│ ├── codes.ts Code 128 与真 QR 的 SVG 生成(纯函数,单位 mm)
|
||||
@@ -150,7 +155,34 @@ PREVIEW_API_TARGET=http://127.0.0.1:1337 npm run dev
|
||||
|
||||
---
|
||||
|
||||
## 五、已知边界
|
||||
## 五、产物形态:为什么 JS 里带着一份 CSS
|
||||
|
||||
仓库契约里 `style` 是**独立字段**:消费方要自己读它、注入 `<link>`。
|
||||
文档写清楚了,官方参考消费方(宿主的 `public/repo-consumer.html`)也照做了 ——
|
||||
但**第三方很容易只取 `entry`**,于是插件能跑、页面却是白板(布局全靠 CSS,
|
||||
样式没了等于不可用)。实测过那种状态:文档里插件样式表数量 **0**,
|
||||
`.pt-panel` 的宽度从 356px 变成撑满的 1368px。
|
||||
|
||||
一个交付物不该依赖消费方记得做第二步。所以 `vite.config.ts` 里有个
|
||||
`selfInjectStyles()` 插件,在 `generateBundle` 阶段把抽出的 CSS 内联进 JS,
|
||||
脚本一加载就注入 `<style data-funjia-plugin="funjia.print-tag">`。
|
||||
|
||||
| 做法 | 结果 |
|
||||
| --- | --- |
|
||||
| 保留 `style` 字段与那个 CSS 文件 | 按文档注入的宿主照常工作;**CSP 禁止内联样式时,这是唯一出路** |
|
||||
| JS 里再挂一层注入器 | 只取 `entry` 的消费方也能正常显示 |
|
||||
| 注入前先检测 | 已有 `<style data-funjia-plugin=…>` 或 href 指向本样式文件的 `<link>` 就跳过 → **不会重复注入** |
|
||||
|
||||
为什么走 `generateBundle` 而不是「写完盘再改文件」:后者更简单,但注入发生在
|
||||
vite 打印体积之后,日志会报 98KB、仓库索引却是 109KB,**对不上账**。
|
||||
在产物落盘前改代码,体积 / checksum / 日志三者天然一致。
|
||||
拿不到 CSS 资源时 `this.warn` 会显式报出来,不会静默少注入一份样式。
|
||||
|
||||
`npm run verify` 里有一条断言盯着它(产物必须含注入器),回归时能拦住。
|
||||
|
||||
---
|
||||
|
||||
## 六、已知边界
|
||||
|
||||
- **`--no-build` 之外的重建**:`dist/` 与 `node_modules/` 已被仓库根 `.gitignore` 忽略,不会进版本库。
|
||||
- **print 样式是临时注入的**:打印时才插 `<style media="print">`,`afterprint` 时移除。
|
||||
|
||||
Reference in New Issue
Block a user