@opensumi/ide-core-common 2.21.13 → 2.22.0

package/src/types/editor.ts

@@ -0,0 +1,246 @@
+/* ---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+// Some code copied and modified from https://github.com/microsoft/vscode/blob/1.44.0/src/vs/editor/common/core/position.ts
+
+import type { ILineChange } from '@opensumi/monaco-editor-core/esm/vs/editor/common/services/editorWorker';
+
+export interface IRange {
+  // from 1
+  startLineNumber: number;
+
+  // from 1
+  startColumn: number;
+
+  endLineNumber: number;
+
+  endColumn: number;
+}
+
+export interface ISelection {
+  /**
+   * The line number on which the selection has started.
+   */
+  selectionStartLineNumber: number;
+  /**
+   * The column on `selectionStartLineNumber` where the selection has started.
+   */
+  selectionStartColumn: number;
+  /**
+   * The line number on which the selection has ended.
+   */
+  positionLineNumber: number;
+  /**
+   * The column on `positionLineNumber` where the selection has ended.
+   */
+  positionColumn: number;
+}
+
+/**
+ * A position in the editor. This interface is suitable for serialization.
+ */
+export interface IPosition {
+  /**
+   * line number (starts at 1)
+   */
+  readonly lineNumber: number;
+  /**
+   * column (the first character in a line is between column 1 and column 2)
+   */
+  readonly column: number;
+}
+
+/**
+ * A position in the editor.
+ */
+export class Position {
+  /**
+   * line number (starts at 1)
+   */
+  public readonly lineNumber: number;
+  /**
+   * column (the first character in a line is between column 1 and column 2)
+   */
+  public readonly column: number;
+
+  constructor(lineNumber: number, column: number) {
+    this.lineNumber = lineNumber;
+    this.column = column;
+  }
+
+  /**
+   * Create a new postion from this position.
+   *
+   * @param newLineNumber new line number
+   * @param newColumn new column
+   */
+  with(newLineNumber: number = this.lineNumber, newColumn: number = this.column): Position {
+    if (newLineNumber === this.lineNumber && newColumn === this.column) {
+      return this;
+    } else {
+      return new Position(newLineNumber, newColumn);
+    }
+  }
+
+  /**
+   * Derive a new position from this position.
+   *
+   * @param deltaLineNumber line number delta
+   * @param deltaColumn column delta
+   */
+  delta(deltaLineNumber = 0, deltaColumn = 0): Position {
+    return this.with(this.lineNumber + deltaLineNumber, this.column + deltaColumn);
+  }
+
+  /**
+   * Test if this position equals other position
+   */
+  public equals(other: IPosition): boolean {
+    return Position.equals(this, other);
+  }
+
+  /**
+   * Test if position `a` equals position `b`
+   */
+  public static equals(a: IPosition | null, b: IPosition | null): boolean {
+    if (!a && !b) {
+      return true;
+    }
+    return !!a && !!b && a.lineNumber === b.lineNumber && a.column === b.column;
+  }
+
+  /**
+   * Test if this position is before other position.
+   * If the two positions are equal, the result will be false.
+   */
+  public isBefore(other: IPosition): boolean {
+    return Position.isBefore(this, other);
+  }
+
+  /**
+   * Test if position `a` is before position `b`.
+   * If the two positions are equal, the result will be false.
+   */
+  public static isBefore(a: IPosition, b: IPosition): boolean {
+    if (a.lineNumber < b.lineNumber) {
+      return true;
+    }
+    if (b.lineNumber < a.lineNumber) {
+      return false;
+    }
+    return a.column < b.column;
+  }
+
+  /**
+   * Test if this position is before other position.
+   * If the two positions are equal, the result will be true.
+   */
+  public isBeforeOrEqual(other: IPosition): boolean {
+    return Position.isBeforeOrEqual(this, other);
+  }
+
+  /**
+   * Test if position `a` is before position `b`.
+   * If the two positions are equal, the result will be true.
+   */
+  public static isBeforeOrEqual(a: IPosition, b: IPosition): boolean {
+    if (a.lineNumber < b.lineNumber) {
+      return true;
+    }
+    if (b.lineNumber < a.lineNumber) {
+      return false;
+    }
+    return a.column <= b.column;
+  }
+
+  /**
+   * A function that compares positions, useful for sorting
+   */
+  public static compare(a: IPosition, b: IPosition): number {
+    const aLineNumber = a.lineNumber | 0;
+    const bLineNumber = b.lineNumber | 0;
+
+    if (aLineNumber === bLineNumber) {
+      const aColumn = a.column | 0;
+      const bColumn = b.column | 0;
+      return aColumn - bColumn;
+    }
+
+    return aLineNumber - bLineNumber;
+  }
+
+  /**
+   * Clone this position.
+   */
+  public clone(): Position {
+    return new Position(this.lineNumber, this.column);
+  }
+
+  /**
+   * Convert to a human-readable representation.
+   */
+  public toString(): string {
+    return '(' + this.lineNumber + ',' + this.column + ')';
+  }
+
+  // ---
+
+  /**
+   * Create a `Position` from an `IPosition`.
+   */
+  public static lift(pos: IPosition): Position {
+    return new Position(pos.lineNumber, pos.column);
+  }
+
+  /**
+   * Test if `obj` is an `IPosition`.
+   */
+  public static isIPosition(obj: any): obj is IPosition {
+    return obj && typeof obj.lineNumber === 'number' && typeof obj.column === 'number';
+  }
+}
+
+export interface IEditOperation {
+  range: IRange;
+  text: string;
+}
+
+export interface IEditorDocumentEditChange {
+  changes: IEditOperation[];
+}
+
+export interface IEditorDocumentEOLChange {
+  eol: '\n' | '\r\n';
+}
+
+export type IEditorDocumentChange = IEditorDocumentEditChange | IEditorDocumentEOLChange;
+
+export function isEditChange(change: IEditorDocumentChange): change is IEditorDocumentEditChange {
+  return !!(change as IEditorDocumentEditChange).changes;
+}
+
+export const enum SaveTaskErrorCause {
+  CANCEL = 'cancel',
+  USE_BY_CONTENT = 'useByContent',
+}
+
+export enum SaveTaskResponseState {
+  ERROR = 'error',
+  SUCCESS = 'success',
+  DIFF = 'diff',
+}
+
+export type EditorDocumentModelSaveResultState = SaveTaskResponseState;
+
+export interface IEditorDocumentModelSaveResult {
+  state: EditorDocumentModelSaveResultState;
+
+  errorMessage?: string;
+}
+
+export enum SymbolTag {
+  Deprecated = 1,
+}
+
+export { ILineChange };

