react-terminal-viewer-cicd 2.0.4

package/README.md

@@ -0,0 +1,181 @@
+<h1 align="center">
+  react-terminal-viewer
+</h1>
+
+<p align="center">基于 xterm.js 内核的 React 日志组件</p>
+
+<p align="center">
+  <a href="https://gitee.com/oschina/react-terminal-viewer/gitee_go/pipelines"><img src="https://img.shields.io/badge/codecov-20%25-green" data-canonical-src="https://img.shields.io/badge/codecov-20%25-green"/></a>
+  <a href="https://www.npmjs.com/package/react-terminal-viewer">
+    <img src="https://img.shields.io/npm/v/react-terminal-viewer/latest" 
+    data-canonical-src="https://img.shields.io/npm/v/react-terminal-viewer/latest"/>
+  </a>
+  <img src="https://img.shields.io/npm/l/react-terminal-viewer" data-canonical-src="https://img.shields.io/npm/l/react-terminal-viewer"/>
+</p>
+
+![Preview png](https://gitee.com/oschina/react-terminal-viewer/raw/master/docs/preview.png)
+
+## 功能
+
+- 【日志搜索】支持日志搜索，并在输入框实时显示搜索结果；
+- 【日志搜索】支持回车/快捷按钮滚动定位到某一行日志；
+- 【日志搜索】支持变更搜索命中高亮样式；
+- 【日志交互】支持日志置顶，置底；
+- 【日志交互】支持运行中日志自动滚动到底部；
+- 【日志交互】支持选中高亮行，并支持变更高亮样式；
+- 【日志渲染】支持全屏显示；
+- 【日志渲染】支持多种日志组件渲染模式，如自定义关键词高亮渲染，ANSI_escape_code 渲染；
+- 【日志渲染】支持 http 轮询获取日志,支持接口调用重试；
+- 【日志渲染】支持 10W 行以内日志渲染不卡顿；
+- 【日志组件】支持头部组件，实现日志分类的功能；
+- 【日志组件】支持变更组件，如替换置顶，置底图标组件，加载日志组件等；
+- 【日志组件】支持选项可配置式，如请求间隔，高亮模式等；
+- 【日志缓存】使用 `localforage` 缓存已下载的日志，以解决无法查看全量日志的问题；
+- 【日志缓存】支持缓存过期策略的特性，以解决本地缓存可能溢出的问题；
+- 【日志缓存】支持清除缓存，从头开始加载远程日志；
+- 【日志缓存】支持重建缓存时分批写入解决一次行写入过多日志导致崩溃的问题；
+- 【大数据日志】 支持基于 Web Worker 与虚拟 DOM 模式以支持更大的日志数据渲染
+
+## 安装
+
+使用 npm 或 yarn 把这个 package 安装到你的项目依赖中:
+
+```
+npm install react-terminal-viewer
+```
+
+或
+
+```
+yarn add react-terminal-viewer
+```
+
+## 使用
+
+```tsx
+import React, { useRef } from 'react';
+import TerminalViewer from 'react-terminal-viewer';
+export default () => {
+  const ref = useRef();
+  const data = 'echo success';
+  return (
+    <div style={{ width: '100%', height: '300px' }}>
+      <TerminalViewer ref={ref} defaultData={data} />
+    </div>
+  );
+};
+```
+
+## 开发
+
+```bash
+$ yarn
+```
+
+启动开发服务
+
+```bash
+$ yarn start
+```
+
+构建文档
+
+```bash
+$ yarn docs:build
+```
+
+执行测试
+
+```bash
+$ yarn test
+```
+
+构建可发布的包
+
+```bash
+$ yarn build
+```
+
+## 开启基于 Web Worker 与 虚拟 DOM 的日志组件配置
+
+webpack 配置：
+
+```js
+  new CopyPlugin({
+      patterns: [
+        {
+          from: path.resolve(__dirname, 'node_modules/react-terminal-viewer/dist/worker'),
+          to: path.resolve(__dirname, 'dist/scripts/worker'),
+          filter: (file) => file.includes('worker'),
+        },
+      ],
+    }),
+```
+
+组件使用：
+
+```
+  <TerminalViewer virtualDomSupport workerPath="/scripts/worker"/>
+```
+
+## 发布
+打标签后使用流水线发布或使用常规方式手动发布：
+
+```bash
+npm version patch && npm publish
+```
+## 更新在线地址
+
+合并代码后与打标签后使用流水线发布，使用常规方式合并代码与构建后，手动推送至deploy
+
+## 修复已知问题
+
+- 使用 DOM 模式渲染修复搜索命中关键字时无法修改字体前景的问题
+- 使用 1000+ 的提示修复 搜索结果超过 1000+ 时搜索卡顿的问题
+
+## TODO
+
+- 【日志交互】支持 hover 复制行锚点(由于无法直接获取可视区域行在全文中的唯一位置，导致锚点难以取到）
+- 【日志交互】支持锚点定位行日志(由于无法直接获取可视区域行在全文中的唯一位置，导致锚点难以取到）
+- 【日志交互】支持 hover 复制行日志
+- 【日志渲染】支持高亮超链接;
+- 【Shell 连接】通过 websocket 连接到运行进程的服务器
+
+## API
+
+| 属性名 | 描述 | 类型 | 默认值 |
+| --- | --- | --- | --- |
+| fit | 是否自动拉伸填充容器宽高 | boolean | true |
+| autoScroll | 是否开启自动滚动到底部 | boolean | true |
+| scrollToRow | 自动滚动到某一行，开启后自动滚动到底部失效 | number | -- |
+| logAfter 设置日志后置标签，仅在开启虚拟 DOM 生效 | FunctionComponent<LogAfterProps> 或 ComponentClass<LogAfterProps, any> | -- |
+| refreshable | 是否支持刷新 | boolean | true |
+| searchPlaceholder | 搜索框 placeholder | string | -- |
+| header | 自定义日志头部, null 为不显示默认头部 | ReactNode | -- |
+| inputAddonBefore | 搜索框前的内容 | ReactNode | -- |
+| inputAddonAfter | 搜索框后的内容 | ReactNode | -- |
+| empty | 自定义空文本显示 | ReactNode | -- |
+| icons | 自定义图标 | { search?: ReactNode; up?: ReactNode; down?: ReactNode; clear?: ReactNode; top?: ReactNode; bottom?: ReactNode; fullScreen?: ReactNode; fullScreenExit?: ReactNode; refresh?: ReactNode; loading?: ReactNode; } | -- |
+| toolbar | 自定义工具栏 | ReactNode | -- |
+| showFullScreen | 是否显示全屏图标 | boolean | true |
+| className | 外层样式类名 | string | -- |
+| style | 可用于设置外层容器样式 | object | -- |
+| defaultFullScreen | 默认全屏显示 | boolean | false |
+| defaultData | 用于渲染日志的默认数据，如 "echo 1\r\necho2" | string | '' |
+| defaultTabIndex | 默认打开的标签 | number | 0 |
+| activeTabIndex | 激活的标签, 如果同时设置了 defaultTabIndex 则以此属性为准 | number | 0 |
+| tabs | 多标签配置选项 | { key: string\|number; title?: ReactNode; defaultData?: string; remoteOptions?: IRemoteOptions; cacheOptions?: ICacheOptions; }[] | -- |
+| webLinksSupport | 是否支持渲染超链接 | boolean | true |
+| canvasSupport | 是否使用 canvas 渲染, 开启 canvas 会有更好的性能但可能会遇到更多的问题 | boolean | false |
+| virtualDomSupport | 是否使用自研虚拟 DOM 内核，开启后 terminalOptions, canvasSupport, webLinksSupport 不可用 | boolean | false |
+| workerPath | 日志 web worker 路径, 需配合 CopyPlugin 使用且仅在开启 virtualDomSupport 为 true 时有效 | string | /worker |
+| remoteOptions | 远程加载配置 | IRemoteOptions | -- |
+| cacheOptions | 缓存全局配置，仅在配置远程加载后有效，如 `expires: 60 * 1000` 表示自动清理已过期一分钟的缓存 | ICacheOptions | -- |
+| searchOptions | xterm 搜索选项 | ISearchOptions | -- |
+| highlightOptions | 高亮选项 | IHighlightOptions[] | -- |
+| terminalOptions | xtem.js 配置, https://github.com/xtermjs/xterm.js | ITerminalOptions | -- |
+| extraOptions | 额外的功能选项 { showLineNumber 仅 虚拟 DOM 模式支持} | ExtraOptions | -- |
+| getContainer | 指定 TerminalViewer 挂载的节点，并在容器内展现，开启全屏后无效， false 为挂载在当前位置 | string | HTMLElement | (() => HTMLElement) | 当前节点 |
+| onLoading | 加载状态变更回调函数 | (bool: boolean) => void | -- |
+| onTitleChange | 点击 tab 标题后回调函数 | (index: number) => void | -- |
+| onRefresh | 刷新后的回调函数 | ()=>void | -- |

package/dist/esm/Addon/EventEmiter.d.ts

@@ -0,0 +1,18 @@
+import { IDisposable } from 'xterm';
+export interface IEvent<T, U = void> {
+    (listener: (arg1: T, arg2: U) => any): IDisposable;
+}
+export interface IEventEmitter<T, U = void> {
+    event: IEvent<T, U>;
+    fire(arg1: T, arg2: U): void;
+    dispose(): void;
+}
+declare class EventEmitter<T, U = void> implements IEventEmitter<T, U> {
+    private _listeners;
+    private _event?;
+    private _disposed;
+    get event(): IEvent<T, U>;
+    fire(arg1: T, arg2: U): void;
+    dispose(): void;
+}
+export default EventEmitter;

package/dist/esm/Addon/EventEmiter.js

@@ -0,0 +1,64 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable no-plusplus */
+/* eslint-disable no-underscore-dangle */
+var EventEmitter = /*#__PURE__*/function () {
+  function EventEmitter() {
+    _classCallCheck(this, EventEmitter);
+    _defineProperty(this, "_listeners", []);
+    _defineProperty(this, "_event", void 0);
+    _defineProperty(this, "_disposed", false);
+  }
+  _createClass(EventEmitter, [{
+    key: "event",
+    get: function get() {
+      var _this = this;
+      if (!this._event) {
+        this._event = function (listener) {
+          _this._listeners.push(listener);
+          var disposable = {
+            dispose: function dispose() {
+              if (!_this._disposed) {
+                for (var i = 0; i < _this._listeners.length; i++) {
+                  if (_this._listeners[i] === listener) {
+                    _this._listeners.splice(i, 1);
+                    return;
+                  }
+                }
+              }
+            }
+          };
+          return disposable;
+        };
+      }
+      return this._event;
+    }
+  }, {
+    key: "fire",
+    value: function fire(arg1, arg2) {
+      var queue = [];
+      for (var i = 0; i < this._listeners.length; i++) {
+        queue.push(this._listeners[i]);
+      }
+      for (var _i = 0; _i < queue.length; _i++) {
+        queue[_i].call(undefined, arg1, arg2);
+      }
+    }
+  }, {
+    key: "dispose",
+    value: function dispose() {
+      if (this._listeners) {
+        this._listeners.length = 0;
+      }
+      this._disposed = true;
+    }
+  }]);
+  return EventEmitter;
+}();
+export default EventEmitter;

package/dist/esm/Addon/HighlightAddon.d.ts

@@ -0,0 +1,26 @@
+import { Terminal, ITerminalAddon } from 'xterm';
+export interface IHighlightOptions {
+    keyword: string;
+    ignoreSensitive?: boolean;
+    decorations: {
+        matchForegroundColor?: string;
+        matchBackground?: string;
+    };
+}
+/**
+ * 基于关键字的自定义高亮插件
+ */
+declare class HighlightAddon implements ITerminalAddon {
+    private _terminal;
+    private _cacheDecorations;
+    private _highlightTimeout;
+    activate(terminal: Terminal): void;
+    private _getLineProperty;
+    private _decoration;
+    private _clearDecoration;
+    private _updateHighlight;
+    highlight(options: IHighlightOptions[] | undefined): void;
+    dispose(): void;
+}
+export { HighlightAddon };
+export default HighlightAddon;

package/dist/esm/Addon/HighlightAddon.js

@@ -0,0 +1,188 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+/* eslint-disable no-restricted-syntax */
+/* eslint-disable prefer-destructuring */
+/* eslint-disable no-cond-assign */
+/* eslint-disable consistent-return */
+/* eslint-disable no-plusplus */
+/* eslint-disable max-len */
+/* eslint-disable no-param-reassign */
+/* eslint-disable class-methods-use-this */
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+/* eslint-disable no-underscore-dangle */
+/**
+ * 基于关键字的自定义高亮插件
+ */
+var HighlightAddon = /*#__PURE__*/function () {
+  function HighlightAddon() {
+    _classCallCheck(this, HighlightAddon);
+    _defineProperty(this, "_terminal", void 0);
+    _defineProperty(this, "_cacheDecorations", void 0);
+    _defineProperty(this, "_highlightTimeout", void 0);
+  }
+  _createClass(HighlightAddon, [{
+    key: "activate",
+    value: function activate(terminal) {
+      this._terminal = terminal;
+    }
+  }, {
+    key: "_getLineProperty",
+    value: function _getLineProperty(line) {
+      var index = 0;
+      var cell = line.getCell(index);
+      var width = 0;
+      var isAllBgDefault = true;
+      var isAllFgDefault = true;
+      while (cell) {
+        if (!cell.isBgDefault()) {
+          isAllBgDefault = false;
+        }
+        if (!cell.isFgDefault()) {
+          isAllFgDefault = false;
+        }
+        width += cell.getWidth();
+        cell = line.getCell(index);
+        index++;
+      }
+      return {
+        width: width,
+        isAllBgDefault: isAllBgDefault,
+        isAllFgDefault: isAllFgDefault
+      };
+    }
+  }, {
+    key: "_decoration",
+    value: function _decoration(line, lineIndex, matchOption) {
+      var _matchOption$decorati, _matchOption$decorati2;
+      if (!this._terminal) {
+        return;
+      }
+      if (!(matchOption !== null && matchOption !== void 0 && (_matchOption$decorati = matchOption.decorations) !== null && _matchOption$decorati !== void 0 && _matchOption$decorati.matchBackground) && !(matchOption !== null && matchOption !== void 0 && (_matchOption$decorati2 = matchOption.decorations) !== null && _matchOption$decorati2 !== void 0 && _matchOption$decorati2.matchForegroundColor)) {
+        return;
+      }
+      var terminal = this._terminal;
+      var _this$_getLinePropert = this._getLineProperty(line),
+        width = _this$_getLinePropert.width,
+        isAllBgDefault = _this$_getLinePropert.isAllBgDefault,
+        isAllFgDefault = _this$_getLinePropert.isAllFgDefault;
+      if (!isAllBgDefault || !isAllFgDefault) {
+        return;
+      }
+      var marker = terminal.registerMarker(-terminal.buffer.active.baseY - terminal.buffer.active.cursorY + lineIndex);
+      if (marker) {
+        var _matchOption$decorati3, _matchOption$decorati4;
+        var decorationOptions = {
+          marker: marker,
+          x: 0,
+          width: width,
+          backgroundColor: (_matchOption$decorati3 = matchOption.decorations) === null || _matchOption$decorati3 === void 0 ? void 0 : _matchOption$decorati3.matchBackground,
+          foregroundColor: (_matchOption$decorati4 = matchOption.decorations) === null || _matchOption$decorati4 === void 0 ? void 0 : _matchOption$decorati4.matchForegroundColor,
+          layer: 'bottom'
+        };
+        var decoration = terminal.registerDecoration(decorationOptions);
+        if (decoration) {
+          var _this$_cacheDecoratio;
+          decoration === null || decoration === void 0 || decoration.onDispose(function () {
+            marker.dispose();
+          });
+          // 可以在 dom 模式下操作 dom
+          // this._highlightDecoration?.onRender((e) => {
+          // });
+          (_this$_cacheDecoratio = this._cacheDecorations) === null || _this$_cacheDecoratio === void 0 || _this$_cacheDecoratio.set(lineIndex, decoration);
+        }
+      }
+    }
+  }, {
+    key: "_clearDecoration",
+    value: function _clearDecoration() {
+      var _this$_cacheDecoratio2, _this$_cacheDecoratio3;
+      (_this$_cacheDecoratio2 = this._cacheDecorations) === null || _this$_cacheDecoratio2 === void 0 || _this$_cacheDecoratio2.forEach(function (decoration) {
+        decoration.marker.dispose();
+        decoration.dispose();
+      });
+      (_this$_cacheDecoratio3 = this._cacheDecorations) === null || _this$_cacheDecoratio3 === void 0 || _this$_cacheDecoratio3.clear();
+    }
+  }, {
+    key: "_updateHighlight",
+    value: function _updateHighlight(options) {
+      var _this = this;
+      if (!this._terminal) {
+        return;
+      }
+      if (!Array.isArray(options)) {
+        return;
+      }
+      this._clearDecoration();
+      var terminal = this._terminal;
+      var lineIndex = 0;
+      var line = terminal.buffer.active.getLine(lineIndex);
+      var prevMatch;
+      var _loop = function _loop() {
+        var nextLine = terminal.buffer.active.getLine(lineIndex + 1);
+        var lineWrapsToNext = nextLine ? nextLine.isWrapped : false;
+        var string = line.translateToString(!lineWrapsToNext);
+        if (string) {
+          if (line.isWrapped && prevMatch) {
+            _this._decoration(line, lineIndex, prevMatch);
+          } else {
+            var matchOption = options.find(function (option) {
+              var keyword = option.keyword || '';
+              if (option.ignoreSensitive) {
+                var lowerString = string.toLowerCase();
+                return lowerString.includes(keyword.toLowerCase()) || lowerString.includes(keyword);
+              }
+              return string.includes(keyword);
+            });
+            prevMatch = matchOption;
+            _this._decoration(line, lineIndex, matchOption);
+          }
+        }
+        lineIndex++;
+        line = nextLine;
+      };
+      while (line) {
+        _loop();
+      }
+    }
+  }, {
+    key: "highlight",
+    value: function highlight(options) {
+      var _this2 = this;
+      if (!this._terminal) {
+        return;
+      }
+      if (!Array.isArray(options)) {
+        return;
+      }
+      this._cacheDecorations = new Map();
+      var terminal = this._terminal;
+      terminal.onWriteParsed(function () {
+        clearTimeout(_this2._highlightTimeout);
+        _this2._highlightTimeout = setTimeout(function () {
+          _this2._updateHighlight(options);
+        }, 0);
+        // this._clearDecoration();
+      });
+      terminal.onResize(function () {
+        clearTimeout(_this2._highlightTimeout);
+        _this2._highlightTimeout = setTimeout(function () {
+          _this2._updateHighlight(options);
+        }, 0);
+      });
+    }
+  }, {
+    key: "dispose",
+    value: function dispose() {
+      clearTimeout(this._highlightTimeout);
+      this._cacheDecorations = undefined;
+    }
+  }]);
+  return HighlightAddon;
+}();
+export { HighlightAddon };
+export default HighlightAddon;

package/dist/esm/Addon/SearchAddon.d.ts

@@ -0,0 +1,140 @@
+/**
+ * 从 https://github.com/xtermjs/xterm.js/blob/master/addons/xterm-addon-search/src/SearchAddon.ts 复制以解决部分问题
+ */
+import { Terminal, ITerminalAddon } from 'xterm';
+export interface ISearchOptions {
+    regex?: boolean;
+    wholeWord?: boolean;
+    caseSensitive?: boolean;
+    incremental?: boolean;
+    decorations?: ISearchDecorationOptions;
+    noScroll?: boolean;
+}
+interface ISearchDecorationOptions {
+    matchForegroundColor?: string;
+    matchBackground?: string;
+    matchBorder?: string;
+    matchOverviewRuler: string;
+    activeMatchBackground?: string;
+    activeMatchBorder?: string;
+    activeMatchColorOverviewRuler: string;
+}
+export interface ISearchPosition {
+    startCol: number;
+    startRow: number;
+}
+export interface ISearchResult {
+    term: string;
+    col: number;
+    row: number;
+    size: number;
+}
+export declare class SearchAddon implements ITerminalAddon {
+    private _terminal;
+    private _cachedSearchTerm;
+    private _selectedDecoration;
+    private _resultDecorations;
+    private _searchResults;
+    private _onDataDisposable;
+    private _onResizeDisposable;
+    private _lastSearchOptions;
+    private _highlightTimeout;
+    /**
+     * translateBufferLineToStringWithWrap is a fairly expensive call.
+     * We memoize the calls into an array that has a time based ttl.
+     * _linesCache is also invalidated when the terminal cursor moves.
+     */
+    private _linesCache;
+    private _linesCacheTimeoutId;
+    private _cursorMoveListener;
+    private _resizeListener;
+    private _resultIndex;
+    private readonly _onDidChangeResults;
+    readonly onDidChangeResults: import("./EventEmiter").IEvent<{
+        resultIndex: number;
+        resultCount: number;
+    } | undefined, void>;
+    activate(terminal: Terminal): void;
+    private _updateMatches;
+    dispose(): void;
+    clearDecorations(retainCachedSearchTerm?: boolean): void;
+    clearActiveDecoration(): void;
+    /**
+     * Find the next instance of the term, then scroll to and select it. If it
+     * doesn't exist, do nothing.
+     * @param term The search term.
+     * @param searchOptions Search options.
+     * @return Whether a result was found.
+     */
+    findNext(term: string, searchOptions?: ISearchOptions): boolean;
+    private _highlightAllMatches;
+    private _find;
+    private _findNextAndSelect;
+    /**
+     * Find the previous instance of the term, then scroll to and select it. If it
+     * doesn't exist, do nothing.
+     * @param term The search term.
+     * @param searchOptions Search options.
+     * @return Whether a result was found.
+     */
+    findPrevious(term: string, searchOptions?: ISearchOptions): boolean;
+    private _fireResults;
+    private _findPreviousAndSelect;
+    /**
+     * Sets up a line cache with a ttl
+     */
+    private _initLinesCache;
+    private _destroyLinesCache;
+    /**
+     * A found substring is a whole word if it doesn't have an alphanumeric character directly adjacent to it.
+     * @param searchIndex starting indext of the potential whole word substring
+     * @param line entire string in which the potential whole word was found
+     * @param term the substring that starts at searchIndex
+     */
+    private _isWholeWord;
+    /**
+     * Searches a line for a search term. Takes the provided terminal line and searches the text line, which may contain
+     * subsequent terminal lines if the text is wrapped. If the provided line number is part of a wrapped text line that
+     * started on an earlier line then it is skipped since it will be properly searched when the terminal line that the
+     * text starts on is searched.
+     * @param term The search term.
+     * @param position The position to start the search.
+     * @param searchOptions Search options.
+     * @param isReverseSearch Whether the search should start from the right side of the terminal and search to the left.
+     * @return The search result if it was found.
+     */
+    protected _findInLine(term: string, searchPosition: ISearchPosition, searchOptions?: ISearchOptions, isReverseSearch?: boolean): ISearchResult | undefined;
+    private _stringLengthToBufferSize;
+    private _bufferColsToStringOffset;
+    /**
+     * Translates a buffer line to a string, including subsequent lines if they are wraps.
+     * Wide characters will count as two columns in the resulting string. This
+     * function is useful for getting the actual text underneath the raw selection
+     * position.
+     * @param line The line being translated.
+     * @param trimRight Whether to trim whitespace to the right.
+     */
+    private _translateBufferLineToStringWithWrap;
+    /**
+     * Selects and scrolls to a result.
+     * @param result The result to select.
+     * @return Whether a result was selected.
+     */
+    private _selectResult;
+    /**
+     * Applies styles to the decoration when it is rendered
+     * @param element the decoration's element
+     * @param backgroundColor the background color to apply
+     * @param borderColor the border color to apply
+     * @returns
+     */
+    private _applyStyles;
+    /**
+     * Creates a decoration for the result and applies styles
+     * @param result the search result for which to create the decoration
+     * @param options the options for the decoration
+     * @returns the {@link IDecoration} or undefined if the marker has already been disposed of
+     */
+    private _createResultDecoration;
+}
+export {};