@opensumi/ide-core-common 1.1.4-next-1641353261.0

package/lib/command.d.ts

@@ -0,0 +1,334 @@
+import { MaybePromise } from './async';
+import { ContributionProvider } from './contribution-provider';
+import { Disposable, IDisposable } from './disposable';
+import { IExtensionInfo } from './types';
+declare type InterceptorFunction = (result: any) => MaybePromise<any>;
+export interface Command {
+    /**
+     * 命令 id，全局唯一
+     */
+    id: string;
+    /**
+     * 要在命令面板显示的文案
+     * 支持国际化占位符，例如 %evenEditorGroups%
+     */
+    label?: string;
+    /**
+     * 要在命令面板显示的图标
+     */
+    iconClass?: string;
+    /**
+     * 要在命令面板显示的图标
+     */
+    toogleIconClass?: string;
+    /**
+     * 要在命令面板显示的分组
+     * 支持国际化占位符，例如 %evenEditorGroups%
+     */
+    category?: string;
+    /**
+     * 代理执行的命令
+     */
+    delegate?: string;
+    /**
+     * 在任意语言下都相同的别名
+     */
+    alias?: string;
+    /**
+     * 是否启用该命令，值为 when 表达式
+     * 这个值只影响 UI 是否展示 （命令面板或者菜单）
+     */
+    enablement?: string;
+}
+/**
+ * Command 的工具方法
+ */
+export declare namespace Command {
+    /**
+     * 判断是否是命令
+     * @param arg 要判断的对象
+     */
+    function is(arg: Command | any): arg is Command;
+    /**
+     * 比较两个命令是否相等
+     * 用于命令面板的排序
+     * @param a 待比较的命令
+     * @param b 待比较的命令
+     */
+    function compareCommands(a: Command, b: Command): number;
+}
+/**
+ * 命令处理函数接口
+ */
+export interface CommandHandler<T = any> {
+    /**
+     * 命令执行函数
+     * @param args 传递的参数
+     */
+    execute: T;
+    /**
+     * 命令是否启用
+     * 若为否，则不会被执行到
+     * 并且命令面板也不会显示
+     * @param args 传递的参数
+     */
+    isEnabled?(...args: any[]): boolean;
+    /**
+     * 命令是否可见
+     * 若为否，则不会再命令面板显示
+     * 但是可以被外部执行
+     * @param args 传递的参数
+     */
+    isVisible?(...args: any[]): boolean;
+    /**
+     * 是否可切换
+     * 主要给菜单使用
+     * @param args
+     */
+    isToggled?(...args: any[]): boolean;
+    /**
+     * 获取鉴过权的命令处理函数
+     * @param commandId 命令 id
+     * @param extensionInfo 插件的主要属性
+     * @param args 命令其他参数
+     */
+    isPermitted?(extensionInfo: IExtensionInfo, ...args: any[]): boolean;
+}
+export declare const CommandContribution: unique symbol;
+/**
+ * 命令贡献 Contribution
+ * 其他模块如果要注册命令需要实现该接口，并且把 Symbol 定义加入 Domain
+ */
+export interface CommandContribution {
+    /**
+     * 注册命令
+     */
+    registerCommands(commands: CommandRegistry): void;
+}
+export declare type PreCommandInterceptor = (command: string, args: any[]) => MaybePromise<any[]>;
+export declare type PostCommandInterceptor = (command: string, result: any) => MaybePromise<any>;
+export declare const CommandService: unique symbol;
+export declare const CommandRegistry: unique symbol;
+export declare const HANDLER_NOT_FOUND = "HANDLER_NOT_FOUND";
+/**
+ * 命令执行模块
+ */
+export interface CommandService {
+    executeCommand<T>(commandId: string, ...args: any[]): Promise<T | undefined>;
+    /**
+     * 执行命令将报错 catch 并 log 输出
+     */
+    tryExecuteCommand<T>(commandId: string, ...args: any[]): Promise<T | undefined>;
+}
+/**
+ * 命令注册和管理模块
+ */
+interface CoreCommandRegistry {
+    /**
+     * 注册命令
+     * @param command 要注册的命令
+     * @param handler 要绑定的执行函数，可延后添加
+     * @returns 销毁命令的方法
+     */
+    registerCommand<T = any>(command: Command, handler?: CommandHandler<T>): IDisposable;
+    /**
+     * 解绑命令
+     * @param commandOrId 要解绑命令或命令 id
+     */
+    unregisterCommand(commandOrId: Command | string): void;
+    /**
+     * 给命令注册处理函数
+     * 可以给命令加多个处理函数
+     * @param commandId 要添加的命令 id
+     * @param handler 要添加的处理函数
+     */
+    registerHandler<T = any>(commandId: string, handler: CommandHandler<T>): IDisposable;
+    /**
+     * 通过命令 id 获取命令
+     * @param commandId 命令 id
+     */
+    getCommand(commandId: string): Command | undefined;
+    getRawCommand(commandId: string): Command | undefined;
+    /**
+     * 获取所有命令
+     */
+    getCommands(): Command[];
+    /**
+     * 判断命令是否启用
+     * @param commandId 命令 id
+     * @param args 传递参数
+     */
+    isEnabled(commandId: string, ...args: any[]): boolean;
+    /**
+     * 判断命令是否可见
+     * @param commandId 命令 id
+     * @param args 传递参数
+     */
+    isVisible(commandId: string, ...args: any[]): boolean;
+    /**
+     * 判断命令是否可切换
+     * @param commandId 命令 id
+     */
+    isToggled(commandId: string, ...args: any[]): boolean;
+    /**
+     * 判断命令是否启用
+     * @param commandId 命令 id
+     * @param args
+     */
+    getActiveHandler(commandId: string, ...args: any[]): CommandHandler | undefined;
+    /**
+     * 获取最近使用的命令列表
+     */
+    getRecentCommands(): Command[];
+    /**
+     * 设置最近使用的命令列表
+     */
+    setRecentCommands(commands: Command[]): Command[];
+    beforeExecuteCommand(interceptor: PreCommandInterceptor): IDisposable;
+    afterExecuteCommand(interceptor: string | PostCommandInterceptor, result?: InterceptorFunction): IDisposable;
+    /**
+     * 是否是通过鉴过权的命令
+     * @param commandId
+     * @param extensionInfo
+     * @param args
+     */
+    isPermittedCommand(commandId: string, extensionInfo: IExtensionInfo, ...args: any[]): boolean;
+}
+export interface CommandRegistry extends CoreCommandRegistry {
+    /**
+     * 从 ContributionProvide 中拿到执行命令 Contributuon
+     * 执行注册操作
+     */
+    initialize(): void;
+}
+export declare class CoreCommandRegistryImpl implements CoreCommandRegistry {
+    protected readonly _commands: {
+        [id: string]: Command;
+    };
+    protected readonly _handlers: {
+        [id: string]: CommandHandler[];
+    };
+    protected readonly unregisterCommands: Map<string, Disposable>;
+    protected readonly _recent: Command[];
+    readonly preCommandInterceptors: PreCommandInterceptor[];
+    readonly postCommandInterceptors: PostCommandInterceptor[];
+    private readonly postCommandInterceptor;
+    /**
+     * 命令执行方法
+     * @param commandId 命令执行方法
+     * @param args
+     */
+    executeCommand<T>(commandId: string, ...args: any[]): Promise<T | undefined>;
+    /**
+     * 获取所有命令
+     */
+    getCommands(): Command[];
+    /**
+     * 注册命令，命令不能重复注册
+     * @param command
+     * @param handler
+     * @returns 命令销毁函数
+     */
+    registerCommand<T>(command: Command, handler?: CommandHandler<T>): IDisposable;
+    /**
+     * 解绑命令
+     * @param command 命令
+     */
+    unregisterCommand(command: Command): void;
+    /**
+     * 给命令注册处理函数
+     * 可以给命令加多个处理函数
+     * 默认后面注册的优先级更高
+     * @param commandId 要添加的命令 id
+     * @param handler 要添加的处理函数
+     * @returns 销毁函数
+     */
+    registerHandler<T>(commandId: string, handler: CommandHandler<T>): IDisposable;
+    /**
+     * 判断命令是否启用
+     * @param commandId 命令 id
+     * @param args 传递参数
+     */
+    isEnabled(command: string, ...args: any[]): boolean;
+    /**
+     * 判断命令是否可见
+     * @param commandId 命令 id
+     * @param args 传递参数
+     */
+    isVisible(command: string, ...args: any[]): boolean;
+    /**
+     * 是否可切换
+     * 主要给菜单使用
+     * @param commandId 命令 id
+     * @param args 传递参数
+     */
+    isToggled(command: string, ...args: any[]): boolean;
+    /**
+     * 获取可见的命令处理函数
+     * @param commandId 命令 id
+     * @param args 传递参数
+     */
+    protected getVisibleHandler(commandId: string, ...args: any[]): CommandHandler | undefined;
+    /**
+     * 获取启用的命令处理函数
+     * @param commandId 命令 id
+     * @param args
+     */
+    getActiveHandler(commandId: string, ...args: any[]): CommandHandler | undefined;
+    /**
+     * 获取鉴过权的命令处理函数
+     * @param commandId 命令 id
+     * @param extensionInfo 插件的主要属性
+     * @param args 命令其他参数
+     */
+    isPermittedCommand(commandId: string, extensionInfo: IExtensionInfo, ...args: any[]): boolean;
+    /**
+     * 获取可切换的命令处理函数
+     * @param commandId 命令 id
+     */
+    protected getToggledHandler(commandId: string): CommandHandler | undefined;
+    /**
+     * 解决语言包未加载时注册命令时没有 label/category 的场景
+     * 使用方需要自定处理 i18n 问题
+     */
+    getRawCommand(id: string): Command | undefined;
+    /**
+     * 通过命令 id 获取命令
+     * @param commandId 命令 id
+     */
+    getCommand(id: string): Command | undefined;
+    /**
+     * 给命令添加销毁函数
+     * @param command 要添加销毁函数的命令
+     */
+    protected doRegisterCommand(command: Command): IDisposable;
+    beforeExecuteCommand(interceptor: PreCommandInterceptor): IDisposable;
+    afterExecuteCommand(command: string, result: InterceptorFunction): any;
+    /**
+     * 获取最近使用的命令列表
+     */
+    getRecentCommands(): Command[];
+    /**
+     * 获取最近使用的命令列表
+     */
+    setRecentCommands(commands: Command[]): Command[];
+    /**
+     * 添加一个命令到最近使用列表中
+     * @param recent 待添加的命令
+     */
+    protected addRecentCommand(recent: Command): void;
+}
+export declare class CommandRegistryImpl extends CoreCommandRegistryImpl implements CommandRegistry {
+    protected readonly contributionProvider: ContributionProvider<CommandContribution>;
+    /**
+     * 执行 CommandContribution 的注册方法
+     */
+    initialize(): void;
+}
+export declare class CommandServiceImpl implements CommandService {
+    private commandRegistry;
+    executeCommand<T>(commandId: string, ...args: any[]): Promise<T | undefined>;
+    tryExecuteCommand<T>(commandId: string, ...args: any[]): Promise<T | undefined>;
+}
+export {};
+//# sourceMappingURL=command.d.ts.map