package/src/types/extension.ts

@@ -0,0 +1,96 @@
+import { Uri } from '@opensumi/ide-utils';
+
+import { BasicEvent } from '../event-bus';
+
+export class ExtensionCandidate {
+  path: string;
+  isBuiltin: boolean;
+  isDevelopment: boolean;
+}
+
+export enum ExtensionConnectModeOption {
+  'TCP',
+  'IPC',
+}
+
+/**
+ * 插件进程连接时候一些配置选项
+ */
+export interface ExtensionConnectOption {
+  // 两种连接模式参考 nodejs net 模块
+  mode: ExtensionConnectModeOption;
+  // 如果 mode 为 TCP，字段表示套接字应连接到的主机地址，不传默认为'localhost'
+  host?: string;
+}
+
+/**
+ * 插件 browser 层的样式表配置项
+ */
+export interface ExtensionBrowserStyleSheet {
+  componentUri: string;
+  iconfontUri: string;
+}
+
+/**
+ * 将插件路径转换为 ExtensionCandidate 对象
+ * @param extensionPath 插件路径
+ * @param isDevelopment 是否为开发模式下加载的插件
+ */
+export function asExtensionCandidate(extensionPath: string, isDevelopment = false): ExtensionCandidate {
+  return { path: extensionPath, isBuiltin: true, isDevelopment };
+}
+
+export interface JSONType {
+  [key: string]: any;
+}
+
+export interface IExtensionInfo {
+  /**
+   * package.json 里的 publisher.name
+   * 用于插件之前的相互调用
+   */
+  readonly id: string;
+  /**
+   * 插件市场 id
+   */
+  readonly extensionId: string;
+  /**
+   * 是否为内置插件
+   */
+  readonly isBuiltin: boolean;
+
+  /**
+   * 是否为开发模式
+   */
+  readonly isDevelopment?: boolean;
+}
+
+export interface IExtensionProps extends IExtensionInfo {
+  readonly name: string;
+  readonly displayName?: string;
+  readonly activated: boolean;
+  readonly enabled: boolean;
+  readonly packageJSON: JSONType;
+  readonly defaultPkgNlsJSON: JSONType | undefined;
+  readonly packageNlsJSON: JSONType | undefined;
+  readonly path: string;
+  readonly realPath: string;
+  readonly extraMetadata: JSONType;
+  readonly extendConfig: JSONType;
+  readonly enableProposedApi: boolean;
+  readonly isUseEnable: boolean;
+  readonly extensionLocation: Uri;
+  workerVarId?: string;
+  workerScriptPath?: string;
+}
+
+export class ExtensionEnabledEvent extends BasicEvent<IExtensionProps> {}
+
+export interface IExtensionActivateEventPayload {
+  topic: string;
+  data?: any;
+}
+
+export class ExtensionActivateEvent extends BasicEvent<IExtensionActivateEventPayload> {}
+
+export class ExtensionDidContributes extends BasicEvent<void> {}

