@cfp-studio/analyzer-api 0.1.13 → 0.1.14

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/README.md CHANGED
@@ -30,13 +30,15 @@ analyzer.dispose();
30
30
  ```
31
31
 
32
32
  可预览 ID:
33
+
33
34
  ```ts
34
- import { generatePreviewableId, decodePreviewableId } from '@cfp-studio/analyzer-api';
35
- const id = generatePreviewableId({ filePath: '/src/App.tsx', name: 'App' });
35
+ import { generatePreviewableId, decodePreviewableId } from "@cfp-studio/analyzer-api";
36
+ const id = generatePreviewableId({ filePath: "/src/App.tsx", name: "App" });
36
37
  const { filePath, name } = decodePreviewableId(id);
37
38
  ```
38
39
 
39
40
  ## 依赖
41
+
40
42
  - `@cfp-studio/serializable-values`:可序列化值类型
41
43
  - `@cfp-studio/type-analyzer`:TS 类型分析
42
44
  - `@cfp-studio/vfs`:虚拟文件系统
package/dist/analyzer.mjs CHANGED
@@ -1 +1 @@
1
- import{factoryWithDefaultOptions as e}from"./factory.mjs";import{createTypeAnalyzer as t}from"@cfp-studio/type-analyzer";import n from"node:path";function r(r){return e(({rootDir:e,reader:i,logger:a})=>{let o={rootDir:e,reader:i,logger:a},s=t({rootDir:e,warn:a.warn.bind(a),...r.typeAnalyzerOptions(o)}),c=r.toTypeScriptPath??(e=>e);return{typeAnalyzer:s,crawlFiles:async t=>{let i=t.map(t=>n.isAbsolute(t)?t:n.join(e,t)),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{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};
package/dist/index.d.mts CHANGED
@@ -1,6 +1,58 @@
1
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-3X9rm2RT.mjs";
2
2
  import { ValueType } from "@cfp-studio/type-analyzer";
3
3
 
4
+ //#region src/error-panel.d.ts
5
+ /**
6
+ * 渲染错误面板:在**预览区域内部**显示错误,而不是白屏(`docs/todo/39`)。
7
+ *
8
+ * ## 为什么放在这里(`analyzer-api`)
9
+ *
10
+ * 5 个框架插件(react / vue3 / svelte / solid / preact)**都依赖本包**,
11
+ * 且都面临同一个问题:「被预览组件抛错 → 整片白屏,用户只知道坏了,不知道为什么」。
12
+ *
13
+ * 各插件各写一份错误 UI 会重复且容易漂移;这里用**纯 DOM**实现,
14
+ * 不引入任何框架依赖,因此 5 个插件都能直接用。
15
+ *
16
+ * ## 设计约束
17
+ *
18
+ * 1. **内联样式**:面板渲染在用户页面的 `#root` 里,会继承用户的全局 CSS
19
+ * (Umi / antd 的 reset 等)。用内联样式避免被覆盖。
20
+ * 2. **不污染 Runtime Tree**:面板元素带 `data-preview-error-panel`,
21
+ * `iframe` 的 `runtime-bridge.walk()` 会跳过它 —— 否则错误面板会出现在组件树里。
22
+ * 3. **不写源码、不发网络**:纯本地渲染。
23
+ */
24
+ interface RenderErrorPanelOptions {
25
+ /** 错误本体(`Error` 或任何被 throw 的值)。 */
26
+ error: unknown;
27
+ /** 被预览的可预览项名称(如 `Button`、`Default`),用于标题。 */
28
+ previewableName?: string;
29
+ /**
30
+ * React / Preact 的 `componentStack`,能指出**哪个组件**抛的错。
31
+ * 其它框架可为空。
32
+ */
33
+ componentStack?: string | null;
34
+ }
35
+ /** 面板元素的标记属性:`runtime-bridge.walk()` 据此跳过。 */
36
+ declare const ERROR_PANEL_ATTRIBUTE = "data-preview-error-panel";
37
+ /**
38
+ * 把错误面板渲染到 `container`(通常是 `#root`)。
39
+ *
40
+ * 返回一个清理函数,移除面板。重复调用会先移除旧面板(同一个 container 只留一个)。
41
+ */
42
+ declare function renderErrorPanel(container: Element, options: RenderErrorPanelOptions): () => void;
43
+ /** 移除 container 里的错误面板(幂等)。 */
44
+ declare function clearErrorPanel(container: Element): void;
45
+ /**
46
+ * 把任意被 throw 的值归一成 `{ message, stack }`。
47
+ *
48
+ * 项目里见过 `throw "字符串"`、`throw { message }` 这类非 Error 值,
49
+ * 直接 `error.message` 会拿到 `undefined`。
50
+ */
51
+ declare function describeError(error: unknown): {
52
+ message: string;
53
+ stack: string | undefined;
54
+ };
55
+ //#endregion
4
56
  //#region src/previewable-id.d.ts