package/lib/command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.d.ts","sourceRoot":"","sources":["../src/command.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAGvD,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC,aAAK,mBAAmB,GAAG,CAAC,MAAM,EAAE,GAAG,KAAK,YAAY,CAAC,GAAG,CAAC,CAAC;AAE9D,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,yBAAiB,OAAO,CAAC;IACvB;;;OAGG;IACH,SAAgB,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,GAAG,GAAG,IAAI,OAAO,CAErD;IAED;;;;;OAKG;IACH,SAAgB,eAAe,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,MAAM,CAQ9D;CACF;AAED;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,GAAG;IACrC;;;OAGG;IACH,OAAO,EAAE,CAAC,CAAC;IACX;;;;;OAKG;IACH,SAAS,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IACpC;;;;;OAKG;IACH,SAAS,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IACpC;;;;OAIG;IACH,SAAS,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IACpC;;;;;OAKG;IACH,WAAW,CAAC,CAAC,aAAa,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;CACtE;AAED,eAAO,MAAM,mBAAmB,eAAgC,CAAC;AAEjE;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,gBAAgB,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI,CAAC;CACnD;AAED,oBAAY,qBAAqB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,YAAY,CAAC,GAAG,EAAE,CAAC,CAAC;AAC1F,oBAAY,sBAAsB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,YAAY,CAAC,GAAG,CAAC,CAAC;AAEzF,eAAO,MAAM,cAAc,eAA2B,CAAC;AACvD,eAAO,MAAM,eAAe,eAA4B,CAAC;AAEzD,eAAO,MAAM,iBAAiB,sBAAsB,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,cAAc,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAC7E;;OAEG;IACH,iBAAiB,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;CACjF;AACD;;GAEG;AACH,UAAU,mBAAmB;IAC3B;;;;;OAKG;IACH,eAAe,CAAC,CAAC,GAAG,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC;IACrF;;;OAGG;IACH,iBAAiB,CAAC,WAAW,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;IACvD;;;;;OAKG;IACH,eAAe,CAAC,CAAC,GAAG,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC;IACrF;;;OAGG;IACH,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IACnD,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IACtD;;OAEG;IACH,WAAW,IAAI,OAAO,EAAE,CAAC;IAEzB;;;;OAIG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IACtD;;;;OAIG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IACtD;;;OAGG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IACtD;;;;OAIG;IACH,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,cAAc,GAAG,SAAS,CAAC;IAChF;;OAEG;IACH,iBAAiB,IAAI,OAAO,EAAE,CAAC;IAC/B;;OAEG;IACH,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC;IAElD,oBAAoB,CAAC,WAAW,EAAE,qBAAqB,GAAG,WAAW,CAAC;IAEtE,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,sBAAsB,EAAE,MAAM,CAAC,EAAE,mBAAmB,GAAG,WAAW,CAAC;IAC7G;;;;;OAKG;IACH,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;CAC/F;AAED,MAAM,WAAW,eAAgB,SAAQ,mBAAmB;IAC1D;;;OAGG;IACH,UAAU,IAAI,IAAI,CAAC;CACpB;AAGD,qBACa,uBAAwB,YAAW,mBAAmB;IACjE,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAM;IAC7D,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,EAAE,CAAA;KAAE,CAAM;IAEtE,SAAS,CAAC,QAAQ,CAAC,kBAAkB,0BAAiC;IAEtE,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,CAAM;IAE3C,SAAgB,sBAAsB,EAAE,qBAAqB,EAAE,CAAM;IAErE,SAAgB,uBAAuB,EAAE,sBAAsB,EAAE,CAAM;IAEvE,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAGnC;IAEJ;;;;OAIG;IACG,cAAc,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAsClF;;OAEG;IACH,WAAW,IAAI,OAAO,EAAE;IAIxB;;;;;OAKG;IACH,eAAe,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,WAAW;IAkB9E;;;OAGG;IACH,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAazC;;;;;;;OAOG;IACH,eAAe,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,WAAW;IAgB9E;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;IASnD;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;IASnD;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;IAKnD;;;;OAIG;IACH,SAAS,CAAC,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,cAAc,GAAG,SAAS;IAY1F;;;;OAIG;IACH,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,cAAc,GAAG,SAAS;IAgB/E;;;;;OAKG;IACH,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;IAY7F;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAY1E;;;OAGG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAK9C;;;OAGG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAW3C;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW;IASnD,oBAAoB,CAAC,WAAW,EAAE,qBAAqB,GAAG,WAAW;IAYrE,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB;IAiCvE;;OAEG;IACH,iBAAiB;IAIjB;;OAEG;IACH,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE;IAOrC;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;CAalD;AAED,qBACa,mBAAoB,SAAQ,uBAAwB,YAAW,eAAe;IAEzF,SAAS,CAAC,QAAQ,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;IAEnF;;OAEG;IACH,UAAU,IAAI,IAAI;CAMnB;AAED,qBACa,kBAAmB,YAAW,cAAc;IAEvD,OAAO,CAAC,eAAe,CAAsB;IAE7C,cAAc,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAItE,iBAAiB,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;CAQtF"}