package/src/types/file-watch.ts

@@ -0,0 +1,100 @@
+import { URI } from '@opensumi/ide-utils';
+export interface IFileSystemWatcherServer {
+  /**
+   * 根据给定参数启动文件监听
+   * 返回对应watcher的id
+   * @param {string} uri
+   * @param {WatchOptions} [options]
+   * @returns {Promise<number>}
+   * @memberof IFileSystemWatcherServer
+   */
+  watchFileChanges(uri: string, options?: WatchOptions): Promise<number>;
+
+  /**
+   * 根据给定watcher的id注销对应的文件监听
+   * @param {number} watcher
+   * @returns {Promise<void>}
+   * @memberof FileSystemWatcherServer
+   */
+  unwatchFileChanges(watcher: number): Promise<void>;
+}
+
+export interface FileSystemWatcherClient {
+  /**
+   * 文件监听下的文件修改时触发事件
+   */
+  onDidFilesChanged(event: DidFilesChangedParams): void;
+}
+
+export interface WatchOptions {
+  excludes: string[];
+}
+
+export interface DidFilesChangedParams {
+  changes: FileChange[];
+}
+
+export interface FileChange {
+  uri: string;
+  type: FileChangeType;
+}
+
+export namespace FileChange {
+  export function isUpdated(change: FileChange, uri: URI): boolean {
+    return change.type === FileChangeType.UPDATED && uri.toString() === change.uri;
+  }
+  export function isAdded(change: FileChange, uri: URI): boolean {
+    return change.type === FileChangeType.ADDED && uri.toString() === change.uri;
+  }
+  export function isDeleted(change: FileChange, uri: URI): boolean {
+    return change.type === FileChangeType.DELETED && URI.file(change.uri).isEqualOrParent(uri);
+  }
+  export function isAffected(change: FileChange, uri: URI): boolean {
+    return isDeleted(change, uri) || uri.toString() === change.uri;
+  }
+  export function isChanged(change: FileChange, uri: URI): boolean {
+    return !isDeleted(change, uri) && uri.toString() === change.uri;
+  }
+}
+
+export type FileChangeEvent = FileChange[];
+export namespace FileChangeEvent {
+  export function isUpdated(event: FileChangeEvent, uri: URI): boolean {
+    return event.some((change) => FileChange.isUpdated(change, uri));
+  }
+  export function isAdded(event: FileChangeEvent, uri: URI): boolean {
+    return event.some((change) => FileChange.isAdded(change, uri));
+  }
+  export function isDeleted(event: FileChangeEvent, uri: URI): boolean {
+    return event.some((change) => FileChange.isDeleted(change, uri));
+  }
+  export function isAffected(event: FileChangeEvent, uri: URI): boolean {
+    return event.some((change) => FileChange.isAffected(change, uri));
+  }
+  export function isChanged(event: FileChangeEvent, uri: URI): boolean {
+    return !isDeleted(event, uri) && event.some((change) => FileChange.isChanged(change, uri));
+  }
+}
+
+export enum FileChangeType {
+  UPDATED = 0,
+  ADDED = 1,
+  DELETED = 2,
+}
+
+export enum VSCFileChangeType {
+  /**
+   * The contents or metadata of a file have changed.
+   */
+  Changed = 1,
+
+  /**
+   * A file has been created.
+   */
+  Created = 2,
+
+  /**
+   * A file has been deleted.
+   */
+  Deleted = 3,
+}

