Class: NormalizedIDE
libs/common/ide/normalized/NormalizedIDE.NormalizedIDE
Hierarchy
↳
NormalizedIDE
Constructors
constructor
• new NormalizedIDE(original, fakeIde, isSilent)
Parameters
| Name | Type |
|---|---|
original | IDE |
fakeIde | FakeIDE |
isSilent | boolean |
Overrides
PassthroughIDEBase.constructor
Defined in
libs/common/ide/normalized/NormalizedIDE.ts:13
Properties
capabilities
• capabilities: Capabilities
The capabilities of the IDE
Inherited from
PassthroughIDEBase.capabilities
Defined in
libs/common/ide/PassthroughIDEBase.ts:15
clipboard
• clipboard: FakeClipboard
Overrides
Defined in
libs/common/ide/normalized/NormalizedIDE.ts:11
configuration
• configuration: FakeConfiguration
Overrides
PassthroughIDEBase.configuration
Defined in
libs/common/ide/normalized/NormalizedIDE.ts:9
globalState
• globalState: FakeGlobalState
Overrides
PassthroughIDEBase.globalState
Defined in
libs/common/ide/normalized/NormalizedIDE.ts:10
messages
• messages: Messages
Inherited from
Defined in
libs/common/ide/PassthroughIDEBase.ts:14
Accessors
activeEditableTextEditor
• get activeEditableTextEditor(): undefined | EditableTextEditor
Returns
undefined | EditableTextEditor
Inherited from
PassthroughIDEBase.activeEditableTextEditor
Defined in
libs/common/ide/PassthroughIDEBase.ts:29
activeTextEditor
• get activeTextEditor(): undefined | TextEditor
Returns
undefined | TextEditor
Inherited from
PassthroughIDEBase.activeTextEditor
Defined in
libs/common/ide/PassthroughIDEBase.ts:25
assetsRoot
• get assetsRoot(): string
Returns
string
Inherited from
PassthroughIDEBase.assetsRoot
Defined in
libs/common/ide/PassthroughIDEBase.ts:37
runMode
• get runMode(): RunMode
Returns
Inherited from
PassthroughIDEBase.runMode
Defined in
libs/common/ide/PassthroughIDEBase.ts:41
visibleTextEditors
• get visibleTextEditors(): TextEditor[]
Returns
Inherited from
PassthroughIDEBase.visibleTextEditors
Defined in
libs/common/ide/PassthroughIDEBase.ts:33
workspaceFolders
• get workspaceFolders(): undefined | readonly WorkspaceFolder[]
Returns
undefined | readonly WorkspaceFolder[]
Inherited from
PassthroughIDEBase.workspaceFolders
Defined in
libs/common/ide/PassthroughIDEBase.ts:45
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:75
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:65
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:49
getEditableTextEditor
▸ getEditableTextEditor(editor): EditableTextEditor
Get an editable version of the text editor.
Parameters
| Name | Type |
|---|---|
editor | TextEditor |
Returns
Inherited from
PassthroughIDEBase.getEditableTextEditor
Defined in
libs/common/ide/PassthroughIDEBase.ts:61
initializeConfiguration
▸ Private initializeConfiguration(): void
Returns
void
Defined in
libs/common/ide/normalized/NormalizedIDE.ts:24
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
Inherited from
PassthroughIDEBase.onDidChangeTextDocument
Defined in
libs/common/ide/PassthroughIDEBase.ts:69
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:53
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:57