forked from alibaba/lowcode-engine
-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathplugin-meta.ts
More file actions
37 lines (31 loc) · 988 Bytes
/
plugin-meta.ts
File metadata and controls
37 lines (31 loc) · 988 Bytes
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
import { IPublicTypePluginDeclaration } from './';
export interface IPublicTypePluginMeta {
/**
* define dependencies which the plugin depends on
*/
dependencies?: string[];
/**
* specify which engine version is compatible with the plugin
*/
engines?: {
/** e.g. '^1.0.0' */
lowcodeEngine?: string;
};
preferenceDeclaration?: IPublicTypePluginDeclaration;
/**
* use 'common' as event prefix when eventPrefix is not set.
* strongly recommend using pluginName as eventPrefix
*
* eg.
* case 1, when eventPrefix is not specified
* event.emit('someEventName') is actually sending event with name 'common:someEventName'
*
* case 2, when eventPrefix is 'myEvent'
* event.emit('someEventName') is actually sending event with name 'myEvent:someEventName'
*/
eventPrefix?: string;
/**
* 如果要使用 command 注册命令，需要在插件 meta 中定义 commandScope
*/
commandScope?: string;
}