Refactor search constants and improve documentation
- Convert standalone constants to Constants enum with detailed docs - Fix spacing issue in SearchAddon class declaration - Update all references to use Constants enum for consistency
This commit is contained in:
@@ -63,11 +63,32 @@ interface IMultiHighlight extends IDisposable {
|
|||||||
match: ISearchResult;
|
match: ISearchResult;
|
||||||
}
|
}
|
||||||
|
|
||||||
const NON_WORD_CHARACTERS = ' ~!@#$%^&*()+`-=[]{}|\\;:"\',./<>?';
|
/**
|
||||||
const LINES_CACHE_TIME_TO_LIVE = 15 * 1000; // 15 secs
|
* Configuration constants for the search addon functionality.
|
||||||
const DEFAULT_HIGHLIGHT_LIMIT = 1000;
|
*/
|
||||||
|
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 = ' ~!@#$%^&*()+`-=[]{}|\\;:"\',./<>?',
|
||||||
|
|
||||||
export class SearchAddon extends Disposable implements ITerminalAddon , ISearchApi {
|
/**
|
||||||
|
* 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 {
|
||||||
private _terminal: Terminal | undefined;
|
private _terminal: Terminal | undefined;
|
||||||
private _cachedSearchTerm: string | undefined;
|
private _cachedSearchTerm: string | undefined;
|
||||||
private _highlightedLines: Set<number> = new Set();
|
private _highlightedLines: Set<number> = new Set();
|
||||||
@@ -92,7 +113,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
|
|||||||
constructor(options?: Partial<ISearchAddonOptions>) {
|
constructor(options?: Partial<ISearchAddonOptions>) {
|
||||||
super();
|
super();
|
||||||
|
|
||||||
this._highlightLimit = options?.highlightLimit ?? DEFAULT_HIGHLIGHT_LIMIT;
|
this._highlightLimit = options?.highlightLimit ?? Constants.DEFAULT_HIGHLIGHT_LIMIT;
|
||||||
}
|
}
|
||||||
|
|
||||||
public activate(terminal: Terminal): void {
|
public activate(terminal: Terminal): void {
|
||||||
@@ -446,7 +467,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
|
|||||||
}
|
}
|
||||||
|
|
||||||
window.clearTimeout(this._linesCacheTimeoutId);
|
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 {
|
private _destroyLinesCache(): void {
|
||||||
@@ -466,8 +487,8 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
|
|||||||
* @param term the substring that starts at searchIndex
|
* @param term the substring that starts at searchIndex
|
||||||
*/
|
*/
|
||||||
private _isWholeWord(searchIndex: number, line: string, term: string): boolean {
|
private _isWholeWord(searchIndex: number, line: string, term: string): boolean {
|
||||||
return ((searchIndex === 0) || (NON_WORD_CHARACTERS.includes(line[searchIndex - 1]))) &&
|
return ((searchIndex === 0) || (Constants.NON_WORD_CHARACTERS.includes(line[searchIndex - 1]))) &&
|
||||||
(((searchIndex + term.length) === line.length) || (NON_WORD_CHARACTERS.includes(line[searchIndex + term.length])));
|
(((searchIndex + term.length) === line.length) || (Constants.NON_WORD_CHARACTERS.includes(line[searchIndex + term.length])));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
Reference in New Issue
Block a user