@opensumi/ide-terminal-next 3.4.5 → 3.4.6-next-1730347271.0

package/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);

package/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';
 

package/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';
 

package/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';
 

package/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 {

package/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 };
 

package/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';
 

package/src/node/pty.ts

@@ -186,8 +186,8 @@ export class PtyService extends Disposable implements IPtyService {
       ) as { [key: string]: string };
     }
 
-    // HACK: 这里的处理逻辑有些黑，后续需要整体去整理下 Shell Intergration，然后整体优化一下
-    // 如果是启动 bash，则使用 init file 植入 Intergration 能力
+    // HACK: 这里的处理逻辑有些黑，后续需要整体去整理下 Shell Integration，然后整体优化一下
+    // 如果是启动 bash，则使用 init file 植入 Integration 能力
     if (options.executable?.includes('bash')) {
       const bashIntegrationPath = await this.shellIntegrationService.initBashInitFile();
       if (!options.args) {
@@ -202,6 +202,18 @@ export class PtyService extends Disposable implements IPtyService {
       }
     }
 
+    // ZSH 相关的能力注入
+    if (options.executable?.includes('zsh')) {
+      const zshDotFilesPath = await this.shellIntegrationService.initZshDotFiles();
+
+      if (!ptyEnv) {
+        ptyEnv = {};
+      }
+
+      ptyEnv['USER_ZDOTDIR'] = ptyEnv['ZDOTDIR'] || os.homedir() || '~';
+      ptyEnv['ZDOTDIR'] = zshDotFilesPath;
+    }
+
     this._ptyOptions['env'] = ptyEnv;
 
     const results = await Promise.all([this._validateCwd(), this._validateExecutable()]);

package/src/node/shell-integration.service.ts

@@ -11,6 +11,9 @@ export interface IShellIntegrationService {
 
   // 获取 Bash 注入文件的 Content 内容
   getBashIntegrationContent(): Promise<string>;
+
+  // 初始化 zsh 注入的配置，并且返回配置的路径
+  initZshDotFiles(): Promise<string>;
 }
 
 // 未来适配 OpenSumi 的时候需要调整
@@ -74,4 +77,129 @@ export class ShellIntegrationService implements IShellIntegrationService {
     await fs.writeFile(bashIntegrationPath, await this.getBashIntegrationContent());
     return bashIntegrationPath;
   }
+
+  // ZSH 的智能化基于 ZDOTDIR 能力运行
+  async initZshDotFiles(): Promise<string> {
+    const zDotDir = path.join(os.tmpdir(), 'sumi-integration-zsh');
+    await this.writeZshConfigShellScripts(zDotDir);
+    return zDotDir;
+  }
+
+  private async writeZshConfigShellScripts(outputDir: string) {
+    // 定义文件内容
+    const shellIntegrationEnv = String.raw`
+if [[ -f $USER_ZDOTDIR/.zshenv ]]; then
+    SUMI_ZDOTDIR=$ZDOTDIR
+    ZDOTDIR=$USER_ZDOTDIR
+
+    # prevent recursion
+    if [[ $USER_ZDOTDIR != $SUMI_ZDOTDIR ]]; then
+        . $USER_ZDOTDIR/.zshenv
+    fi
+
+    USER_ZDOTDIR=$ZDOTDIR
+    ZDOTDIR=$SUMI_ZDOTDIR
+fi
+`;
+
+    const shellIntegrationLogin = String.raw`
+if [[ -f $USER_ZDOTDIR/.zlogin ]]; then
+    ZDOTDIR=$USER_ZDOTDIR
+    . $ZDOTDIR/.zlogin
+fi
+`;
+
+    // 处理 zProfile 的情况，需要临时切回用户的 zshrc 目录配置执行 zProfile，然后记得要切回来，否则 zshrc hack 不生效
+    const shellIntegrationProfile = String.raw`
+if [[ -f $USER_ZDOTDIR/.zprofile ]]; then
+    SUMI_ZDOTDIR=$ZDOTDIR
+    ZDOTDIR=$USER_ZDOTDIR
+    . $USER_ZDOTDIR/.zprofile
+    ZDOTDIR=$SUMI_ZDOTDIR
+fi
+`;
+
+    const shellIntegrationRc = `
+builtin autoload -U add-zsh-hook
+
+if [[ -f $USER_ZDOTDIR/.zshrc ]]; then
+    ZDOTDIR=$USER_ZDOTDIR
+    . $USER_ZDOTDIR/.zshrc
+fi
+
+__is_prompt_start() {
+    builtin printf '\\e]6973;PS\\a'
+}
+
+__is_prompt_end() {
+    builtin printf '\\e]6973;PE\\a'
+}
+
+__is_escape_value() {
+    builtin emulate -L zsh
+
+    # Process text byte by byte, not by codepoint.
+    builtin local LC_ALL=C str="$1" i byte token out=''
+
+    for (( i = 0; i < \${#str}; ++i )); do
+        byte="\${str:$i:1}"
+
+        # Escape backslashes and semi-colons
+        if [ "$byte" = "\\\\" ]; then
+            token="\\\\\\\\"
+        elif [ "$byte" = ";" ]; then
+            token="\\\\x3b"
+        elif [ "$byte" = $'\\n' ]; then
+            token="\\\\x0a"
+        elif [ "$byte" = $'\\e' ]; then
+            token="\\\\x1b"
+        elif [ "$byte" = $'\\a' ]; then
+            token="\\\\x07"
+        else
+            token="$byte"
+        fi
+
+        out+="$token"
+    done
+
+    builtin print -r "$out"
+}
+
+__is_update_cwd() {
+    builtin printf '\\e]6973;CWD;%s\\a' "$(__is_escape_value "\${PWD}")"
+}
+
+__is_update_prompt() {
+    __is_prior_prompt="$PS1"
+    if [[ $ISTERM_TESTING == "1" ]]; then
+        __is_prior_prompt="> "
+    fi
+    PS1="%{\$(__is_prompt_start)%}\$__is_prior_prompt%{\$(__is_prompt_end)%}"
+}
+
+__is_precmd() {
+    if [[ $PS1 != *"\$(__is_prompt_start)"* ]]; then
+        __is_update_prompt
+    fi
+    __is_update_cwd
+}
+
+__is_update_prompt
+add-zsh-hook precmd __is_precmd
+`;
+
+    const files = [
+      { name: '.zshenv', content: shellIntegrationEnv },
+      { name: '.zlogin', content: shellIntegrationLogin },
+      { name: '.zprofile', content: shellIntegrationProfile },
+      { name: '.zshrc', content: shellIntegrationRc },
+    ];
+
+    await fs.mkdir(outputDir, { recursive: true });
+
+    for (const file of files) {
+      const filePath = path.join(outputDir, file.name);
+      await fs.writeFile(filePath, file.content, 'utf-8');
+    }
+  }
 }