chore: update xterm imports to use @xterm/xterm package (#4036) (#4068)

nxps · web-flow · commit c4bf2ff6f961 · 2024-10-10T18:06:08.000+08:00
diff --git a/packages/ai-native/package.json b/packages/ai-native/package.json
@@ -37,13 +37,13 @@
     "@opensumi/ide-theme": "workspace:*",
     "@opensumi/ide-utils": "workspace:*",
     "@opensumi/ide-workspace": "workspace:*",
+    "@xterm/xterm": "5.5.0",
     "ansi-regex": "^2.0.0",
     "dom-align": "^1.7.0",
     "js-tiktoken": "1.0.12",
     "react-chat-elements": "^12.0.10",
     "react-highlight": "^0.15.0",
-    "web-tree-sitter": "0.22.6",
-    "xterm": "5.3.0"
+    "web-tree-sitter": "0.22.6"
   },
   "devDependencies": {
     "@opensumi/ide-core-browser": "workspace:*"
diff --git a/packages/ai-native/src/browser/contrib/terminal/ai-terminal.service.ts b/packages/ai-native/src/browser/contrib/terminal/ai-terminal.service.ts
@@ -1,4 +1,4 @@
-import { IMarker } from 'xterm';
+import { IMarker } from '@xterm/xterm';
 
 import { Autowired, Injectable } from '@opensumi/di';
 import { AIActionItem } from '@opensumi/ide-core-browser/lib/components/ai-native';
diff --git a/packages/ai-native/src/browser/contrib/terminal/decoration/terminal-decoration.tsx b/packages/ai-native/src/browser/contrib/terminal/decoration/terminal-decoration.tsx
@@ -1,6 +1,6 @@
+import { IDecoration, IMarker, Terminal } from '@xterm/xterm';
 import React from 'react';
 import { Root, createRoot } from 'react-dom/client';
-import { IDecoration, IMarker, Terminal } from 'xterm';
 
 import { Autowired, Injectable } from '@opensumi/di';
 import { AIActionItem } from '@opensumi/ide-core-browser/lib/components/ai-native';
diff --git a/packages/ai-native/src/browser/contrib/terminal/ps1-terminal.service.tsx b/packages/ai-native/src/browser/contrib/terminal/ps1-terminal.service.tsx
@@ -1,7 +1,7 @@
+import { IDecoration, IDisposable, IMarker, Terminal } from '@xterm/xterm';
 import domAlign from 'dom-align';
 import React from 'react';
 import { Root, createRoot } from 'react-dom/client';
-import { IDecoration, IDisposable, IMarker, Terminal } from 'xterm';
 
 import { Autowired, Injectable } from '@opensumi/di';
 import { localize } from '@opensumi/ide-core-browser';
diff --git a/packages/terminal-next/__tests__/browser/client.test.ts b/packages/terminal-next/__tests__/browser/client.test.ts
@@ -21,7 +21,7 @@ import { injector } from './inject';
 import { createProxyServer, createWsServer } from './proxy';
 import { createBufferLineArray, delay } from './utils';
 
-import type { ITerminalAddon } from 'xterm';
+import type { ITerminalAddon } from '@xterm/xterm';
 
 function createDOMContainer() {
   const div = document.createElement('div');
@@ -41,13 +41,16 @@ class MockXTermAddonWebgl {
   }
 }
 
-jest.mock('xterm', () => {
+jest.mock('@xterm/xterm', () => {
   const Terminal = class MockXTerminal {
     private _text = '';
     public options = {};
     get cols() {
       return 0;
     }
+    get onLineFeed() {
+      return Event.None;
+    }
     get onResize() {
       return Event.None;
     }
@@ -109,11 +112,11 @@ jest.mock('xterm', () => {
     }
   };
   return {
-    ...jest.requireActual('xterm'),
+    ...jest.requireActual('@xterm/xterm'),
     Terminal,
   };
 });
-jest.mock('xterm-addon-webgl', () => MockXTermAddonWebgl);
+jest.mock('@xterm/addon-webgl', () => MockXTermAddonWebgl);
 
 describe('Terminal Client', () => {
   let client: ITerminalClient;
diff --git a/packages/terminal-next/__tests__/browser/links/protocol-link-provider.test.ts b/packages/terminal-next/__tests__/browser/links/protocol-link-provider.test.ts
@@ -1,6 +1,7 @@
-import { ILink, Terminal } from 'xterm';
+import { ILink, Terminal } from '@xterm/xterm';
+
+import { createBrowserInjector } from '@opensumi/ide-dev-tool/src/injector-helper';
 
-import { createBrowserInjector } from '../../../../../tools/dev-tool/src/injector-helper';
 import { TerminalProtocolLinkProvider } from '../../../src/browser/links/protocol-link-provider';
 
 describe('Workbench - TerminalWebLinkProvider', () => {
diff --git a/packages/terminal-next/__tests__/browser/links/validated-local-link-provider.test.ts b/packages/terminal-next/__tests__/browser/links/validated-local-link-provider.test.ts
@@ -1,8 +1,8 @@
-import { ILink, Terminal } from 'xterm';
+import { ILink, Terminal } from '@xterm/xterm';
 
 import { OperatingSystem, URI } from '@opensumi/ide-core-common';
+import { createBrowserInjector } from '@opensumi/ide-dev-tool/src/injector-helper';
 
-import { createBrowserInjector } from '../../../../../tools/dev-tool/src/injector-helper';
 import { TerminalValidatedLocalLinkProvider } from '../../../src/browser/links/validated-local-link-provider';
 
 const unixLinks = ['/foo', '~/foo', './foo', '../foo', '/foo/bar', '/foo/bar+more', 'foo/bar', 'foo/bar+more'];
diff --git a/packages/terminal-next/__tests__/browser/mock.service.ts b/packages/terminal-next/__tests__/browser/mock.service.ts
@@ -1,5 +1,5 @@
+import { Terminal } from '@xterm/xterm';
 import WebSocket from 'ws';
-import { Terminal } from 'xterm';
 
 import { Injectable } from '@opensumi/di';
 import { WSChannel } from '@opensumi/ide-connection';
diff --git a/packages/terminal-next/__tests__/browser/terminal.hover.manager.test.ts b/packages/terminal-next/__tests__/browser/terminal.hover.manager.test.ts
@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import { IViewportRange, Terminal } from 'xterm';
+import { IViewportRange, Terminal } from '@xterm/xterm';
 
 import { Injector } from '@opensumi/di';
 import { LayoutState } from '@opensumi/ide-core-browser/lib/layout/layout-state';
diff --git a/packages/terminal-next/__tests__/browser/utils.ts b/packages/terminal-next/__tests__/browser/utils.ts
@@ -1,4 +1,4 @@
-import { IBufferCell, IBufferLine } from 'xterm';
+import { IBufferCell, IBufferLine } from '@xterm/xterm';
 
 export async function delay(ms: number) {
   return new Promise<void>((resolve) => {
diff --git a/packages/terminal-next/package.json b/packages/terminal-next/package.json
@@ -22,13 +22,13 @@
     "@opensumi/ide-core-node": "workspace:*",
     "@opensumi/ide-file-service": "workspace:*",
     "@opensumi/ide-utils": "workspace:*",
+    "@xterm/addon-canvas": "0.7.0",
+    "@xterm/addon-fit": "0.10.0",
+    "@xterm/addon-search": "0.15.0",
+    "@xterm/addon-webgl": "0.18.0",
+    "@xterm/xterm": "5.5.0",
     "node-pty": "1.0.0",
-    "os-locale": "^4.0.0",
-    "xterm": "5.3.0",
-    "xterm-addon-canvas": "0.4.0",
-    "xterm-addon-fit": "0.8.0",
-    "xterm-addon-search": "0.12.0",
-    "xterm-addon-webgl": "0.15.0"
+    "os-locale": "^4.0.0"
   },
   "devDependencies": {
     "@opensumi/ide-components": "workspace:*",
diff --git a/packages/terminal-next/src/browser/component/terminal.view.tsx b/packages/terminal-next/src/browser/component/terminal.view.tsx
@@ -19,7 +19,7 @@ import ResizeView, { ResizeDirection } from './resize.view';
 import styles from './terminal.module.less';
 import TerminalWidget from './terminal.widget';
 
-import 'xterm/css/xterm.css';
+import '@xterm/xterm/css/xterm.css';
 
 export default observer(() => {
   const controller = useInjectable<ITerminalController>(ITerminalController);
diff --git a/packages/terminal-next/src/browser/links/base.ts b/packages/terminal-next/src/browser/links/base.ts
@@ -1,6 +1,6 @@
 import { TerminalLink } from './link';
 
-import type { ILink, ILinkProvider } from 'xterm';
+import type { ILink, ILinkProvider } from '@xterm/xterm';
 
 export abstract class TerminalBaseLinkProvider implements ILinkProvider {
   private _activeLinks: TerminalLink[] | undefined;
diff --git a/packages/terminal-next/src/browser/links/external-link-provider-adapter.ts b/packages/terminal-next/src/browser/links/external-link-provider-adapter.ts
@@ -8,7 +8,7 @@ import { convertLinkRangeToBuffer, getXtermLineContent } from './helpers';
 import { TerminalLink } from './link';
 import { XtermLinkMatcherHandler } from './link-manager';
 
-import type { IBufferLine, IViewportRange, Terminal } from 'xterm';
+import type { IBufferLine, IViewportRange, Terminal } from '@xterm/xterm';
 
 /**
  * An adapter to convert a simple external link provider into an internal link provider that
diff --git a/packages/terminal-next/src/browser/links/helpers.ts b/packages/terminal-next/src/browser/links/helpers.ts
@@ -6,7 +6,7 @@
 
 import { IRange } from '@opensumi/ide-core-common/lib/types';
 
-import type { IBuffer, IBufferCellPosition, IBufferLine, IBufferRange, IViewportRange } from 'xterm';
+import type { IBuffer, IBufferCellPosition, IBufferLine, IBufferRange, IViewportRange } from '@xterm/xterm';
 
 export function convertLinkRangeToBuffer(lines: IBufferLine[], bufferWidth: number, range: IRange, startLine: number) {
   const bufferRange: IBufferRange = {
diff --git a/packages/terminal-next/src/browser/links/link-manager.ts b/packages/terminal-next/src/browser/links/link-manager.ts
@@ -1,4 +1,4 @@
-import { ILinkProvider, IViewportRange, Terminal } from 'xterm';
+import { ILinkProvider, IViewportRange, Terminal } from '@xterm/xterm';
 
 import { Autowired, INJECTOR_TOKEN, Injectable, Injector } from '@opensumi/di';
 import { IOpenerService, PreferenceService } from '@opensumi/ide-core-browser';
diff --git a/packages/terminal-next/src/browser/links/link.ts b/packages/terminal-next/src/browser/links/link.ts
@@ -13,7 +13,7 @@ import {
 
 import { convertBufferRangeToViewport } from './helpers';
 
-import type { IBufferRange, ILink, ILinkDecorations, IViewportRange, Terminal } from 'xterm';
+import type { IBufferRange, ILink, ILinkDecorations, IViewportRange, Terminal } from '@xterm/xterm';
 
 // default delay time (ms) for showing tooltip when mouse is over a link
 const DEFAULT_HOVER_DELAY = 500;
diff --git a/packages/terminal-next/src/browser/links/protocol-link-provider.ts b/packages/terminal-next/src/browser/links/protocol-link-provider.ts
@@ -7,7 +7,7 @@ import { TerminalBaseLinkProvider } from './base';
 import { convertLinkRangeToBuffer, getXtermLineContent } from './helpers';
 import { TerminalLink } from './link';
 
-import type { IBufferLine, IViewportRange, Terminal } from 'xterm';
+import type { IBufferLine, IViewportRange, Terminal } from '@xterm/xterm';
 
 @Injectable({ multiple: true })
 export class TerminalProtocolLinkProvider extends TerminalBaseLinkProvider {
diff --git a/packages/terminal-next/src/browser/links/validated-local-link-provider.ts b/packages/terminal-next/src/browser/links/validated-local-link-provider.ts
@@ -16,7 +16,7 @@ import { FOLDER_IN_WORKSPACE_LABEL, FOLDER_NOT_IN_WORKSPACE_LABEL, OPEN_FILE_LAB
 import { XtermLinkMatcherHandler } from './link-manager';
 
 import type { TerminalClient } from '../terminal.client';
-import type { IBufferLine, IViewportRange, Terminal } from 'xterm';
+import type { IBufferLine, IViewportRange, Terminal } from '@xterm/xterm';
 
 const pathPrefix = '(\\.\\.?|\\~)';
 const pathSeparatorClause = '\\/';
diff --git a/packages/terminal-next/src/browser/terminal.addon.ts b/packages/terminal-next/src/browser/terminal.addon.ts
@@ -1,4 +1,4 @@
-import { ITerminalAddon, Terminal } from 'xterm';
+import { ITerminalAddon, Terminal } from '@xterm/xterm';
 
 import { Disposable, Emitter } from '@opensumi/ide-core-common';
 
diff --git a/packages/terminal-next/src/browser/terminal.preference.ts b/packages/terminal-next/src/browser/terminal.preference.ts
@@ -1,5 +1,5 @@
+import { ITerminalOptions } from '@xterm/xterm';
 import pickBy from 'lodash/pickBy';
-import { ITerminalOptions } from 'xterm';
 
 import { Autowired, Injectable } from '@opensumi/di';
 import { PreferenceService } from '@opensumi/ide-core-browser';
diff --git a/packages/terminal-next/src/browser/terminal.theme.ts b/packages/terminal-next/src/browser/terminal.theme.ts
@@ -6,7 +6,7 @@ import { ITerminalTheme } from '../common';
 
 import * as TERMINAL_COLOR from './terminal.color';
 
-import type { ITheme } from 'xterm';
+import type { ITheme } from '@xterm/xterm';
 
 @Injectable()
 export class TerminalTheme extends Themable implements ITerminalTheme {
diff --git a/packages/terminal-next/src/browser/terminal.typeAhead.addon.ts b/packages/terminal-next/src/browser/terminal.typeAhead.addon.ts
@@ -22,7 +22,7 @@ import { CodeTerminalSettingId } from '../common/preference';
 import { Color, RGBA } from './terminal.typeAhead.ext';
 import { IXtermCore, XtermAttributes } from './xterm-private';
 
-import type { IBuffer, IBufferCell, IDisposable, ITerminalAddon, Terminal } from 'xterm';
+import type { IBuffer, IBufferCell, IDisposable, ITerminalAddon, Terminal } from '@xterm/xterm';
 
 export const DEFAULT_LOCAL_ECHO_EXCLUDE: ReadonlyArray<string> = ['vim', 'vi', 'nano', 'tmux'];
 
diff --git a/packages/terminal-next/src/browser/xterm-private.d.ts b/packages/terminal-next/src/browser/xterm-private.d.ts
@@ -5,7 +5,7 @@
 
 /* eslint-disable @typescript-eslint/naming-convention */
 
-import { IBufferCell } from 'xterm';
+import { IBufferCell } from '@xterm/xterm';
 
 export type XtermAttributes = Omit<IBufferCell, 'getWidth' | 'getChars' | 'getCode'> & { clone?(): XtermAttributes };
 
diff --git a/packages/terminal-next/src/browser/xterm.ts b/packages/terminal-next/src/browser/xterm.ts
@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/ban-ts-comment */
-import { ITerminalOptions, ITheme, Terminal } from 'xterm';
-import { FitAddon } from 'xterm-addon-fit';
-import { ISearchOptions, SearchAddon } from 'xterm-addon-search';
+import { FitAddon } from '@xterm/addon-fit';
+import { ISearchOptions, SearchAddon } from '@xterm/addon-search';
+import { ITerminalOptions, ITheme, Terminal } from '@xterm/xterm';
 
 import { Autowired, INJECTOR_TOKEN, Injectable, Injector } from '@opensumi/di';
 import { IClipboardService } from '@opensumi/ide-core-browser';
@@ -26,8 +26,8 @@ import {
   TERMINAL_OVERVIEW_RULER_FIND_MATCH_FOREGROUND_COLOR,
 } from './terminal.color';
 
-import type { CanvasAddon as CanvasAddonType } from 'xterm-addon-canvas';
-import type { WebglAddon as WebglAddonType } from 'xterm-addon-webgl';
+import type { CanvasAddon as CanvasAddonType } from '@xterm/addon-canvas';
+import type { WebglAddon as WebglAddonType } from '@xterm/addon-webgl';
 
 export interface XTermOptions {
   cwd?: string;
@@ -85,7 +85,7 @@ export class XTerm extends Disposable implements IXTerm {
     try {
       if (!this._canvasAddon) {
         // @ts-ignore
-        this._canvasAddon = new (await import('xterm-addon-canvas')).CanvasAddon();
+        this._canvasAddon = new (await import('@xterm/addon-canvas')).CanvasAddon();
       }
 
       this.addDispose(this._canvasAddon);
@@ -104,7 +104,7 @@ export class XTerm extends Disposable implements IXTerm {
     try {
       if (!this._webglAddon) {
         // @ts-ignore
-        this._webglAddon = new (await import('xterm-addon-webgl')).WebglAddon();
+        this._webglAddon = new (await import('@xterm/addon-webgl')).WebglAddon();
       }
 
       this.addDispose(this._webglAddon);
diff --git a/packages/terminal-next/src/common/client.ts b/packages/terminal-next/src/common/client.ts
@@ -1,4 +1,4 @@
-import { Terminal } from 'xterm';
+import { Terminal } from '@xterm/xterm';
 
 import { Deferred, Disposable, Event, IDisposable } from '@opensumi/ide-core-common';
 
diff --git a/packages/terminal-next/src/common/pty.ts b/packages/terminal-next/src/common/pty.ts
@@ -1,6 +1,6 @@
+import { Terminal as XTerm } from '@xterm/xterm';
 import { IPty as INodePty } from 'node-pty';
 import * as pty from 'node-pty';
-import { Terminal as XTerm } from 'xterm';
 
 import { IThemeColor, MaybePromise, OperatingSystem, Uri } from '@opensumi/ide-core-common';
 
diff --git a/packages/terminal-next/src/common/service.ts b/packages/terminal-next/src/common/service.ts
@@ -1,4 +1,4 @@
-import { ITerminalOptions as IXtermTerminalOptions } from 'xterm';
+import { ITerminalOptions as IXtermTerminalOptions } from '@xterm/xterm';
 
 import { IDisposable, OperatingSystem } from '@opensumi/ide-core-common';
 
diff --git a/packages/terminal-next/src/common/theme.ts b/packages/terminal-next/src/common/theme.ts
@@ -1,4 +1,4 @@
-import { ITheme } from 'xterm';
+import { ITheme } from '@xterm/xterm';
 
 export const ITerminalTheme = Symbol('ITerminalTheme');
 export interface ITerminalTheme {
diff --git a/packages/terminal-next/src/common/xterm-private.d.ts b/packages/terminal-next/src/common/xterm-private.d.ts
@@ -1,4 +1,4 @@
-import { IBufferCell } from 'xterm';
+import { IBufferCell } from '@xterm/xterm';
 
 export type XTermAttributes = Omit<IBufferCell, 'getWidth' | 'getChars' | 'getCode'> & { clone?(): XTermAttributes };
 
diff --git a/packages/terminal-next/src/common/xterm.ts b/packages/terminal-next/src/common/xterm.ts
@@ -1,4 +1,4 @@
-import { ITerminalOptions, ITheme, Terminal } from 'xterm';
+import { ITerminalOptions, ITheme, Terminal } from '@xterm/xterm';
 
 import { SupportedOptions } from './preference';
 
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { IMarker } from 'xterm';`
	`1`	`+import { IMarker } from '@xterm/xterm';`
`2`	`2`
`3`	`3`	`import { Autowired, Injectable } from '@opensumi/di';`
`4`	`4`	`import { AIActionItem } from '@opensumi/ide-core-browser/lib/components/ai-native';`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { IBufferCell, IBufferLine } from 'xterm';`
	`1`	`+import { IBufferCell, IBufferLine } from '@xterm/xterm';`
`2`	`2`
`3`	`3`	`export async function delay(ms: number) {`
`4`	`4`	`return new Promise<void>((resolve) => {`