-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathindex.ts
More file actions
239 lines (218 loc) · 7.64 KB
/
Copy pathindex.ts
File metadata and controls
239 lines (218 loc) · 7.64 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
import type React from 'react';
import type { Completion } from '@codemirror/autocomplete';
import type { Extension } from '@codemirror/state';
// ── 工具栏按钮 ────────────────────────────────────────────────
/** 工具栏按钮属性 */
export interface ToolbarButtonProps {
/** 按钮内容（支持 ReactNode，可包含图标 + 文字） */
label: React.ReactNode;
/** 鼠标悬停提示文字（原生 title 属性） */
title: string;
/** 按钮背景色 */
backgroundColor?: string;
/** 鼠标悬停时的背景色 */
hoverBackgroundColor?: string;
/** 文字颜色 */
textColor?: string;
/** 边框颜色 */
borderColor?: string;
/** 点击回调 */
onClick: () => void;
/** 是否处于激活状态（可选，激活时使用 hoverBackgroundColor 作为背景色） */
active?: boolean;
}
/** 工具栏自定义按钮项（用于 toolbar 数组） */
export interface ToolbarItem extends ToolbarButtonProps {
/** 唯一标识（React key） */
key: string;
}
// ── 脚本元数据 Schema ──────────────────────────────────────────
/** 函数参数信息 */
export interface ScriptParameterInfo {
// 数据类型
dataType: string;
// 描述信息（可选）
description?: string;
// 参数名称
name: string;
}
/** 函数/方法信息 */
export interface ScriptFunctionInfo {
// 描述信息（可选）
description?: string;
// 函数名称
name: string;
// 参数列表
parameters: ScriptParameterInfo[];
// 返回类型（可选）
returnType?: string;
}
/** 字段/属性信息 */
export interface ScriptFieldInfo {
// 数据类型
dataType: string;
// 描述信息（可选）
description?: string;
// 字段名称
name: string;
}
/** 类型定义 */
export interface ScriptTypeInfo {
// 数据类型名称（如 MyScriptRequest）
dataType: string;
// 描述信息（可选）
description?: string;
// 字段列表
fields: ScriptFieldInfo[];
// 函数列表
functions: ScriptFunctionInfo[];
}
/** 绑定变量信息（如 $request） */
export interface ScriptBindInfo {
// 数据类型
dataType: string;
// 变量名称（如 $request）
name: string;
// 描述信息（可选）
description?: string;
}
/** 请求参数信息（如 request） */
export interface ScriptRequestInfo {
// 数据类型
dataType: string;
// 描述信息（可选）
description?: string;
// 参数名称
name: string;
}
/** 脚本元数据顶层结构 */
export interface ScriptMetadata {
// 绑定变量（如 $request）
binds: ScriptBindInfo[];
// 主函数参数（如 request）
requests: ScriptRequestInfo[];
// 脚本描述信息（可选）
description?: string;
// 主函数名称
mainMethod?: string;
// 主函数返回类型（可选）
returnType?: string;
// 数据类型定义
types: Record<string, ScriptTypeInfo>;
}
// ── 编辑器 Props ──────────────────────────────────────────────
export interface ScriptCodeEditorProps {
/** 代码内容 */
value?: string;
/** 是否只读 */
readonly?: boolean;
/** 代码变化回调 */
onChange?: (value: string) => void;
/** 占位符 */
placeholder?: string;
/**
* 编程语言配置（默认 'groovy'）。
*
* - 传入内置语言名：`'groovy'` | `'javascript'`
* - 传入自定义 `LanguageConfig` 对象以支持其他语言
*
* @example
* // 内置语言
* <ScriptCodeEditor language="javascript" />
*
* // 自定义语言
* <ScriptCodeEditor language={{
* name: 'python',
* displayName: 'Python',
* extension: () => python(),
* keywordSnippets: PYTHON_SNIPPETS,
* syntaxNodeNames: { stringNodes: ['String'], commentNodes: ['LineComment', 'BlockComment'] },
* }} />
*/
language?: string | LanguageConfig;
/** 初始主题（默认 'dark'），编辑器内部管理状态 */
defaultTheme?: 'dark' | 'light';
/** 主题切换通知回调（可选） */
onThemeChange?: (theme: 'dark' | 'light') => void;
/** 标题（可选） */
title?: string;
/** 脚本元数据 — 提供后启用类型面板和自动补全 */
metadata?: ScriptMetadata;
/** 类型面板侧边栏默认是否展开（默认：提供 metadata 时为 true） */
defaultSidebarOpen?: boolean;
// ── 工具栏按钮开关（全部默认 false） ─────────────────────
/** 是否显示主题切换按钮（默认 false） */
enableThemeToggle?: boolean;
/** 是否显示格式化按钮（默认 false，需配合 onFormat 或 language.formatter 使用） */
enableFormat?: boolean;
/** 是否显示编译验证按钮（默认 false，需配合 onCompile 使用） */
enableCompile?: boolean;
/** 是否显示全屏按钮（默认 false） */
enableFullscreen?: boolean;
// ── 按钮回调 ─────────────────────────────────────────────
/** 格式化代码回调（enableFormat 时提供，优先级高于 language.formatter） */
onFormat?: () => void;
/** 编译/测试脚本回调（enableCompile 时需提供） */
onCompile?: (code: string) => void;
// ── 自定义工具栏内容 ──────────────────────────────────────
/** 工具栏自定义按钮列表（渲染在内置按钮之后） */
toolbar?: ToolbarItem[];
/** 工具栏额外内容（渲染在内置按钮之后，任意 React 节点） */
toolbarExtra?: React.ReactNode;
/** 其他选项 */
options?: {
/** 字体大小 */
fontSize?: number;
/** 最小高度 */
minHeight?: number;
/** 最大高度 */
maxHeight?: number;
};
}
// ── 多语言支持 ─────────────────────────────────────────────────
/** 格式化选项 */
export interface FormatOptions {
/** 缩进大小（空格数） */
indentSize?: number;
/** 操作符周围添加空格 */
addSpacesAroundOperators?: boolean;
/** 格式化注释 */
formatComments?: boolean;
/** 最大行长度 */
maxLineLength?: number;
/** 保留空行 */
preserveEmptyLines?: boolean;
}
/** 格式化函数签名 */
export type FormatFn = (code: string, options?: FormatOptions) => string;
/**
* 语言配置接口
*
* 封装一个编程语言在编辑器中所需的全部差异点：
* - CodeMirror 语法高亮扩展
* - 关键字/语法片段
* - AST 节点名（用于判断字符串/注释位置，抑制自动补全）
* - 默认占位符文本
* - 可选的内置格式化器
*/
export interface LanguageConfig {
/** 语言标识名（小写），如 'groovy'、'javascript' */
name: string;
/** 显示名称，如 'Groovy'、'JavaScript' */
displayName: string;
/** CodeMirror 语言扩展工厂 */
extension: () => Extension;
/** 关键字和语法片段列表 */
keywordSnippets: readonly Completion[];
/** 各语言的语法树节点名（用于 isInStringOrComment 判断） */
syntaxNodeNames: {
/** 字符串类节点名，如 Java: ['StringLiteral']，JS: ['String', 'TemplateString'] */
stringNodes: string[];
/** 注释类节点名，如 ['LineComment', 'BlockComment'] */
commentNodes: string[];
};
/** 默认占位符文本 */
placeholder?: string;
/** 可选的内置格式化函数（优先级低于 onFormat prop） */
formatter?: FormatFn;
}