@opensumi/ide-core-browser 2.21.8-rc-1670567192.0 → 2.21.8

package/src/quick-open/index.ts

@@ -1,655 +0,0 @@
-import { observable } from 'mobx';
-import React from 'react';
-
-import type { VALIDATE_TYPE } from '@opensumi/ide-components';
-import type { URI, MaybePromise, IDisposable, Event } from '@opensumi/ide-core-common';
-
-import type { Keybinding } from '../keybinding';
-
-export enum Mode {
-  /**
-   * select 状态时触发
-   */
-  PREVIEW = 0,
-  /**
-   * 鼠标选择或者回车选择会触发
-   */
-  OPEN = 1,
-  /**
-   * 键盘 → 键或者鼠标中键会触发
-   */
-  OPEN_IN_BACKGROUND = 2,
-}
-
-/**
- * 高亮显示的范围
- */
-export interface Highlight {
-  start: number;
-  end: number;
-}
-
-/**
- * QuickOpen 执行的模式
- * @deprecated
- * 该类型使用 monaco-editor-core/esm 中导入的版本
- */
-export { Mode as QuickOpenMode };
-
-export interface IKeyMods {
-  readonly ctrlCmd: boolean;
-  readonly alt: boolean;
-}
-
-export interface QuickTitleButton {
-  iconPath: URI | { light: string | URI; dark: string | URI } | ThemeIcon;
-  icon?: string; // a background image coming from a url
-  iconClass?: string; // a class such as one coming from font awesome
-  tooltip?: string;
-  // undefined 在 QuickTitleBar 中视为为右侧
-  side?: QuickTitleButtonSide;
-}
-
-/**
- * Button for an action in a {@link QuickPick} or {@link InputBox}.
- */
-export interface QuickInputButton {
-  /**
-   * Icon for the button.
-   */
-  readonly iconPath: URI | { light: URI; dark: URI } | ThemeIcon;
-
-  /**
-   * An optional tooltip.
-   */
-  readonly tooltip?: string | undefined;
-
-  /**
-   * a class such as one coming from font awesome
-   */
-  readonly iconClass?: string;
-
-  /**
-   * An optional id for the button.
-   */
-  handle?: number;
-}
-
-export interface IQuickPickItemButtonEvent {
-  button: QuickInputButton;
-  item: {
-    handle: number;
-  };
-}
-
-/**
- * QuickOpen Item 参数
- */
-export interface QuickOpenItemOptions {
-  /**
-   * 屏幕阅读器字段，对应 vscode
-   */
-  tooltip?: string;
-  /**
-   * 标签文案
-   */
-  label?: string;
-  /**
-   * 高亮标签的范围
-   */
-  labelHighlights?: Highlight[];
-  /**
-   * 显示描述
-   */
-  description?: string;
-  /**
-   * 高亮描述的范围
-   */
-  descriptionHighlights?: Highlight[];
-  /**
-   * 显示详情
-   */
-  detail?: string;
-  /**
-   * 描述高亮范围
-   */
-  detailHighlights?: Highlight[];
-  /**
-   * 是否隐藏
-   */
-  hidden?: boolean;
-  /**
-   * 打开资源，对应 vscode getResource
-   */
-  uri?: URI;
-  /**
-   * 图标
-   */
-  iconClass?: string;
-  /**
-   * 对应绑定的快捷键
-   */
-  keybinding?: Keybinding;
-  /**
-   * 分组文案
-   */
-  groupLabel?: string;
-  /**
-   * 是否显示 border
-   */
-  showBorder?: boolean;
-  /**
-   * 是否选中
-   */
-  checked?: boolean;
-  /**
-   * 点击 QuickOpen 要执行的方法
-   * @param mode
-   * @returns 执行后是否要隐藏面板, mode 为 PREVIEW 时不判断该值
-   */
-  run?(mode: Mode): boolean;
-
-  value?: any;
-
-  buttons?: QuickInputButton[];
-}
-
-export class QuickOpenItem {
-  private labelHighlights?: Highlight[];
-
-  private descriptionHighlights?: Highlight[];
-
-  private detailHighlights?: Highlight[];
-
-  @observable
-  public checked = false;
-
-  constructor(protected options: QuickOpenItemOptions) {
-    this.checked = options.checked || false;
-  }
-
-  getTooltip(): string | undefined {
-    return this.options.tooltip || this.getLabel();
-  }
-  getLabel(): string | undefined {
-    return this.options.label;
-  }
-  getLabelHighlights(): Highlight[] {
-    return this.options.labelHighlights || [];
-  }
-  getDescription(): string | undefined {
-    return this.options.description;
-  }
-  getDescriptionHighlights(): Highlight[] | undefined {
-    return this.options.descriptionHighlights;
-  }
-  getDetail(): string | undefined {
-    return this.options.detail;
-  }
-  getDetailHighlights(): Highlight[] | undefined {
-    return this.options.detailHighlights;
-  }
-  isHidden(): boolean {
-    return this.options.hidden || false;
-  }
-  getUri(): URI | undefined {
-    return this.options.uri;
-  }
-  getIconClass(): string | undefined {
-    return this.options.iconClass;
-  }
-  getKeybinding(): Keybinding | undefined {
-    return this.options.keybinding;
-  }
-  setHighlights(labelHighlights?: Highlight[], descriptionHighlights?: Highlight[], detailHighlights?: Highlight[]) {
-    this.labelHighlights = labelHighlights;
-    this.descriptionHighlights = descriptionHighlights;
-    this.detailHighlights = detailHighlights;
-  }
-  getHighlights(): [Highlight[] | undefined, Highlight[] | undefined, Highlight[] | undefined] {
-    return [this.labelHighlights, this.descriptionHighlights, this.detailHighlights];
-  }
-  run(mode: Mode): boolean {
-    if (!this.options.run) {
-      return false;
-    }
-    return this.options.run(mode);
-  }
-  getGroupLabel(): string | undefined {
-    return this.options.groupLabel;
-  }
-  showBorder(): boolean {
-    return this.options.showBorder || false;
-  }
-  getValue(): any {
-    return this.options.value;
-  }
-  getButtons(): QuickInputButton[] {
-    return this.options.buttons || [];
-  }
-}
-
-export enum HideReason {
-  ELEMENT_SELECTED = 0,
-  FOCUS_LOST = 1,
-  CANCELED = 2,
-}
-
-export interface QuickOpenModel {
-  onType(lookFor: string, acceptor: (items: QuickOpenItem[], actionProvider?: QuickOpenActionProvider) => void): void;
-}
-
-export const QuickOpenService = Symbol('QuickOpenService');
-
-export interface QuickOpenService {
-  open(model: QuickOpenModel, options?: QuickOpenOptions): void;
-  hide(reason?: HideReason): void;
-  showDecoration(type: VALIDATE_TYPE): void;
-  hideDecoration(): void;
-  refresh(): void;
-}
-
-export type QuickOpenOptions = Partial<QuickOpenOptions.Resolved>;
-export namespace QuickOpenOptions {
-  export interface FuzzyMatchOptions {
-    /**
-     * 是否开启分离式模糊搜索
-     * 比如 `13` 会匹配到 `123`
-     * 默认: `false`
-     */
-    enableSeparateSubstringMatching?: boolean;
-  }
-  export interface Resolved extends QuickOpenTabOptions {
-    /**
-     * 启用状态
-     */
-    readonly enabled: boolean;
-
-    /**
-     * 显示前缀
-     */
-    readonly prefix: string;
-    /**
-     * 占位符
-     */
-    readonly placeholder: string;
-    readonly valueSelection: [number, number];
-    /**
-     * 关闭回调
-     * @param canceled 是否是取消关闭
-     */
-    onClose(canceled: boolean): void;
-
-    /**
-     * select 状态时触发回调
-     * @param item
-     * @param index
-     */
-    onSelect(item: QuickOpenItem, index: number): void;
-
-    /**
-     * select 状态时触发回调
-     * @param item
-     * @param index
-     */
-    onConfirm(items: QuickOpenItem[]): void;
-    /**
-     * 在输入框修改文字时触发
-     * @param value
-     */
-    onChangeValue: (value: string) => void;
-    /**
-     * 在 quick pick 时监听是否有 modifer 按下
-     */
-    onKeyMods?: (mods: IKeyMods) => void;
-    /**
-     * 是否模糊匹配标签
-     * 使用 vscode filter matchesFuzzy 方法
-     */
-    readonly fuzzyMatchLabel: boolean | FuzzyMatchOptions;
-    /**
-     * 是否模糊匹配详情
-     * 使用 vscode filter matchesFuzzy 方法
-     */
-    readonly fuzzyMatchDetail: boolean | FuzzyMatchOptions;
-    /**
-     * 是否模糊匹配描述
-     * 使用 vscode filter matchesFuzzy 方法
-     */
-    readonly fuzzyMatchDescription: boolean | FuzzyMatchOptions;
-    /**
-     * 是否模糊排序
-     * 使用 vscode filter compareEntries 方法
-     */
-    readonly fuzzySort: boolean;
-    /**
-     * 前缀的截取长度
-     */
-    readonly skipPrefix: number;
-
-    /**
-     * 点击空白处是否收起 QuickOpen
-     */
-    readonly ignoreFocusOut: boolean;
-    /**
-     * 如果为 true，则输入内容会隐藏
-     */
-    readonly password: boolean;
-    /**
-     * 是否为多选
-     */
-    canPickMany?: boolean;
-    /**
-     * 如果没有高亮也显示 item
-     */
-    readonly showItemsWithoutHighlight: boolean;
-
-    selectIndex(lookFor: string): number;
-
-    /**
-     * 结果为空显示的 item，应该用此方法实现空占位，不用 accept，accept 结果可能会被 fuzzy 处理导致高亮
-     */
-    getPlaceholderItem?: (lookFor: string, originLookFor: string) => QuickOpenItem;
-
-    /**
-     * 内容更新后保持滚动区域不变
-     */
-    keepScrollPosition?: boolean;
-  }
-  export const defaultOptions: Resolved = Object.freeze({
-    enabled: true,
-    prefix: '',
-    placeholder: '',
-    onClose: () => {
-      /* no-op*/
-    },
-    onSelect: () => {
-      /* no-op*/
-    },
-    onChangeValue: () => {
-      /* no-op*/
-    },
-    onConfirm: () => {
-      /* no-op*/
-    },
-    valueSelection: [-1, -1] as [number, number],
-    fuzzyMatchLabel: false,
-    fuzzyMatchDetail: false,
-    fuzzyMatchDescription: false,
-    fuzzySort: false,
-    skipPrefix: 0,
-    ignoreFocusOut: false,
-    password: false,
-    showItemsWithoutHighlight: false,
-    selectIndex: () => -1,
-    title: '',
-  });
-  export function resolve(options: QuickOpenOptions = {}, source: Resolved = defaultOptions): Resolved {
-    return Object.assign({}, source, options);
-  }
-}
-
-export interface QuickPickItem<T> {
-  label: string;
-  groupLabel?: string;
-  showBorder?: boolean;
-  value: T;
-  description?: string;
-  detail?: string;
-  iconClass?: string;
-  buttons?: QuickInputButton[];
-}
-
-export interface QuickPickOptions extends QuickOpenOptions {
-  placeholder?: string;
-  /**
-   * default: true
-   */
-  fuzzyMatchLabel?: boolean;
-  /**
-   * default: true
-   */
-  fuzzyMatchDescription?: boolean;
-
-  /**
-   * Current step count
-   */
-  step?: number | undefined;
-
-  /**
-   * The title of the input
-   */
-  title?: string | undefined;
-
-  /**
-   * Total number of steps
-   */
-  totalSteps?: number | undefined;
-
-  /**
-   * Buttons that are displayed on the title panel
-   */
-  buttons?: QuickTitleButton[];
-
-  /**
-   * Set to `true` to keep the input box open when focus moves to another part of the editor or to another window.
-   */
-  ignoreFocusOut?: boolean;
-
-  /**
-   * The prefill value.
-   */
-  value?: string;
-
-  /*
-   * An optional flag to maintain the scroll position of the quick pick when the quick pick items are updated. Defaults to false.
-   */
-  keepScrollPosition?: boolean;
-}
-
-export const QuickPickService = Symbol('QuickPickService');
-
-export interface QuickPickService {
-  show(elements: string[], options?: QuickPickOptions): Promise<string | undefined>;
-  show<T>(elements: QuickPickItem<T>[], options?: QuickPickOptions): Promise<T | undefined>;
-  show<T>(elements: (string | QuickPickItem<T>)[], options?: QuickPickOptions): Promise<T | string | undefined>;
-  hide(reason?: HideReason): void;
-  readonly onDidAccept: Event<void>;
-  readonly onDidChangeActiveItems: Event<QuickOpenItem[]>;
-}
-
-export const PrefixQuickOpenService = Symbol('PrefixQuickOpenService');
-export interface PrefixQuickOpenService {
-  open(prefix: string): void;
-}
-
-export const IQuickInputService = Symbol('IQuickInputService');
-export interface IQuickInputService {
-  open(options?: QuickInputOptions): Promise<string | undefined>;
-  hide(): void;
-}
-
-export interface QuickInputOptions {
-  /**
-   * Show the progress indicator if true
-   */
-  busy?: boolean;
-
-  /**
-   * Allow user input
-   */
-  enabled?: boolean;
-
-  /**
-   * Current step count
-   */
-  step?: number | undefined;
-
-  /**
-   * The title of the input
-   */
-  title?: string | undefined;
-
-  /**
-   * Total number of steps
-   */
-  totalSteps?: number | undefined;
-
-  /**
-   * Buttons that are displayed on the title panel
-   */
-  buttons?: QuickTitleButton[];
-
-  /**
-   * Text for when there is a problem with the current input value
-   */
-  validationMessage?: string | undefined;
-  validationType?: VALIDATE_TYPE;
-  /**
-   * The prefill value.
-   */
-  value?: string;
-
-  /**
-   * The text to display under the input box.
-   */
-  prompt?: string;
-
-  /**
-   * The place holder in the input box to guide the user what to type.
-   */
-  placeHolder?: string;
-
-  /**
-   * Set to `true` to show a password prompt that will not show the typed value.
-   */
-  password?: boolean;
-
-  /**
-   * Set to `true` to keep the input box open when focus moves to another part of the editor or to another window.
-   */
-  ignoreFocusOut?: boolean;
-
-  /**
-   * Selection of the prefilled [`value`](#InputBoxOptions.value). Defined as tuple of two number where the
-   * first is the inclusive start index and the second the exclusive end index. When `undefined` the whole
-   * word will be selected, when empty (start equals end) only the cursor will be set,
-   * otherwise the defined range will be selected.
-   */
-  valueSelection?: [number, number];
-
-  /**
-   * An optional function that will be called to validate input and to give a hint
-   * to the user.
-   *
-   * @param value The current value of the input box.
-   * @return Return `undefined`, or the empty string when 'value' is valid.
-   */
-  validateInput?(value: string): MaybePromise<string | { message: string; type: VALIDATE_TYPE } | null | undefined>;
-}
-
-export interface QuickOpenActionProvider {
-  hasActions(item: QuickOpenItem): boolean;
-  getActions(item: QuickOpenItem): QuickOpenAction[];
-  getValidateInput?(lookFor: string): string;
-}
-
-export interface QuickOpenActionOptions {
-  id: string;
-  label?: string;
-  tooltip?: string;
-  class?: string | undefined;
-  enabled?: boolean;
-  checked?: boolean;
-  radio?: boolean;
-}
-
-export interface QuickOpenAction extends QuickOpenActionOptions, IDisposable {
-  run(item?: QuickOpenItem): Promise<void>;
-}
-
-export enum QuickTitleButtonSide {
-  LEFT = 0,
-  RIGHT = 1,
-}
-
-/**
- * @deprecated
- */
-export class ThemeIcon {
-  static readonly File: ThemeIcon = new ThemeIcon('file');
-
-  static readonly Folder: ThemeIcon = new ThemeIcon('folder');
-
-  private constructor(public id: string) {}
-}
-
-export const QuickOpenContribution = Symbol('QuickOpenContribution');
-
-export interface QuickOpenContribution {
-  registerQuickOpenHandlers(handlers: IQuickOpenHandlerRegistry): void;
-}
-
-export interface QuickOpenHandler {
-  /** 是否是默认的面板处理函数 */
-  default?: boolean;
-  /**
-   * 命令面板中的处理函数
-   */
-  prefix: string;
-  /**
-   * 在帮助面板中显示的描述
-   */
-  description: string;
-  /**
-   * 初始化函数，一般做展示数据的收集
-   */
-  init?(): MaybePromise<void>;
-  /**
-   * 获取 QuickOpenModel，用于提供 Items
-   */
-  getModel(): QuickOpenModel;
-  /**
-   * 获取面板的参数，用于额外设置 QuickOpen
-   */
-  getOptions(): Omit<QuickOpenOptions, keyof QuickOpenTabOptions>;
-  /** quick-open 内部切换不会执行，最终关闭才会执行 */
-  onClose?: (canceled: boolean) => void;
-  /**
-   * 切换时执行
-   */
-  onToggle?: () => void;
-}
-
-export interface QuickOpenTabOptions {
-  /**
-   * render tab
-   */
-  renderTab?(): React.ReactNode;
-  /**
-   * 切换 tab
-   */
-  toggleTab?(): void;
-}
-
-interface QuickOpenTabBase {
-  title: string;
-  order: number;
-  commandId: string;
-  // 不在 Tab 栏展示（但是功能都可以使用，用户按下 tab 时也不会切换到该功能）
-  hideTab?: boolean;
-}
-
-export interface QuickOpenTab extends QuickOpenTabBase {
-  prefix: string;
-}
-
-export interface QuickOpenTabConfig extends QuickOpenTabBase {
-  sub?: Record<string, QuickOpenTabBase>;
-}
-
-export interface IQuickOpenHandlerRegistry {
-  registerHandler(handler: QuickOpenHandler, tab?: QuickOpenTabConfig): IDisposable;
-}
-
-export * from './recent-files';

