@cfp-studio/analyzer-api 0.1.15 → 0.1.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/analyzer.d.mts +2 -2
- package/dist/analyzer.mjs +1 -1
- package/dist/{api-3X9rm2RT.d.mts → api-zlINpDQg.d.mts} +1 -1
- package/dist/empty-hint.d.mts +91 -0
- package/dist/empty-hint.mjs +1 -0
- package/dist/error-panel.d.mts +86 -0
- package/dist/error-panel.mjs +3 -0
- package/dist/factory.d.mts +1 -1
- package/dist/factory.mjs +1 -1
- package/dist/index.d.mts +50 -91
- package/dist/index.mjs +1 -3
- package/dist/logging-yGWzkaBD.mjs +1 -0
- package/dist/previewable-id.d.mts +27 -0
- package/dist/previewable-id.mjs +1 -0
- package/package.json +16 -3
package/dist/analyzer.d.mts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { l as Story, n as AnalyzerFactory, o as Component } from "./api-
|
|
1
|
+
import { l as Story, n as AnalyzerFactory, o as Component } from "./api-zlINpDQg.mjs";
|
|
2
2
|
import { Reader } from "@cfp-studio/vfs";
|
|
3
|
-
import { Logger } from "pino";
|
|
4
3
|
import { TypeResolver, createTypeAnalyzer } from "@cfp-studio/type-analyzer";
|
|
4
|
+
import { Logger } from "@cfp-studio/api";
|
|
5
5
|
|
|
6
6
|
//#region src/analyzer.d.ts
|
|
7
7
|
type CreateTypeAnalyzerOptions = Parameters<typeof createTypeAnalyzer>[0];
|
package/dist/analyzer.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{factoryWithDefaultOptions as e}from"./factory.mjs";import t from"node:path";import{createTypeAnalyzer as n}from"@cfp-studio/type-analyzer";function r(r){return e(({rootDir:e,reader:i,logger:a})=>{let o={rootDir:e,reader:i,logger:a},s=n({rootDir:e,warn:a.warn.bind(a),...r.typeAnalyzerOptions(o)}),c=r.toTypeScriptPath??(e=>e);return{typeAnalyzer:s,crawlFiles:async n=>{let i=n.map(n=>t.isAbsolute(n)?n:t.join(e,n)),a=s.analyze(i.map(c)),l=[],u=[];for(let e of i)for(let t of await r.crawlFile({...o,resolver:a,absoluteFilePath:e}))`exported`in t?l.push(t):u.push(t);return{components:l,stories:u}},dispose:()=>{s.dispose()}}})}export{r as createAnalyzer};
|
|
1
|
+
import"./logging-yGWzkaBD.mjs";import{factoryWithDefaultOptions as e}from"./factory.mjs";import t from"node:path";import{createTypeAnalyzer as n}from"@cfp-studio/type-analyzer";function r(r){return e(({rootDir:e,reader:i,logger:a})=>{let o={rootDir:e,reader:i,logger:a},s=n({rootDir:e,warn:a.warn.bind(a),...r.typeAnalyzerOptions(o)}),c=r.toTypeScriptPath??(e=>e);return{typeAnalyzer:s,crawlFiles:async n=>{let i=n.map(n=>t.isAbsolute(n)?n:t.join(e,n)),a=s.analyze(i.map(c)),l=[],u=[];for(let e of i)for(let t of await r.crawlFile({...o,resolver:a,absoluteFilePath:e}))`exported`in t?l.push(t):u.push(t);return{components:l,stories:u}},dispose:()=>{s.dispose()}}})}export{r as createAnalyzer};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Reader } from "@cfp-studio/vfs";
|
|
2
|
-
import { Logger } from "pino";
|
|
3
2
|
import { CollectedTypes, TypeAnalyzer, ValueType } from "@cfp-studio/type-analyzer";
|
|
3
|
+
import { Logger } from "@cfp-studio/api";
|
|
4
4
|
import { SerializableValue } from "@cfp-studio/serializable-values";
|
|
5
5
|
|
|
6
6
|
//#region src/api.d.ts
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
//#region src/empty-hint.d.ts
|
|
2
|
+
/**
|
|
3
|
+
* 「渲染成功但内容为空」的提示(`docs/todo/39` §5)。
|
|
4
|
+
*
|
|
5
|
+
* ## 为什么要单独一类提示
|
|
6
|
+
*
|
|
7
|
+
* 组件可能出现三种「看不到东西」的情况,前两种已经有归属:
|
|
8
|
+
*
|
|
9
|
+
* | 情况 | 现有归属 |
|
|
10
|
+
* | --- | --- |
|
|
11
|
+
* | 编译期失败(`.less` 缺包、模块解析失败) | `preview/index.html` 的 `startupErrorGuard` |
|
|
12
|
+
* | 渲染期抛错 | `renderErrorPanel`(同目录 `error-panel.ts`) |
|
|
13
|
+
* | **渲染成功但什么都没画出来** | **本文** |
|
|
14
|
+
*
|
|
15
|
+
* 典型场景是 `Modal` 没传 `open`:组件没抛错、DOM 也建了,只是尺寸为 0 ——
|
|
16
|
+
* 用户看到一片空白,误以为预览坏了。这时给一句话,比让他去翻 Output 强。
|
|
17
|
+
*
|
|
18
|
+
* ## 为什么判定放在预览页内
|
|
19
|
+
*
|
|
20
|
+
* 「空」这个事实的判定依据就是 `#root` 的 DOM。放在预览页内(`runNewRender` 的成功分支)
|
|
21
|
+
* 可以就地读取;放到宿主侧则要先让 `runtime-bridge` 发一条结构化事件,还要为
|
|
22
|
+
* embedded / browser 两种渲染面各写一遍通路。
|
|
23
|
+
*
|
|
24
|
+
* ## 与错误面板的关系
|
|
25
|
+
*
|
|
26
|
+
* 复用同一套覆盖层约定:挂在 `document.body`、带 `data-preview-error-panel` 标记
|
|
27
|
+
* (`runtime-bridge.walk()` 据此跳过它,否则它会作为普通 DOM 出现在 Runtime Tree 里)、
|
|
28
|
+
* 幂等清理。但**配色是中性色**:这不是错误,是提示。
|
|
29
|
+
*/
|
|
30
|
+
/** 提示层的 id。与错误面板(`cfp-error-panel`)区分,两者可同时存在但通常不会。 */
|
|
31
|
+
declare const EMPTY_HINT_ID = "cfp-empty-hint";
|
|
32
|
+
/**
|
|
33
|
+
* 与错误面板共用同一个标记属性。
|
|
34
|
+
*
|
|
35
|
+
* 复用而不是新开一个:`runtime-bridge` 只需跳过一类「预览工具自己画的节点」,
|
|
36
|
+
* 分两个属性只会让所有跳过逻辑都写两遍。
|
|
37
|
+
*/
|
|
38
|
+
declare const EMPTY_HINT_ATTRIBUTE = "data-preview-error-panel";
|
|
39
|
+
/** 单次渲染后等多久才判定「空」(见 `scheduleEmptyHintCheck` 的说明)。 */
|
|
40
|
+
declare const EMPTY_HINT_DELAY_MS = 400;
|
|
41
|
+
/** 组件级「空」的判定所需的最小信息(便于单测,不依赖真实 DOM 类型)。 */
|
|
42
|
+
interface RectLike {
|
|
43
|
+
width: number;
|
|
44
|
+
height: number;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* 子节点面积之和(用 `getBoundingClientRect` 的宽高)。
|
|
48
|
+
*
|
|
49
|
+
* 只关心“有没有面积”,不关心位置 —— 所以不用 `offsetWidth`(它受 `transform` 影响的方式
|
|
50
|
+
* 与 `getBoundingClientRect` 不同,而后者才是用户实际看到的)。
|
|
51
|
+
*/
|
|
52
|
+
declare function totalAreaOf(rects: readonly RectLike[]): number;
|
|
53
|
+
/**
|
|
54
|
+
* 判断一次渲染是否是「空的」。
|
|
55
|
+
*
|
|
56
|
+
* 两条判据(满足任一条即为空):
|
|
57
|
+
*
|
|
58
|
+
* 1. 没有子节点 —— 组件返回了 `null` / 空 fragment;
|
|
59
|
+
* 2. 所有子节点面积之和为 0 —— 渲染了 `<div>` 但没尺寸(`Modal` 关闭态、`display: none`)。
|
|
60
|
+
*
|
|
61
|
+
* 第 2 条是必须的:`Modal` 的例子正是「渲染了东西但没有尺寸」,只看子节点数会漏掉。
|
|
62
|
+
*/
|
|
63
|
+
declare function isEmptyRender(childCount: number, measure: () => readonly RectLike[]): boolean;
|
|
64
|
+
/**
|
|
65
|
+
* 对真实 `#root` 应用 {@link isEmptyRender}。
|
|
66
|
+
*
|
|
67
|
+
* `transform: scale` 会让 `getBoundingClientRect` 跟着缩,但比例不影响「是否为 0」,
|
|
68
|
+
* 所以不需要额外的坐标换算。
|
|
69
|
+
*/
|
|
70
|
+
declare function isRootEmpty(root: Element | null | undefined): boolean;
|
|
71
|
+
interface RenderEmptyHintOptions {
|
|
72
|
+
/** 被预览的可预览项名称,用于标题。 */
|
|
73
|
+
previewableName?: string;
|
|
74
|
+
/** 用户关闭后回调(由调用方决定是否在本次渲染内不再提示)。 */
|
|
75
|
+
onDismiss?: () => void;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* 画出「内容为空」提示(中性色,挂在 `document.body` 的独立覆盖层上)。
|
|
79
|
+
*
|
|
80
|
+
* 与 `renderErrorPanel` 一样用**内联样式**:面板渲染在用户页面之上,会继承用户的
|
|
81
|
+
* 全局 CSS(reset / `* { box-sizing }` 等),内联样式才不会被覆盖。
|
|
82
|
+
*
|
|
83
|
+
* 返回清理函数(幂等)。
|
|
84
|
+
*/
|
|
85
|
+
declare function renderEmptyHint(options?: RenderEmptyHintOptions): () => void;
|
|
86
|
+
/** 移除提示(幂等)。 */
|
|
87
|
+
declare function clearEmptyHint(): void;
|
|
88
|
+
/** 当前是否正显示空内容提示。 */
|
|
89
|
+
declare function isEmptyHintVisible(): boolean;
|
|
90
|
+
//#endregion
|
|
91
|
+
export { EMPTY_HINT_ATTRIBUTE, EMPTY_HINT_DELAY_MS, EMPTY_HINT_ID, RectLike, RenderEmptyHintOptions, clearEmptyHint, isEmptyHintVisible, isEmptyRender, isRootEmpty, renderEmptyHint, totalAreaOf };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
const e=`cfp-empty-hint`,t=`data-preview-error-panel`,n=400;function r(e){return e.reduce((e,t)=>e+Math.max(0,t.width)*Math.max(0,t.height),0)}function i(e,t){return e===0?!0:r(t())===0}function a(e){return e?i(e.children.length,()=>[...e.children].map(e=>{let t=e.getBoundingClientRect();return{width:t.width,height:t.height}})):!1}function o(n={}){s();let r=document.createElement(`div`);r.id=e,r.setAttribute(t,``),r.style.cssText=[`position: fixed`,`left: 50%`,`top: 24px`,`transform: translateX(-50%)`,`z-index: 2147483646`,`box-sizing: border-box`,`max-width: min(560px, calc(100vw - 48px))`,`padding: 10px 14px`,`font-family: ui-sans-serif, system-ui, -apple-system, 'Segoe UI', sans-serif`,`font-size: 12px`,`line-height: 1.6`,`color: #6b7280`,`background: #f8fafc`,`border: 1px solid #cbd5e1`,`border-radius: 8px`,`box-shadow: 0 4px 16px rgba(0, 0, 0, 0.12)`,`pointer-events: auto`,`text-align: left`].join(`;`);let i=document.createElement(`div`);i.style.cssText=`font-weight: 600; color: #374151; margin-bottom: 2px`,i.textContent=n.previewableName?`${n.previewableName} 已渲染,但内容为空`:`组件已渲染,但内容为空`;let a=document.createElement(`div`);a.textContent=`它可能需要 props 才能显示(例如 Modal 的 open)。可以在 __previewjs__/Wrapper.tsx 里提供默认 props。`;let o=document.createElement(`button`);return o.type=`button`,o.textContent=`×`,o.setAttribute(`aria-label`,`关闭提示`),o.style.cssText=[`position: absolute`,`top: 4px`,`right: 6px`,`width: 20px`,`height: 20px`,`padding: 0`,`border: none`,`border-radius: 4px`,`background: transparent`,`color: #94a3b8`,`font-size: 14px`,`line-height: 1`,`cursor: pointer`].join(`;`),o.addEventListener(`click`,()=>{r.remove(),n.onDismiss?.()}),r.appendChild(i),r.appendChild(a),r.appendChild(o),document.body.appendChild(r),()=>r.remove()}function s(){document.getElementById(e)?.remove()}function c(){return document.getElementById(e)!==null}export{t as EMPTY_HINT_ATTRIBUTE,n as EMPTY_HINT_DELAY_MS,e as EMPTY_HINT_ID,s as clearEmptyHint,c as isEmptyHintVisible,i as isEmptyRender,a as isRootEmpty,o as renderEmptyHint,r as totalAreaOf};
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
//#region src/error-panel.d.ts
|
|
2
|
+
/**
|
|
3
|
+
* 渲染错误面板:在**预览区域内部**显示错误,而不是白屏(`docs/todo/39`)。
|
|
4
|
+
*
|
|
5
|
+
* ## 为什么放在这里(`analyzer-api`)
|
|
6
|
+
*
|
|
7
|
+
* 5 个框架插件(react / vue3 / svelte / solid / preact)**都依赖本包**,
|
|
8
|
+
* 且都面临同一个问题:「被预览组件抛错 → 整片白屏,用户只知道坏了,不知道为什么」。
|
|
9
|
+
*
|
|
10
|
+
* 各插件各写一份错误 UI 会重复且容易漂移;这里用**纯 DOM**实现,
|
|
11
|
+
* 不引入任何框架依赖,因此 5 个插件都能直接用。
|
|
12
|
+
*
|
|
13
|
+
* ## 设计约束
|
|
14
|
+
*
|
|
15
|
+
* 1. **内联样式**:面板渲染在用户页面之上,会继承用户的全局 CSS
|
|
16
|
+
* (Umi / antd 的 reset 等)。用内联样式避免被覆盖。
|
|
17
|
+
* 2. **不污染 Runtime Tree**:面板元素带 `data-preview-error-panel`,
|
|
18
|
+
* `iframe` 的 `runtime-bridge.walk()` 会跳过它 —— 否则错误面板会出现在组件树里。
|
|
19
|
+
* 3. **不写源码、不发网络**:纯本地渲染。
|
|
20
|
+
* 4. **独立于框架渲染器**:面板挂在 `document.body` 下,不放进 `#root`(原因见 `renderErrorPanel`)。
|
|
21
|
+
*/
|
|
22
|
+
interface RenderErrorPanelOptions {
|
|
23
|
+
/** 错误本体(`Error` 或任何被 throw 的值)。 */
|
|
24
|
+
error: unknown;
|
|
25
|
+
/** 被预览的可预览项名称(如 `Button`、`Default`),用于标题。 */
|
|
26
|
+
previewableName?: string;
|
|
27
|
+
/**
|
|
28
|
+
* React / Preact 的 `componentStack`,能指出**哪个组件**抛的错。
|
|
29
|
+
* 其它框架可为空。
|
|
30
|
+
*/
|
|
31
|
+
componentStack?: string | null;
|
|
32
|
+
}
|
|
33
|
+
/** 面板元素的标记属性:`runtime-bridge.walk()` 据此跳过。 */
|
|
34
|
+
declare const ERROR_PANEL_ATTRIBUTE = "data-preview-error-panel";
|
|
35
|
+
/**
|
|
36
|
+
* 错误遮罩层的 id:整个预览页只存在一个。
|
|
37
|
+
*
|
|
38
|
+
* 固定在 `document.body` 下,**不放进 `#root`** —— `#root` 由框架的渲染器独占
|
|
39
|
+
*(ReactDOM 清非托管子节点、Vue/Solid 同理),面板放进去会跟着一起被抹掉。
|
|
40
|
+
*/
|
|
41
|
+
declare const ERROR_PANEL_ID = "cfp-error-panel";
|
|
42
|
+
/**
|
|
43
|
+
* 把错误面板渲染成预览页的**独立覆盖层**。
|
|
44
|
+
*
|
|
45
|
+
* 返回一个清理函数,移除面板。重复调用会先移除旧面板(全页只留一个)。
|
|
46
|
+
*
|
|
47
|
+
* ## 为什么不再写进传进来的 container
|
|
48
|
+
*
|
|
49
|
+
* 旧实现 `container.appendChild(panel)` 把面板塞进 `#root`,实测症状(真实反馈):
|
|
50
|
+
* 「错误页面闪现一下,然后被正常页面/白屏覆盖」。原因是双重的:
|
|
51
|
+
* 1. `#root` 归框架渲染器管,它一重渲染就清掉非托管的子节点;
|
|
52
|
+
* 2. `runNewRender` 的 catch 会 `root.innerHTML = rootHtml` 回滚快照。
|
|
53
|
+
*
|
|
54
|
+
* 所以面板必须活在**框架渲染器管不到的地方**。`container` 参数保留仅用于
|
|
55
|
+
* 「遮罩要盖在哪个区域」—— 目前是整页,忽略该参数也符合语义,保留它是为了
|
|
56
|
+
* 兼容 5 个插件现有的调用点。
|
|
57
|
+
*
|
|
58
|
+
* ## 遮罩(`options.dimBackdrop`,默认开)
|
|
59
|
+
*
|
|
60
|
+
* 保存后失败时,上一次成功的内容可能还在(`runNewRender` 会回填快照)。
|
|
61
|
+
* 面板直接用半透明遮罩铺满并阻止穿透点击,避免成功画面干扰阅读错误信息。
|
|
62
|
+
*/
|
|
63
|
+
declare function renderErrorPanel(_container: Element, options: RenderErrorPanelOptions & {
|
|
64
|
+
dimBackdrop?: boolean;
|
|
65
|
+
}): () => void;
|
|
66
|
+
/**
|
|
67
|
+
* 移除全页的错误面板(幂等)。
|
|
68
|
+
*
|
|
69
|
+
* `container` 参数保留只是为了兼容旧调用点 —— 面板现在挂在 `document.body` 下,
|
|
70
|
+
* 已不依赖具体容器。
|
|
71
|
+
*/
|
|
72
|
+
declare function clearErrorPanel(_container?: Element): void;
|
|
73
|
+
/** 当前是否正显示错误面板(供宿主判断要不要保留旧画面)。 */
|
|
74
|
+
declare function isErrorPanelVisible(): boolean;
|
|
75
|
+
/**
|
|
76
|
+
* 把任意被 throw 的值归一成 `{ message, stack }`。
|
|
77
|
+
*
|
|
78
|
+
* 项目里见过 `throw "字符串"`、`throw { message }` 这类非 Error 值,
|
|
79
|
+
* 直接 `error.message` 会拿到 `undefined`。
|
|
80
|
+
*/
|
|
81
|
+
declare function describeError(error: unknown): {
|
|
82
|
+
message: string;
|
|
83
|
+
stack: string | undefined;
|
|
84
|
+
};
|
|
85
|
+
//#endregion
|
|
86
|
+
export { ERROR_PANEL_ATTRIBUTE, ERROR_PANEL_ID, RenderErrorPanelOptions, clearErrorPanel, describeError, isErrorPanelVisible, renderErrorPanel };
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
const e=`data-preview-error-panel`,t=`cfp-error-panel`;function n(n,i){r();let{error:o,previewableName:c,componentStack:l}=i,{message:u,stack:d}=a(o),f=i.dimBackdrop!==!1,p=document.getElementById(`cfp-error-panel`)??document.createElement(`div`);p.id=t,p.setAttribute(e,``),p.style.cssText=[`position: fixed`,`inset: 0`,`z-index: 2147483647`,`box-sizing: border-box`,`margin: 0`,`padding: 24px`,`overflow: auto`,`display: flex`,`align-items: flex-start`,`justify-content: center`,f?`background: rgba(24, 24, 27, 0.55)`:`background: transparent`,f?`pointer-events: auto`:`pointer-events: none`].join(`;`);let m=document.createElement(`div`);m.setAttribute(e,``),m.style.cssText=[`position: relative`,`box-sizing: border-box`,`pointer-events: auto`,`width: 100%`,`max-width: 760px`,`margin: 0`,`padding: 20px 24px`,`font-family: ui-sans-serif, system-ui, -apple-system, 'Segoe UI', sans-serif`,`font-size: 13px`,`line-height: 1.6`,`color: #c0392b`,`background: #fff5f5`,`border: 1px solid #f5b7b1`,`border-radius: 8px`,`box-shadow: 0 8px 32px rgba(0, 0, 0, 0.28)`,`text-align: left`].join(`;`);let h=document.createElement(`div`);h.style.cssText=`font-size: 14px; font-weight: 600; margin-bottom: 8px`,h.textContent=c?`${c} 渲染失败`:`组件渲染失败`;let g=document.createElement(`pre`);if(g.style.cssText=[`margin: 0 0 12px`,`padding: 0`,`font-family: ui-monospace, SFMono-Regular, Menlo, Consolas, monospace`,`font-size: 12px`,`line-height: 1.5`,`white-space: pre-wrap`,`word-break: break-word`,`color: #922b21`].join(`;`),g.textContent=u,m.appendChild(h),m.appendChild(g),l){let e=document.createElement(`pre`);e.style.cssText=[`margin: 0`,`padding: 10px 12px`,`background: rgba(192, 57, 43, 0.06)`,`border-radius: 6px`,`font-family: ui-monospace, SFMono-Regular, Menlo, Consolas, monospace`,`font-size: 11px`,`line-height: 1.5`,`max-height: 240px`,`overflow: auto`,`white-space: pre-wrap`,`word-break: break-word`,`color: #7b241c`].join(`;`),e.textContent=s(l,12),m.appendChild(e)}if(!l&&d){let e=document.createElement(`pre`);e.style.cssText=[`margin: 0`,`padding: 10px 12px`,`background: rgba(192, 57, 43, 0.06)`,`border-radius: 6px`,`font-family: ui-monospace, SFMono-Regular, Menlo, Consolas, monospace`,`font-size: 11px`,`line-height: 1.5`,`max-height: 200px`,`overflow: auto`,`white-space: pre-wrap`,`word-break: break-word`,`color: #7b241c`].join(`;`),e.textContent=s(d,6),m.appendChild(e)}return p.appendChild(m),p.isConnected||document.body.appendChild(p),()=>{p.remove()}}function r(n){document.getElementById(t)?.remove(),document.querySelectorAll(`[${e}]`).forEach(e=>e.remove())}function i(){return document.getElementById(t)!==null}function a(e){if(e instanceof Error)return{message:e.message||e.name,stack:e.stack};if(typeof e==`string`)return{message:e,stack:void 0};if(e&&typeof e==`object`){let t=e;return{message:typeof t.message==`string`?t.message:o(e),stack:typeof t.stack==`string`?t.stack:void 0}}return{message:String(e),stack:void 0}}function o(e){try{return JSON.stringify(e)}catch{return String(e)}}function s(e,t){let n=e.split(`
|
|
2
|
+
`);return n.length>t?`${n.slice(0,t).join(`
|
|
3
|
+
`)}\n…`:e}export{e as ERROR_PANEL_ATTRIBUTE,t as ERROR_PANEL_ID,r as clearErrorPanel,a as describeError,i as isErrorPanelVisible,n as renderErrorPanel};
|
package/dist/factory.d.mts
CHANGED
package/dist/factory.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{
|
|
1
|
+
import{n as e}from"./logging-yGWzkaBD.mjs";import{createFileSystemReader as t}from"@cfp-studio/vfs";function n(n){return r=>n({...r,reader:r.reader||t(),logger:r.logger||e()})}export{n as factoryWithDefaultOptions};
|
package/dist/index.d.mts
CHANGED
|
@@ -1,116 +1,75 @@
|
|
|
1
|
-
import { a as BasicComponent, c as FileSourcePosition, d as StoryArgs, i as BasePreviewable, l as Story, n as AnalyzerFactory, o as Component, r as AnalyzerOptions, s as ComponentAnalysis, t as Analyzer, u as StoryAnalysis } from "./api-
|
|
1
|
+
import { a as BasicComponent, c as FileSourcePosition, d as StoryArgs, i as BasePreviewable, l as Story, n as AnalyzerFactory, o as Component, r as AnalyzerOptions, s as ComponentAnalysis, t as Analyzer, u as StoryAnalysis } from "./api-zlINpDQg.mjs";
|
|
2
|
+
import { ERROR_PANEL_ATTRIBUTE, ERROR_PANEL_ID, RenderErrorPanelOptions, clearErrorPanel, describeError, isErrorPanelVisible, renderErrorPanel } from "./error-panel.mjs";
|
|
3
|
+
import { PreviewableId, decodePreviewableId, generatePreviewableId } from "./previewable-id.mjs";
|
|
2
4
|
import { ValueType } from "@cfp-studio/type-analyzer";
|
|
5
|
+
import { Logger } from "@cfp-studio/api";
|
|
3
6
|
|
|
4
|
-
//#region src/
|
|
7
|
+
//#region src/logging.d.ts
|
|
5
8
|
/**
|
|
6
|
-
*
|
|
9
|
+
* 运行时日志的**统一默认级别**。
|
|
7
10
|
*
|
|
8
|
-
*
|
|
11
|
+
* 之前三处各写一个值,不传 logger 时同一份代码在不同入口的日志量级完全不同:
|
|
9
12
|
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
13
|
+
* | 位置 | 旧默认值 |
|
|
14
|
+
* | --- | --- |
|
|
15
|
+
* | `core/src/index.ts` 的 `createWorkspace` | `warn` |
|
|
16
|
+
* | `analyzer-api/src/factory.ts` | `debug` |
|
|
17
|
+
* | `loader/src/runner.ts` | `info` |
|
|
12
18
|
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* ## 设计约束
|
|
17
|
-
*
|
|
18
|
-
* 1. **内联样式**:面板渲染在用户页面之上,会继承用户的全局 CSS
|
|
19
|
-
* (Umi / antd 的 reset 等)。用内联样式避免被覆盖。
|
|
20
|
-
* 2. **不污染 Runtime Tree**:面板元素带 `data-preview-error-panel`,
|
|
21
|
-
* `iframe` 的 `runtime-bridge.walk()` 会跳过它 —— 否则错误面板会出现在组件树里。
|
|
22
|
-
* 3. **不写源码、不发网络**:纯本地渲染。
|
|
23
|
-
* 4. **独立于框架渲染器**:面板挂在 `document.body` 下,不放进 `#root`(原因见 `renderErrorPanel`)。
|
|
19
|
+
* 现在统一到 `info`:用户默认能看到「发生了什么」,看不到逐帧的内部细节。
|
|
20
|
+
* 与扩展侧的 `cfp.logLevel` 默认值一致(`apps/vscode/src/Logger.ts`),
|
|
21
|
+
* 这样从宿主到运行时是同一个口径。
|
|
24
22
|
*/
|
|
25
|
-
|
|
26
|
-
/** 错误本体(`Error` 或任何被 throw 的值)。 */
|
|
27
|
-
error: unknown;
|
|
28
|
-
/** 被预览的可预览项名称(如 `Button`、`Default`),用于标题。 */
|
|
29
|
-
previewableName?: string;
|
|
30
|
-
/**
|
|
31
|
-
* React / Preact 的 `componentStack`,能指出**哪个组件**抛的错。
|
|
32
|
-
* 其它框架可为空。
|
|
33
|
-
*/
|
|
34
|
-
componentStack?: string | null;
|
|
35
|
-
}
|
|
36
|
-
/** 面板元素的标记属性:`runtime-bridge.walk()` 据此跳过。 */
|
|
37
|
-
declare const ERROR_PANEL_ATTRIBUTE = "data-preview-error-panel";
|
|
23
|
+
declare const DEFAULT_LOG_LEVEL = "info";
|
|
38
24
|
/**
|
|
39
|
-
*
|
|
25
|
+
* 解析生效的日志级别:环境变量优先,无效值回落到 {@link DEFAULT_LOG_LEVEL}。
|
|
40
26
|
*
|
|
41
|
-
*
|
|
42
|
-
|
|
27
|
+
* 环境变量名沿用 `PREVIEWJS_LOG_LEVEL`(扩展侧 `startDaemon` 会把 `cfp.logLevel`
|
|
28
|
+
* 透传成它)。**统一在这里读**,避免各处重复实现出分歧 —— 旧代码里
|
|
29
|
+
* `loader` 用 `validLogLevels` 校验、`core` 直接透传不校验,就是分歧的开始。
|
|
43
30
|
*/
|
|
44
|
-
declare
|
|
31
|
+
declare function resolveLogLevel(explicit?: string): string;
|
|
45
32
|
/**
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
* 返回一个清理函数,移除面板。重复调用会先移除旧面板(全页只留一个)。
|
|
49
|
-
*
|
|
50
|
-
* ## 为什么不再写进传进来的 container
|
|
51
|
-
*
|
|
52
|
-
* 旧实现 `container.appendChild(panel)` 把面板塞进 `#root`,实测症状(真实反馈):
|
|
53
|
-
* 「错误页面闪现一下,然后被正常页面/白屏覆盖」。原因是双重的:
|
|
54
|
-
* 1. `#root` 归框架渲染器管,它一重渲染就清掉非托管的子节点;
|
|
55
|
-
* 2. `runNewRender` 的 catch 会 `root.innerHTML = rootHtml` 回滚快照。
|
|
56
|
-
*
|
|
57
|
-
* 所以面板必须活在**框架渲染器管不到的地方**。`container` 参数保留仅用于
|
|
58
|
-
* 「遮罩要盖在哪个区域」—— 目前是整页,忽略该参数也符合语义,保留它是为了
|
|
59
|
-
* 兼容 5 个插件现有的调用点。
|
|
33
|
+
* 创建一个写往 `process.stdout` 的运行时 logger(pino + pretty)。
|
|
60
34
|
*
|
|
61
|
-
*
|
|
35
|
+
* 所有运行时入口(loader 的全局 logger、worker、core 的默认 logger、插件的默认
|
|
36
|
+
* logger)都该用它,这样格式、级别口径、颜色设置只有一处定义。
|
|
62
37
|
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
38
|
+
* @param level - 指定级别;不传则读 `PREVIEWJS_LOG_LEVEL`,再不行用 `info`。
|
|
39
|
+
* @param source - 日志来源标签(如 `"loader"` / `"worker"`)。会作为 pino 的 `name`
|
|
40
|
+
* 出现在每一条日志里 —— daemon / loader / core / 插件的输出最终都汇进同一个
|
|
41
|
+
* channel,没有这个标签就分不清是谁打的。
|
|
65
42
|
*/
|
|
66
|
-
declare function
|
|
67
|
-
dimBackdrop?: boolean;
|
|
68
|
-
}): () => void;
|
|
43
|
+
declare function createPipelineLogger(level?: string, source?: string): Logger;
|
|
69
44
|
/**
|
|
70
|
-
*
|
|
45
|
+
* 与 {@link createPipelineLogger} 相同,但日志写往**自定义流**。
|
|
71
46
|
*
|
|
72
|
-
* `
|
|
73
|
-
*
|
|
74
|
-
*/
|
|
75
|
-
declare function clearErrorPanel(_container?: Element): void;
|
|
76
|
-
/** 当前是否正显示错误面板(供宿主判断要不要保留旧画面)。 */
|
|
77
|
-
declare function isErrorPanelVisible(): boolean;
|
|
78
|
-
/**
|
|
79
|
-
* 把任意被 throw 的值归一成 `{ message, stack }`。
|
|
47
|
+
* `loader/src/worker.ts` 需要把日志 `postMessage` 回 daemon 进程而不是写 stdout,
|
|
48
|
+
* 用一个带 `write()` 的对象即可。
|
|
80
49
|
*
|
|
81
|
-
*
|
|
82
|
-
* 直接 `error.message` 会拿到 `undefined`。
|
|
50
|
+
* @param source - 日志来源标签,含义同 {@link createPipelineLogger}。
|
|
83
51
|
*/
|
|
84
|
-
declare function
|
|
85
|
-
message: string;
|
|
86
|
-
|
|
87
|
-
};
|
|
52
|
+
declare function createPipelineLoggerWithStream(stream: {
|
|
53
|
+
write(message: string): void;
|
|
54
|
+
}, level?: string, source?: string): Logger;
|
|
88
55
|
//#endregion
|
|
89
|
-
//#region src/
|
|
90
|
-
type PreviewableId = {
|
|
91
|
-
filePath: string;
|
|
92
|
-
name: string;
|
|
93
|
-
};
|
|
56
|
+
//#region src/own-version.d.ts
|
|
94
57
|
/**
|
|
95
|
-
*
|
|
58
|
+
* 读「当前这个包」的版本号,供框架插件填 `info.version` 用。
|
|
96
59
|
*
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
}): string;
|
|
106
|
-
/**
|
|
107
|
-
* 解码可预览 ID。
|
|
60
|
+
* 为什么需要它:插件的 `info.version` 参与**组件扫描缓存的目录名**(见
|
|
61
|
+
* `core/src/caching.ts` 的 `getScanCacheDir`)。缓存只按文件 mtime 判断要不要重新分析,
|
|
62
|
+
* 于是「插件分析能力变了、源码没改」时旧结果会被永久复用 —— 升级完还是扫不出组件,
|
|
63
|
+
* 用户只能手动删 `node_modules/.cfp`。带上版本号,升级即换目录。
|
|
64
|
+
*
|
|
65
|
+
* 版本号从**调用方模块的位置**向上找 `package.json`(`<pkg>/dist/index.mjs` → `<pkg>`),
|
|
66
|
+
* 不拼死相对路径,也不依赖 `exports` 是否开放 `./package.json` 子路径 ——
|
|
67
|
+
* 安装态是 pnpm 的软链结构,路径形状不可假设。
|
|
108
68
|
*
|
|
109
|
-
* @param
|
|
110
|
-
* @returns
|
|
111
|
-
* @throws 如果 ID 格式无效(不包含冒号),则抛出错误。
|
|
69
|
+
* @param moduleUrl - 调用方传 `import.meta.url`。
|
|
70
|
+
* @returns 版本号字符串;解析失败返回 `"unknown"`(不抛错 —— 它只影响缓存分区粒度)。
|
|
112
71
|
*/
|
|
113
|
-
declare function
|
|
72
|
+
declare function readOwnVersion(moduleUrl: string): string;
|
|
114
73
|
//#endregion
|
|
115
74
|
//#region src/special-types.d.ts
|
|
116
75
|
type SpecialTypes = Record<string, ValueType>;
|
|
@@ -139,4 +98,4 @@ type WrapperLanguage = "tsx" | "jsx" | "vue" | "svelte" | "ts" | "js";
|
|
|
139
98
|
/** 默认 wrapper 路径:`__previewjs__/Wrapper.<language>`。 */
|
|
140
99
|
declare function wrapperPathFor(language: WrapperLanguage): string;
|
|
141
100
|
//#endregion
|
|
142
|
-
export { Analyzer, AnalyzerFactory, AnalyzerOptions, BasePreviewable, BasicComponent, Component, ComponentAnalysis, ERROR_PANEL_ATTRIBUTE, ERROR_PANEL_ID, FileSourcePosition, PreviewableId, RenderErrorPanelOptions, SpecialTypes, Story, StoryAnalysis, StoryArgs, WrapperLanguage, clearErrorPanel, decodePreviewableId, defineSpecialTypes, describeError, generatePreviewableId, isErrorPanelVisible, mergeSpecialTypes, renderErrorPanel, wrapperPathFor };
|
|
101
|
+
export { Analyzer, AnalyzerFactory, AnalyzerOptions, BasePreviewable, BasicComponent, Component, ComponentAnalysis, DEFAULT_LOG_LEVEL, ERROR_PANEL_ATTRIBUTE, ERROR_PANEL_ID, FileSourcePosition, PreviewableId, RenderErrorPanelOptions, SpecialTypes, Story, StoryAnalysis, StoryArgs, WrapperLanguage, clearErrorPanel, createPipelineLogger, createPipelineLoggerWithStream, decodePreviewableId, defineSpecialTypes, describeError, generatePreviewableId, isErrorPanelVisible, mergeSpecialTypes, readOwnVersion, renderErrorPanel, resolveLogLevel, wrapperPathFor };
|
package/dist/index.mjs
CHANGED
|
@@ -1,3 +1 @@
|
|
|
1
|
-
|
|
2
|
-
`);return n.length>t?`${n.slice(0,t).join(`
|
|
3
|
-
`)}\n…`:e}function c(e){return`${e.filePath.replace(/\\/g,`/`)}:${e.name}`}function l(e){if(e.lastIndexOf(`:`)===-1)throw Error(`无效的 ID: "${e}"`);let[t,n]=e.split(`:`);return{filePath:t,name:n}}function u(e){return e}function d(...e){let t={};for(let n of e)n&&Object.assign(t,n);return t}function f(e){return`__previewjs__/Wrapper.${e}`}export{e as ERROR_PANEL_ATTRIBUTE,t as ERROR_PANEL_ID,r as clearErrorPanel,l as decodePreviewableId,u as defineSpecialTypes,a as describeError,c as generatePreviewableId,i as isErrorPanelVisible,d as mergeSpecialTypes,n as renderErrorPanel,f as wrapperPathFor};
|
|
1
|
+
import{ERROR_PANEL_ATTRIBUTE as e,ERROR_PANEL_ID as t,clearErrorPanel as n,describeError as r,isErrorPanelVisible as i,renderErrorPanel as a}from"./error-panel.mjs";import{i as o,n as s,r as c,t as l}from"./logging-yGWzkaBD.mjs";import{decodePreviewableId as u,generatePreviewableId as d}from"./previewable-id.mjs";import f from"node:fs";import p from"node:path";import m from"node:url";function h(e){try{let t=p.dirname(m.fileURLToPath(e));for(let e=0;e<5;e++){let e=p.join(t,`package.json`);if(f.existsSync(e))return JSON.parse(f.readFileSync(e,`utf8`)).version??`unknown`;let n=p.dirname(t);if(n===t)break;t=n}return`unknown`}catch{return`unknown`}}function g(e){return e}function _(...e){let t={};for(let n of e)n&&Object.assign(t,n);return t}function v(e){return`__previewjs__/Wrapper.${e}`}export{l as DEFAULT_LOG_LEVEL,e as ERROR_PANEL_ATTRIBUTE,t as ERROR_PANEL_ID,n as clearErrorPanel,s as createPipelineLogger,c as createPipelineLoggerWithStream,u as decodePreviewableId,g as defineSpecialTypes,r as describeError,d as generatePreviewableId,i as isErrorPanelVisible,_ as mergeSpecialTypes,h as readOwnVersion,a as renderErrorPanel,o as resolveLogLevel,v as wrapperPathFor};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import e from"pino";import t from"pino-pretty";const{pino:n}=e,r=t,i=`info`,a=new Set([`fatal`,`error`,`warn`,`info`,`debug`,`trace`,`silent`]);function o(e){let t=(e??process.env.PREVIEWJS_LOG_LEVEL)?.toLowerCase();return t&&a.has(t)?t:i}function s(e,t){return n({level:o(e),...t?{name:t}:{}},r({colorize:!0}))}function c(e,t,r){return n({level:o(t),...r?{name:r}:{}},e)}export{o as i,s as n,c as r,i as t};
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
//#region src/previewable-id.d.ts
|
|
2
|
+
type PreviewableId = {
|
|
3
|
+
filePath: string;
|
|
4
|
+
name: string;
|
|
5
|
+
};
|
|
6
|
+
/**
|
|
7
|
+
* 生成可预览 ID。
|
|
8
|
+
*
|
|
9
|
+
* @param options - 包含文件路径和名称的选项对象。
|
|
10
|
+
* @param options.filePath - 文件的路径。
|
|
11
|
+
* @param options.name - 与文件相关的名称。
|
|
12
|
+
* @returns 生成的可预览 ID,格式为 "文件路径:名称"。
|
|
13
|
+
*/
|
|
14
|
+
declare function generatePreviewableId(options: {
|
|
15
|
+
filePath: string;
|
|
16
|
+
name: string;
|
|
17
|
+
}): string;
|
|
18
|
+
/**
|
|
19
|
+
* 解码可预览 ID。
|
|
20
|
+
*
|
|
21
|
+
* @param id - 要解码的可预览 ID。
|
|
22
|
+
* @returns 包含文件路径和名称的对象。
|
|
23
|
+
* @throws 如果 ID 格式无效(不包含冒号),则抛出错误。
|
|
24
|
+
*/
|
|
25
|
+
declare function decodePreviewableId(id: string): PreviewableId;
|
|
26
|
+
//#endregion
|
|
27
|
+
export { PreviewableId, decodePreviewableId, generatePreviewableId };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
function e(e){return`${e.filePath.replace(/\\/g,`/`)}:${e.name}`}function t(e){if(e.lastIndexOf(`:`)===-1)throw Error(`无效的 ID: "${e}"`);let[t,n]=e.split(`:`);return{filePath:t,name:n}}export{t as decodePreviewableId,e as generatePreviewableId};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cfp-studio/analyzer-api",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.17",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"files": [
|
|
6
6
|
"dist"
|
|
@@ -12,6 +12,18 @@
|
|
|
12
12
|
"import": "./dist/index.mjs",
|
|
13
13
|
"types": "./dist/index.d.mts"
|
|
14
14
|
},
|
|
15
|
+
"./error-panel": {
|
|
16
|
+
"import": "./dist/error-panel.mjs",
|
|
17
|
+
"types": "./dist/error-panel.d.mts"
|
|
18
|
+
},
|
|
19
|
+
"./empty-hint": {
|
|
20
|
+
"import": "./dist/empty-hint.mjs",
|
|
21
|
+
"types": "./dist/empty-hint.d.mts"
|
|
22
|
+
},
|
|
23
|
+
"./previewable-id": {
|
|
24
|
+
"import": "./dist/previewable-id.mjs",
|
|
25
|
+
"types": "./dist/previewable-id.d.mts"
|
|
26
|
+
},
|
|
15
27
|
"./factory": {
|
|
16
28
|
"import": "./dist/factory.mjs",
|
|
17
29
|
"types": "./dist/factory.d.mts"
|
|
@@ -24,9 +36,10 @@
|
|
|
24
36
|
"dependencies": {
|
|
25
37
|
"pino": "9.11.0",
|
|
26
38
|
"pino-pretty": "13.1.1",
|
|
39
|
+
"@cfp-studio/type-analyzer": "10.1.9",
|
|
40
|
+
"@cfp-studio/api": "16.1.2",
|
|
27
41
|
"@cfp-studio/serializable-values": "9.0.8",
|
|
28
|
-
"@cfp-studio/vfs": "2.1.8"
|
|
29
|
-
"@cfp-studio/type-analyzer": "10.1.8"
|
|
42
|
+
"@cfp-studio/vfs": "2.1.8"
|
|
30
43
|
},
|
|
31
44
|
"devDependencies": {
|
|
32
45
|
"typescript": "5.9.3",
|