5
57
  type PreviewableId = {
6
58
  filePath: string;
@@ -54,4 +106,4 @@ type WrapperLanguage = "tsx" | "jsx" | "vue" | "svelte" | "ts" | "js";
54
106
  /** 默认 wrapper 路径:`__previewjs__/Wrapper.<language>`。 */
55
107
  declare function wrapperPathFor(language: WrapperLanguage): string;
56
108
  //#endregion
57
- export { Analyzer, AnalyzerFactory, AnalyzerOptions, BasePreviewable, BasicComponent, Component, ComponentAnalysis, FileSourcePosition, PreviewableId, SpecialTypes, Story, StoryAnalysis, StoryArgs, WrapperLanguage, decodePreviewableId, defineSpecialTypes, generatePreviewableId, mergeSpecialTypes, wrapperPathFor };
109
+ export { Analyzer, AnalyzerFactory, AnalyzerOptions, BasePreviewable, BasicComponent, Component, ComponentAnalysis, ERROR_PANEL_ATTRIBUTE, FileSourcePosition, PreviewableId, RenderErrorPanelOptions, SpecialTypes, Story, StoryAnalysis, StoryArgs, WrapperLanguage, clearErrorPanel, decodePreviewableId, defineSpecialTypes, describeError, generatePreviewableId, mergeSpecialTypes, renderErrorPanel, wrapperPathFor };
package/dist/index.mjs CHANGED
@@ -1 +1,3 @@
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}}function n(e){return e}function r(...e){let t={};for(let n of e)n&&Object.assign(t,n);return t}function i(e){return`__previewjs__/Wrapper.${e}`}export{t as decodePreviewableId,n as defineSpecialTypes,e as generatePreviewableId,r as mergeSpecialTypes,i as wrapperPathFor};
1
+ const e=`data-preview-error-panel`;function t(t,i){n(t);let{error:o,previewableName:s,componentStack:c}=i,{message:l,stack:u}=r(o),d=document.createElement(`div`);d.setAttribute(e,``),d.style.cssText=[`position: relative`,`box-sizing: border-box`,`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`,`text-align: left`].join(`;`);let f=document.createElement(`div`);f.style.cssText=`font-size: 14px; font-weight: 600; margin-bottom: 8px`,f.textContent=s?`${s} 渲染失败`:`组件渲染失败`;let p=document.createElement(`pre`);if(p.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(`;`),p.textContent=l,d.appendChild(f),d.appendChild(p),c){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=a(c,12),d.appendChild(e)}if(!c&&u){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=a(u,6),d.appendChild(e)}return t.appendChild(d),()=>{d.remove()}}function n(t){t.querySelectorAll(`[${e}]`).forEach(e=>e.remove())}function r(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:i(e),stack:typeof t.stack==`string`?t.stack:void 0}}return{message:String(e),stack:void 0}}function i(e){try{return JSON.stringify(e)}catch{return String(e)}}function a(e,t){let n=e.split(`
2
+ `);return n.length>t?`${n.slice(0,t).join(`
3
+ `)}\n…`:e}function o(e){return`${e.filePath.replace(/\\/g,`/`)}:${e.name}`}function s(e){if(e.lastIndexOf(`:`)===-1)throw Error(`无效的 ID: "${e}"`);let[t,n]=e.split(`:`);return{filePath:t,name:n}}function c(e){return e}function l(...e){let t={};for(let n of e)n&&Object.assign(t,n);return t}function u(e){return`__previewjs__/Wrapper.${e}`}export{e as ERROR_PANEL_ATTRIBUTE,n as clearErrorPanel,s as decodePreviewableId,c as defineSpecialTypes,r as describeError,o as generatePreviewableId,l as mergeSpecialTypes,t as renderErrorPanel,u as wrapperPathFor};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cfp-studio/analyzer-api",
3
- "version": "0.1.13",
3
+ "version": "0.1.14",
4
4
  "license": "MIT",
5
5
  "files": [
6
6
  "dist"
@@ -24,9 +24,9 @@
24
24
  "dependencies": {
25
25
  "pino": "9.11.0",
26
26
  "pino-pretty": "13.1.1",
27
- "@cfp-studio/type-analyzer": "10.1.8",
28
- "@cfp-studio/vfs": "2.1.6",
29
- "@cfp-studio/serializable-values": "9.0.8"
27
+ "@cfp-studio/vfs": "2.1.8",
28
+ "@cfp-studio/serializable-values": "9.0.8",
29
+ "@cfp-studio/type-analyzer": "10.1.8"
30
30
  },
31
31
  "devDependencies": {
32
32
  "typescript": "5.9.3",