package/src/quick-open/recent-files.ts

@@ -1,68 +0,0 @@
-import { Injectable, Autowired } from '@opensumi/di';
-import { OnEvent, FileChangeType, IPosition } from '@opensumi/ide-core-common';
-import { WithEventBus } from '@opensumi/ide-core-common/lib/event-bus';
-
-import { RecentStorage } from '../common/common.storage';
-import { FilesChangeEvent } from '../fs';
-
-const OPENED_FILE = 'OPENED_FILE';
-
-const FILES_POSITION = 'OPENED_FILES_POSITION';
-
-@Injectable()
-export class RecentFilesManager extends WithEventBus {
-  @Autowired(RecentStorage)
-  private recentStorage: RecentStorage;
-
-  async updateMostRecentlyOpenedFile(url: string, position: IPosition) {
-    const recentStorage = await this.recentStorage.getScopeStorage();
-    const openedFilesPosition = recentStorage.get<{ [prop: string]: string }>(FILES_POSITION) || {};
-    openedFilesPosition[url] = `#${position.lineNumber},${position.column}`;
-    recentStorage.set(FILES_POSITION, openedFilesPosition);
-  }
-
-  async setMostRecentlyOpenedFile(uriString: string, isDelete?: boolean) {
-    const recentStorage = await this.recentStorage.getScopeStorage();
-
-    let fileList = await this.getMostRecentlyOpenedFiles();
-    const existIdx = fileList.findIndex((file) => file === uriString);
-    if (existIdx > -1) {
-      fileList.splice(existIdx, 1);
-    }
-    if (!isDelete) {
-      fileList.unshift(uriString);
-    }
-
-    // 仅存储50个最近文件
-    if (fileList.length > 50) {
-      fileList = fileList.slice(0, 50);
-    }
-    recentStorage.set(OPENED_FILE, fileList);
-  }
-
-  async getMostRecentlyOpenedFiles(includingRange?: boolean) {
-    const recentStorage = await this.recentStorage.getScopeStorage();
-    const fileList: string[] = recentStorage.get<string[]>(OPENED_FILE) || [];
-    const openedFilesPosition = recentStorage.get<{ [prop: string]: string }>(FILES_POSITION) || {};
-    if (includingRange) {
-      return fileList.map((url) => {
-        if (openedFilesPosition[url]) {
-          return url + openedFilesPosition[url];
-        }
-        return url;
-      });
-    }
-    return fileList;
-  }
-
-  @OnEvent(FilesChangeEvent)
-  protected handleFilesDelete(event: FilesChangeEvent) {
-    event.payload.forEach((change) => {
-      if (change.type === FileChangeType.DELETED) {
-        if (change.uri) {
-          this.setMostRecentlyOpenedFile(change.uri, true);
-        }
-      }
-    });
-  }
-}