@xterm/addon-search 0.16.0-beta.121 → 0.16.0-beta.123

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xterm/addon-search",
-  "version": "0.16.0-beta.121",
+  "version": "0.16.0-beta.123",
   "author": {
     "name": "The xterm.js authors",
     "url": "https://xtermjs.org/"
@@ -22,7 +22,7 @@
     "start": "node ../../demo/start"
   },
   "peerDependencies": {
-    "@xterm/xterm": "^5.6.0-beta.121"
+    "@xterm/xterm": "^5.6.0-beta.123"
   },
-  "commit": "5c0107462e1c968a22b7dae58edf702d9bd5313e"
+  "commit": "eb1330ca181df394d21070a57b36232c8185df77"
 }

package/src/SearchAddon.ts

@@ -4,28 +4,14 @@
  */
 
 import type { Terminal, IDisposable, ITerminalAddon, IDecoration } from '@xterm/xterm';
-import type { SearchAddon as ISearchApi } from '@xterm/addon-search';
+import type { SearchAddon as ISearchApi, ISearchOptions, ISearchDecorationOptions } from '@xterm/addon-search';
 import { Emitter, Event } from 'vs/base/common/event';
 import { combinedDisposable, Disposable, dispose, MutableDisposable, toDisposable } from 'vs/base/common/lifecycle';
 
