Class: SpyIDE

libs/common/ide/spy/SpyIDE.SpyIDE

Hierarchy

• PassthroughIDEBase

  ↳ SpyIDE

Constructors

constructor

• new SpyIDE(original)

Parameters

Name	Type
original	IDE

Overrides

PassthroughIDEBase.constructor

Defined in

libs/common/ide/spy/SpyIDE.ts:25

Properties

capabilities

• capabilities: Capabilities

The capabilities of the IDE

Inherited from

PassthroughIDEBase.capabilities

Defined in

libs/common/ide/PassthroughIDEBase.ts:24

---

clipboard

• clipboard: Clipboard

Inherited from

PassthroughIDEBase.clipboard

Defined in

libs/common/ide/PassthroughIDEBase.ts:22

---

configuration

• configuration: Configuration

Inherited from

PassthroughIDEBase.configuration

Defined in

libs/common/ide/PassthroughIDEBase.ts:20

---

flashes

• Private flashes: FlashDescriptor[] = []

Defined in

libs/common/ide/spy/SpyIDE.ts:22

---

globalState

• globalState: State

Inherited from

PassthroughIDEBase.globalState

Defined in

libs/common/ide/PassthroughIDEBase.ts:21

---

hats

• hats: Hats

Inherited from

PassthroughIDEBase.hats

Defined in

libs/common/ide/PassthroughIDEBase.ts:25

---

highlights

• Private highlights: Highlight[] = []

Defined in

libs/common/ide/spy/SpyIDE.ts:23

---

messages

• messages: SpyMessages

Overrides

PassthroughIDEBase.messages

Defined in

libs/common/ide/spy/SpyIDE.ts:21

Accessors

activeEditableTextEditor

• get activeEditableTextEditor(): undefined | EditableTextEditor

Returns

undefined | EditableTextEditor

Inherited from

PassthroughIDEBase.activeEditableTextEditor

Defined in

libs/common/ide/PassthroughIDEBase.ts:115

---

activeTextEditor

• get activeTextEditor(): undefined | TextEditor

Returns

undefined | TextEditor

Inherited from

PassthroughIDEBase.activeTextEditor

Defined in

libs/common/ide/PassthroughIDEBase.ts:111

---

assetsRoot

• get assetsRoot(): string

Returns

string

Inherited from

PassthroughIDEBase.assetsRoot

Defined in

libs/common/ide/PassthroughIDEBase.ts:123

---

runMode

• get runMode(): RunMode

Returns

RunMode

Inherited from

PassthroughIDEBase.runMode

Defined in

libs/common/ide/PassthroughIDEBase.ts:127

---

visibleTextEditors

• get visibleTextEditors(): TextEditor[]

Returns

TextEditor[]

Inherited from

PassthroughIDEBase.visibleTextEditors

Defined in

libs/common/ide/PassthroughIDEBase.ts:119

---

workspaceFolders

• get workspaceFolders(): undefined | readonly WorkspaceFolder[]

Returns

undefined | readonly WorkspaceFolder[]

Inherited from

PassthroughIDEBase.workspaceFolders

Defined in

libs/common/ide/PassthroughIDEBase.ts:131

Methods

disposeOnExit

▸ disposeOnExit(...disposables): () => void

Register disposables to be disposed of on IDE exit.

Parameters

Name	Type
...disposables	Disposable[]

Returns

fn

▸ (): void

Returns

void

Inherited from

PassthroughIDEBase.disposeOnExit

Defined in

libs/common/ide/PassthroughIDEBase.ts:168

---

executeCommand

▸ executeCommand<T>(command, ...args): Promise<undefined | T>

Executes the built-in ide command denoted by the given command identifier.

Type parameters

Name
T

Parameters

Name	Type
command	string
...args	any[]

Returns

Promise<undefined | T>

Inherited from

PassthroughIDEBase.executeCommand

Defined in

libs/common/ide/PassthroughIDEBase.ts:158

---

findInWorkspace

▸ findInWorkspace(query): Promise<void>

Find occurrences of query string in all files in the workspace

Parameters

Name	Type
query	string

Returns

Promise<void>

Inherited from

PassthroughIDEBase.findInWorkspace

Defined in

libs/common/ide/PassthroughIDEBase.ts:135

---

flashRanges

▸ flashRanges(flashDescriptors): Promise<void>

Temporarily emphasize the given ranges to the user. This function is used to show ranges that eg are about to be deleted, are the source of a bring, etc. The promise should resolve when the flash is complete.

Parameters

Name	Type
flashDescriptors	FlashDescriptor[]

Returns

Promise<void>

Overrides

PassthroughIDEBase.flashRanges

Defined in

libs/common/ide/spy/SpyIDE.ts:42

---

getEditableTextEditor

▸ getEditableTextEditor(editor): EditableTextEditor

Get an editable version of the text editor.

Parameters

Name	Type
editor	TextEditor

Returns

EditableTextEditor

Inherited from

PassthroughIDEBase.getEditableTextEditor

Defined in

libs/common/ide/PassthroughIDEBase.ts:154

---

getSpyValues