package/src/types/file.ts

@@ -0,0 +1,262 @@
+import { Event, Uri } from '@opensumi/ide-utils';
+
+import { FileChangeEvent } from './file-watch';
+
+export * from './file-watch';
+
+/**
+ * @deprecated please import it from '@opensumi/ide-file-service/lib/common'
+ * `import { IFileServiceClient } from '@opensumi/ide-file-service/lib/common';`
+ */
+export const IFileServiceClient = Symbol('IFileServiceClient');
+
+export interface FileStat {
+  /**
+   * 资源路径
+   */
+  uri: string;
+
+  /**
+   * 资源最后修改时间
+   */
+  lastModification: number;
+
+  /**
+   * 资源的创建时间
+   */
+  createTime?: number;
+
+  /**
+   * 资源是否为文件夹
+   */
+  isDirectory: boolean;
+
+  /**
+   * 资源是否为软连接
+   */
+  isSymbolicLink?: boolean;
+
+  /**
+   * 资源是否在软连接文件夹内
+   */
+  isInSymbolicDirectory?: boolean;
+
+  /**
+   * The children of the file stat.
+   * If it is `undefined` and `isDirectory` is `true`, then this file stat is unresolved.
+   */
+  children?: FileStat[];
+
+  /**
+   * The size of the file if known.
+   */
+  size?: number;
+
+  /**
+   * 同 vscode FileType
+   */
+  type?: FileType;
+
+  /**
+   * 当前文件是否为只读
+   */
+  readonly?: boolean;
+}
+
+export namespace FileStat {
+  export function is(candidate: object | undefined): candidate is FileStat {
+    return (
+      typeof candidate === 'object' &&
+      'uri' in candidate &&
+      'lastModification' in candidate &&
+      'isDirectory' in candidate
+    );
+  }
+
+  export function equals(one: object | undefined, other: object | undefined): boolean {
+    if (!one || !other || !is(one) || !is(other)) {
+      return false;
+    }
+    return (
+      one.uri === other.uri && one.lastModification === other.lastModification && one.isDirectory === other.isDirectory
+    );
+  }
+}
+
+/**
+ * Enumeration of file types. The types `File` and `Directory` can also be
+ * a symbolic links, in that use `FileType.File | FileType.SymbolicLink` and
+ * `FileType.Directory | FileType.SymbolicLink`.
+ */
+export enum FileType {
+  /**
+   * The file type is unknown.
+   */
+  Unknown = 0,
+  /**
+   * A regular file.
+   */
+  File = 1,
+  /**
+   * A directory.
+   */
+  Directory = 2,
+  /**
+   * A symbolic link to a file.
+   */
+  SymbolicLink = 64,
+}
+
+/**
+ * Compatible with vscode.FileSystemProvider
+ */
+export interface FileSystemProvider {
+  readonly capabilities: FileSystemProviderCapabilities;
+  readonly onDidChangeCapabilities: Event<void>;
+
+  readonly readonly?: boolean;
+  /**
+   * An event to signal that a resource has been created, changed, or deleted. This
+   * event should fire for resources that are being [watched](#FileSystemProvider.watch)
+   * by clients of this provider.
+   *
+   * as Event<vscode.FileChangeEvent[]>
+   */
+  readonly onDidChangeFile: Event<FileChangeEvent>;
+
+  /**
+   * Subscribe to events in the file or folder denoted by `uri`.
+   *
+   * The editor will call this function for files and folders. In the latter case, the
+   * options differ from defaults, e.g. what files/folders to exclude from watching
+   * and if subfolders, sub-subfolder, etc. should be watched (`recursive`).
+   *
+   * @param uri The uri of the file to be watched.
+   * @param options Configures the watch.
+   * @returns A disposable that tells the provider to stop watching the `uri`.
+   */
+  watch(uri: Uri, options: { excludes?: string[] }): number | Promise<number>;
+
+  unwatch?(watcherId: number): void | Promise<void>;
+
+  /**
+   * Retrieve metadata about a file.
+   *
+   * Note that the metadata for symbolic links should be the metadata of the file they refer to.
+   * Still, the [SymbolicLink](#FileType.SymbolicLink)-type must be used in addition to the actual type, e.g.
+   * `FileType.SymbolicLink | FileType.Directory`.
+   *
+   * @param uri The uri of the file to retrieve metadata about.
+   * @return The file metadata about the file.
+   * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `uri` doesn't exist.
+   */
+  stat(uri: Uri): Promise<FileStat | void>;
+
+  /**
+   * Retrieve all entries of a [directory](#FileType.Directory).
+   *
+   * @param uri The uri of the folder.
+   * @return An array of name/type-tuples or a thenable that resolves to such.
+   * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `uri` doesn't exist.
+   */
+  readDirectory(uri: Uri): [string, FileType][] | Promise<[string, FileType][]>;
+
+  /**
+   * Create a new directory (Note, that new files are created via `write`-calls).
+   *
+   * @param uri The uri of the new folder.
+   * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when the parent of `uri` doesn't exist, e.g. no mkdirp-logic required.
+   * @throws [`FileExists`](#FileSystemError.FileExists) when `uri` already exists.
+   * @throws [`NoPermissions`](#FileSystemError.NoPermissions) when permissions aren't sufficient.
+   */
+  createDirectory(uri: Uri): void | Promise<void | FileStat>;
+
+  /**
+   * Read the entire contents of a file.
+   *
+   * @param uri The uri of the file.
+   * @return An array of bytes or a thenable that resolves to such.
+   * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `uri` doesn't exist.
+   */
+  readFile(uri: Uri, encoding?: string): Uint8Array | void | Promise<Uint8Array | void>;
+
+  /**
+   * Write data to a file, replacing its entire contents.
+   *
+   * @param uri The uri of the file.
+   * @param content The new content of the file.
+   * @param options Defines if missing files should or must be created.
+   * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `uri` doesn't exist and `create` is not set.
+   * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when the parent of `uri` doesn't exist and `create` is set, e.g. no mkdirp-logic required.
+   * @throws [`FileExists`](#FileSystemError.FileExists) when `uri` already exists, `create` is set but `overwrite` is not set.
+   * @throws [`NoPermissions`](#FileSystemError.NoPermissions) when permissions aren't sufficient.
+   */
+  writeFile(
+    uri: Uri,
+    content: Uint8Array,
+    options: { create: boolean; overwrite: boolean; encoding?: string },
+  ): void | Thenable<void | FileStat>;
+
+  /**
+   * Delete a file.
+   *
+   * @param uri The resource that is to be deleted.
+   * @param options Defines if deletion of folders is recursive.
+   */
+  delete(uri: Uri, options: { recursive: boolean; moveToTrash?: boolean }): void | Promise<void>;
+
+  /**
+   * Rename a file or folder.
+   *
+   * @param oldstring The existing file.
+   * @param newstring The new location.
+   * @param options Defines if existing files should be overwritten.
+   * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `oldstring` doesn't exist.
+   * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when parent of `newstring` doesn't exist, e.g. no mkdirp-logic required.
+   * @throws [`FileExists`](#FileSystemError.FileExists) when `newstring` exists and when the `overwrite` option is not `true`.
+   * @throws [`NoPermissions`](#FileSystemError.NoPermissions) when permissions aren't sufficient.
+   */
+  rename(oldstring: Uri, newstring: Uri, options: { overwrite: boolean }): void | Promise<void | FileStat>;
+}
+
+export const enum FileSystemProviderCapabilities {
+  /**
+   * Provider supports unbuffered read/write.
+   */
+  FileReadWrite = 1 << 1,
+
+  /**
+   * Provider supports open/read/write/close low level file operations.
+   */
+  FileOpenReadWriteClose = 1 << 2,
+
+  /**
+   * Provider supports stream based reading.
+   */
+  FileReadStream = 1 << 4,
+
+  /**
+   * Provider supports copy operation.
+   */
+  FileFolderCopy = 1 << 3,
+
+  /**
+   * Provider is path case sensitive.
+   */
+  PathCaseSensitive = 1 << 10,
+
+  /**
+   * All files of the provider are readonly.
+   */
+  Readonly = 1 << 11,
+
+  /**
+   * Provider supports to delete via trash.
+   */
+  Trash = 1 << 12,
+
+  /**
+   * Provider support to unlock files for writing.
+   */
+  FileWriteUnlock = 1 << 13,
+}