-export interface ISearchOptions {
-  regex?: boolean;
-  wholeWord?: boolean;
-  caseSensitive?: boolean;
-  incremental?: boolean;
-  decorations?: ISearchDecorationOptions;
+interface IInternalSearchOptions {
   noScroll?: boolean;
 }
 
-interface ISearchDecorationOptions {
-  matchBackground?: string;
-  matchBorder?: string;
-  matchOverviewRuler: string;
-  activeMatchBackground?: string;
-  activeMatchBorder?: string;
-  activeMatchColorOverviewRuler: string;
-}
-
 export interface ISearchPosition {
   startCol: number;
   startRow: number;
@@ -68,11 +54,32 @@ interface IMultiHighlight extends IDisposable {
   match: ISearchResult;
 }
 
-const NON_WORD_CHARACTERS = ' ~!@#$%^&*()+`-=[]{}|\\;:"\',./<>?';
-const LINES_CACHE_TIME_TO_LIVE = 15 * 1000; // 15 secs
-const DEFAULT_HIGHLIGHT_LIMIT = 1000;
+/**
+ * Configuration constants for the search addon functionality.
+ */
+const enum Constants {
+  /**
+   * Characters that are considered non-word characters for search boundary detection. These
+   * characters are used to determine word boundaries when performing whole-word searches. Includes
+   * common punctuation, symbols, and whitespace characters.
+   */
+  NON_WORD_CHARACTERS = ' ~!@#$%^&*()+`-=[]{}|\\;:"\',./<>?',
+
+  /**
+   * Time-to-live for cached search results in milliseconds. After this duration, cached search
+   * results will be invalidated to ensure they remain consistent with terminal content changes.
+   */
+  LINES_CACHE_TIME_TO_LIVE = 15000,
+
+  /**
+   * Default maximum number of search results to highlight simultaneously. This limit prevents
+   * performance degradation when searching for very common terms that would result in excessive
+   * highlighting decorations.
+   */
+  DEFAULT_HIGHLIGHT_LIMIT = 1000
+}
 
-export class SearchAddon extends Disposable implements ITerminalAddon , ISearchApi {
+export class SearchAddon extends Disposable implements ITerminalAddon, ISearchApi {
   private _terminal: Terminal | undefined;
   private _cachedSearchTerm: string | undefined;
   private _highlightedLines: Set<number> = new Set();
@@ -97,7 +104,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
   constructor(options?: Partial<ISearchAddonOptions>) {
     super();
 
-    this._highlightLimit = options?.highlightLimit ?? DEFAULT_HIGHLIGHT_LIMIT;
+    this._highlightLimit = options?.highlightLimit ?? Constants.DEFAULT_HIGHLIGHT_LIMIT;
   }
 
   public activate(terminal: Terminal): void {
@@ -115,7 +122,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
       this._highlightTimeout = setTimeout(() => {
         const term = this._cachedSearchTerm;
         this._cachedSearchTerm = undefined;
-        this.findPrevious(term!, { ...this._lastSearchOptions, incremental: true, noScroll: true });
+        this.findPrevious(term!, { ...this._lastSearchOptions, incremental: true }, { noScroll: true });
       }, 200);
     }
   }
@@ -142,7 +149,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
    * @param searchOptions Search options.
    * @returns Whether a result was found.
    */
-  public findNext(term: string, searchOptions?: ISearchOptions): boolean {
+  public findNext(term: string, searchOptions?: ISearchOptions, internalSearchOptions?: IInternalSearchOptions): boolean {
     if (!this._terminal) {
       throw new Error('Cannot use addon until it has been loaded');
     }
@@ -154,7 +161,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
       }
     }
 
-    const found = this._findNextAndSelect(term, searchOptions);
+    const found = this._findNextAndSelect(term, searchOptions, internalSearchOptions);
     this._fireResults(searchOptions);
     this._cachedSearchTerm = term;
 
@@ -242,7 +249,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
     return result;
   }
 
-  private _findNextAndSelect(term: string, searchOptions?: ISearchOptions): boolean {
+  private _findNextAndSelect(term: string, searchOptions?: ISearchOptions, internalSearchOptions?: IInternalSearchOptions): boolean {
     if (!this._terminal || !term || term.length === 0) {
       this._terminal?.clearSelection();
       this.clearDecorations();
@@ -307,7 +314,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
     }
 
     // Set selection and scroll if a result was found
-    return this._selectResult(result, searchOptions?.decorations, searchOptions?.noScroll);
+    return this._selectResult(result, searchOptions?.decorations, internalSearchOptions?.noScroll);
   }
   /**
    * Find the previous instance of the term, then scroll to and select it. If it
@@ -316,7 +323,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
    * @param searchOptions Search options.
    * @returns Whether a result was found.
    */
-  public findPrevious(term: string, searchOptions?: ISearchOptions): boolean {
+  public findPrevious(term: string, searchOptions?: ISearchOptions, internalSearchOptions?: IInternalSearchOptions): boolean {
     if (!this._terminal) {
       throw new Error('Cannot use addon until it has been loaded');
     }
@@ -328,7 +335,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
       }
     }
 
-    const found = this._findPreviousAndSelect(term, searchOptions);
+    const found = this._findPreviousAndSelect(term, searchOptions, internalSearchOptions);
     this._fireResults(searchOptions);
     this._cachedSearchTerm = term;
 
@@ -368,7 +375,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
     }
   }
 
-  private _findPreviousAndSelect(term: string, searchOptions?: ISearchOptions): boolean {
+  private _findPreviousAndSelect(term: string, searchOptions?: ISearchOptions, internalSearchOptions?: IInternalSearchOptions): boolean {
     if (!this._terminal) {
       throw new Error('Cannot use addon until it has been loaded');
     }
@@ -433,7 +440,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
     }
 
     // Set selection and scroll if a result was found
-    return this._selectResult(result, searchOptions?.decorations, searchOptions?.noScroll);
+    return this._selectResult(result, searchOptions?.decorations, internalSearchOptions?.noScroll);
   }
 
   /**
@@ -451,7 +458,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
     }
 
     window.clearTimeout(this._linesCacheTimeoutId);
-    this._linesCacheTimeoutId = window.setTimeout(() => this._destroyLinesCache(), LINES_CACHE_TIME_TO_LIVE);
+    this._linesCacheTimeoutId = window.setTimeout(() => this._destroyLinesCache(), Constants.LINES_CACHE_TIME_TO_LIVE);
   }
 
   private _destroyLinesCache(): void {
@@ -471,8 +478,8 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
    * @param term the substring that starts at searchIndex
    */
   private _isWholeWord(searchIndex: number, line: string, term: string): boolean {
-    return ((searchIndex === 0) || (NON_WORD_CHARACTERS.includes(line[searchIndex - 1]))) &&
-      (((searchIndex + term.length) === line.length) || (NON_WORD_CHARACTERS.includes(line[searchIndex + term.length])));
+    return ((searchIndex === 0) || (Constants.NON_WORD_CHARACTERS.includes(line[searchIndex - 1]))) &&
+      (((searchIndex + term.length) === line.length) || (Constants.NON_WORD_CHARACTERS.includes(line[searchIndex + term.length])));
   }
 
   /**