▸ getSpyValues(isFlashTest): undefined | SpyIDERecordedValues

Parameters

Name	Type
isFlashTest	boolean

Returns

undefined | SpyIDERecordedValues

Defined in

libs/common/ide/spy/SpyIDE.ts:30

---

onDidChangeActiveTextEditor

▸ onDidChangeActiveTextEditor(listener, thisArgs?, disposables?): Disposable

Parameters

Name	Type
listener	(e: undefined | TextEditor) => any
thisArgs?	any
disposables?	Disposable[]

Returns

Disposable

Inherited from

PassthroughIDEBase.onDidChangeActiveTextEditor

Defined in

libs/common/ide/PassthroughIDEBase.ts:66

---

onDidChangeTextDocument

▸ onDidChangeTextDocument(listener): Disposable

An event that is emitted when a text document is changed. This usually happens when the contents changes but also when other things like the {@link TextDocument.isDirty dirty}-state changes.

Parameters

Name	Type
listener	(event: TextDocumentChangeEvent) => void

Returns

Disposable

Inherited from

PassthroughIDEBase.onDidChangeTextDocument

Defined in

libs/common/ide/PassthroughIDEBase.ts:162

---

onDidChangeTextEditorSelection

▸ onDidChangeTextEditorSelection(listener, thisArgs?, disposables?): Disposable

Parameters

Name	Type
listener	(e: TextEditorSelectionChangeEvent) => any
thisArgs?	any
disposables?	Disposable[]

Returns

Disposable

Inherited from

PassthroughIDEBase.onDidChangeTextEditorSelection

Defined in

libs/common/ide/PassthroughIDEBase.ts:88

---

onDidChangeTextEditorVisibleRanges

▸ onDidChangeTextEditorVisibleRanges(listener, thisArgs?, disposables?): Disposable

Parameters

Name	Type
listener	(e: TextEditorVisibleRangesChangeEvent) => any
thisArgs?	any
disposables?	Disposable[]

Returns

Disposable

Inherited from

PassthroughIDEBase.onDidChangeTextEditorVisibleRanges

Defined in

libs/common/ide/PassthroughIDEBase.ts:99

---

onDidChangeVisibleTextEditors

▸ onDidChangeVisibleTextEditors(listener, thisArgs?, disposables?): Disposable

Parameters

Name	Type
listener	(e: TextEditor[]) => any
thisArgs?	any
disposables?	Disposable[]

Returns

Disposable

Inherited from

PassthroughIDEBase.onDidChangeVisibleTextEditors

Defined in

libs/common/ide/PassthroughIDEBase.ts:77

---

onDidCloseTextDocument

▸ onDidCloseTextDocument(listener, thisArgs?, disposables?): Disposable

Parameters

Name	Type
listener	(e: TextDocument) => any
thisArgs?	any
disposables?	Disposable[]

Returns

Disposable

Inherited from

PassthroughIDEBase.onDidCloseTextDocument

Defined in

libs/common/ide/PassthroughIDEBase.ts:55

---

onDidOpenTextDocument

▸ onDidOpenTextDocument(listener, thisArgs?, disposables?): Disposable

Parameters

Name	Type
listener	(e: TextDocument) => any
thisArgs?	any
disposables?	Disposable[]

Returns

Disposable

Inherited from

PassthroughIDEBase.onDidOpenTextDocument

Defined in

libs/common/ide/PassthroughIDEBase.ts:48

---

openTextDocument

▸ openTextDocument(path): Promise<TextEditor>

Opens a document.

Parameters

Name	Type
path	string

Returns

Promise<TextEditor>

Inherited from

PassthroughIDEBase.openTextDocument

Defined in

libs/common/ide/PassthroughIDEBase.ts:139

---

setHighlightRanges

▸ setHighlightRanges(highlightId, editor, ranges): Promise<void>

Set the ranges in {@link editor} to which {@link highlightId} should be applied. Removes the given highlight from all other ranges in {@link editor}.

Parameters

Name	Type
highlightId	undefined | string
editor	TextEditor
ranges	GeneralizedRange[]

Returns

Promise<void>

Overrides

PassthroughIDEBase.setHighlightRanges

Defined in

libs/common/ide/spy/SpyIDE.ts:47

---

showInputBox

▸ showInputBox(options?): Promise<undefined | string>

Opens an input box to ask the user for input.

The returned value will be undefined if the input box was canceled (e.g. pressing ESC). Otherwise the returned value will be the string typed by the user or an empty string if the user did not type anything but dismissed the input box with OK.

Parameters

Name	Type
options?	any

Returns

Promise<undefined | string>

Inherited from

PassthroughIDEBase.showInputBox

Defined in

libs/common/ide/PassthroughIDEBase.ts:150

---

showQuickPick

▸ showQuickPick(items, options?): Promise<undefined | string>

Shows a selection list.

Parameters

Name	Type
items	readonly string[]
options?	QuickPickOptions

Returns

Promise<undefined | string>

Inherited from

PassthroughIDEBase.showQuickPick

Defined in

libs/common/ide/PassthroughIDEBase.ts:143