mirror of
https://github.com/ckaczor/azuredatastudio.git
synced 2026-02-16 10:58:30 -05:00
Refresh master with initial release/0.24 snapshot (#332)
* Initial port of release/0.24 source code * Fix additional headers * Fix a typo in launch.json
This commit is contained in:
511
src/vs/vscode.d.ts
vendored
511
src/vs/vscode.d.ts
vendored
@@ -733,7 +733,8 @@ declare module 'vscode' {
|
||||
/**
|
||||
* An optional view column in which the [editor](#TextEditor) should be shown.
|
||||
* The default is the [one](#ViewColumn.One), other values are adjusted to
|
||||
* be __Min(column, columnCount + 1)__.
|
||||
* be `Min(column, columnCount + 1)`, the [active](#ViewColumn.Active)-column is
|
||||
* not adjusted.
|
||||
*/
|
||||
viewColumn?: ViewColumn;
|
||||
|
||||
@@ -773,7 +774,7 @@ declare module 'vscode' {
|
||||
export interface ThemableDecorationRenderOptions {
|
||||
/**
|
||||
* Background color of the decoration. Use rgba() and define transparent background colors to play well with other decorations.
|
||||
* Alternativly a color from the color registry an be [referenced](#ColorIdentifier).
|
||||
* Alternatively a color from the color registry can be [referenced](#ThemeColor).
|
||||
*/
|
||||
backgroundColor?: string | ThemeColor;
|
||||
|
||||
@@ -1179,6 +1180,11 @@ declare module 'vscode' {
|
||||
*/
|
||||
static parse(value: string): Uri;
|
||||
|
||||
/**
|
||||
* Use the `file` and `parse` factory functions to create new `Uri` objects.
|
||||
*/
|
||||
private constructor(scheme: string, authority: string, path: string, query: string, fragment: string);
|
||||
|
||||
/**
|
||||
* Scheme is the `http` part of `http://www.msft.com/some/path?query#fragment`.
|
||||
* The part before the first colon.
|
||||
@@ -1498,6 +1504,96 @@ declare module 'vscode' {
|
||||
onDidSelectItem?(item: QuickPickItem | string): any;
|
||||
}
|
||||
|
||||
/**
|
||||
* Options to configure the behaviour of the [workspace folder](#WorkspaceFolder) pick UI.
|
||||
*/
|
||||
export interface WorkspaceFolderPickOptions {
|
||||
|
||||
/**
|
||||
* An optional string to show as place holder in the input box to guide the user what to pick on.
|
||||
*/
|
||||
placeHolder?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` to keep the picker open when focus moves to another part of the editor or to another window.
|
||||
*/
|
||||
ignoreFocusOut?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Options to configure the behaviour of a file open dialog.
|
||||
*
|
||||
* * Note 1: A dialog can select files, folders, or both. This is not true for Windows
|
||||
* which enforces to open either files or folder, but *not both*.
|
||||
* * Note 2: Explictly setting `canSelectFiles` and `canSelectFolders` to `false` is futile
|
||||
* and the editor then silently adjusts the options to select files.
|
||||
*/
|
||||
export interface OpenDialogOptions {
|
||||
/**
|
||||
* The resource the dialog shows when opened.
|
||||
*/
|
||||
defaultUri?: Uri;
|
||||
|
||||
/**
|
||||
* A human-readable string for the open button.
|
||||
*/
|
||||
openLabel?: string;
|
||||
|
||||
/**
|
||||
* Allow to select files, defaults to `true`.
|
||||
*/
|
||||
canSelectFiles?: boolean;
|
||||
|
||||
/**
|
||||
* Allow to select folders, defaults to `false`.
|
||||
*/
|
||||
canSelectFolders?: boolean;
|
||||
|
||||
/**
|
||||
* Allow to select many files or folders.
|
||||
*/
|
||||
canSelectMany?: boolean;
|
||||
|
||||
/**
|
||||
* A set of file filters that are used by the dialog. Each entry is a human readable label,
|
||||
* like "TypeScript", and an array of extensions, e.g.
|
||||
* ```ts
|
||||
* {
|
||||
* 'Images': ['png', 'jpg']
|
||||
* 'TypeScript': ['ts', 'tsx']
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
filters?: { [name: string]: string[] };
|
||||
}
|
||||
|
||||
/**
|
||||
* Options to configure the behaviour of a file save dialog.
|
||||
*/
|
||||
export interface SaveDialogOptions {
|
||||
/**
|
||||
* The resource the dialog shows when opened.
|
||||
*/
|
||||
defaultUri?: Uri;
|
||||
|
||||
/**
|
||||
* A human-readable string for the save button.
|
||||
*/
|
||||
saveLabel?: string;
|
||||
|
||||
/**
|
||||
* A set of file filters that are used by the dialog. Each entry is a human readable label,
|
||||
* like "TypeScript", and an array of extensions, e.g.
|
||||
* ```ts
|
||||
* {
|
||||
* 'Images': ['png', 'jpg']
|
||||
* 'TypeScript': ['ts', 'tsx']
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
filters?: { [name: string]: string[] };
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents an action that is shown with an information, warning, or
|
||||
* error message.
|
||||
@@ -1581,9 +1677,47 @@ declare module 'vscode' {
|
||||
* @return A human readable string which is presented as diagnostic message.
|
||||
* Return `undefined`, `null`, or the empty string when 'value' is valid.
|
||||
*/
|
||||
validateInput?(value: string): string | undefined | null;
|
||||
validateInput?(value: string): string | undefined | null | Thenable<string | undefined | null>;
|
||||
}
|
||||
|
||||
/**
|
||||
* A relative pattern is a helper to construct glob patterns that are matched
|
||||
* relatively to a base path. The base path can either be an absolute file path
|
||||
* or a [workspace folder](#WorkspaceFolder).
|
||||
*/
|
||||
export class RelativePattern {
|
||||
|
||||
/**
|
||||
* A base file path to which this pattern will be matched against relatively.
|
||||
*/
|
||||
base: string;
|
||||
|
||||
/**
|
||||
* A file glob pattern like `*.{ts,js}` that will be matched on file paths
|
||||
* relative to the base path.
|
||||
*
|
||||
* Example: Given a base of `/home/work/folder` and a file path of `/home/work/folder/index.js`,
|
||||
* the file glob pattern will match on `index.js`.
|
||||
*/
|
||||
pattern: string;
|
||||
|
||||
/**
|
||||
* Creates a new relative pattern object with a base path and pattern to match. This pattern
|
||||
* will be matched on file paths relative to the base path.
|
||||
*
|
||||
* @param base A base file path to which this pattern will be matched against relatively.
|
||||
* @param pattern A file glob pattern like `*.{ts,js}` that will be matched on file paths
|
||||
* relative to the base path.
|
||||
*/
|
||||
constructor(base: WorkspaceFolder | string, pattern: string)
|
||||
}
|
||||
|
||||
/**
|
||||
* A file glob pattern to match file paths against. This can either be a glob pattern string
|
||||
* (like `**∕*.{ts,js}` or `*.{ts,js}`) or a [relative pattern](#RelativePattern).
|
||||
*/
|
||||
export type GlobPattern = string | RelativePattern;
|
||||
|
||||
/**
|
||||
* A document filter denotes a document by different properties like
|
||||
* the [language](#TextDocument.languageId), the [scheme](#Uri.scheme) of
|
||||
@@ -1605,9 +1739,10 @@ declare module 'vscode' {
|
||||
scheme?: string;
|
||||
|
||||
/**
|
||||
* A glob pattern, like `*.{ts,js}`.
|
||||
* A [glob pattern](#GlobPattern) that is matched on the absolute path of the document. Use a [relative pattern](#RelativePattern)
|
||||
* to filter documents to a [workspace folder](#WorkspaceFolder).
|
||||
*/
|
||||
pattern?: string;
|
||||
pattern?: GlobPattern;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -1619,7 +1754,6 @@ declare module 'vscode' {
|
||||
*/
|
||||
export type DocumentSelector = string | DocumentFilter | (string | DocumentFilter)[];
|
||||
|
||||
|
||||
/**
|
||||
* A provider result represents the values a provider, like the [`HoverProvider`](#HoverProvider),
|
||||
* may return. For once this is the actual result type `T`, like `Hover`, or a thenable that resolves
|
||||
@@ -1852,6 +1986,13 @@ declare module 'vscode' {
|
||||
* @param value Markdown string.
|
||||
*/
|
||||
appendMarkdown(value: string): MarkdownString;
|
||||
|
||||
/**
|
||||
* Appends the given string as codeblock using the provided language.
|
||||
* @param value A code snippet.
|
||||
* @param language An optional [language identifier](#languages.getLanguages).
|
||||
*/
|
||||
appendCodeblock(value: string, language?: string): MarkdownString;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -2087,6 +2228,11 @@ declare module 'vscode' {
|
||||
* skip the [location](#SymbolInformation.location) of symbols and implement `resolveWorkspaceSymbol` to do that
|
||||
* later.
|
||||
*
|
||||
* The `query`-parameter should be interpreted in a *relaxed way* as the editor will apply its own highlighting
|
||||
* and scoring on the results. A good rule of thumb is to match case-insensitive and to simply check that the
|
||||
* characters of *query* appear in their order in a candidate symbol. Don't use prefix, substring, or similar
|
||||
* strict matching.
|
||||
*
|
||||
* @param query A non-empty query string.
|
||||
* @param token A cancellation token.
|
||||
* @return An array of document highlights or a thenable that resolves to such. The lack of a result can be
|
||||
@@ -2458,7 +2604,7 @@ declare module 'vscode' {
|
||||
* The human-readable doc-comment of this signature. Will be shown
|
||||
* in the UI but can be omitted.
|
||||
*/
|
||||
documentation?: string;
|
||||
documentation?: string | MarkdownString;
|
||||
|
||||
/**
|
||||
* Creates a new parameter information object.
|
||||
@@ -2466,7 +2612,7 @@ declare module 'vscode' {
|
||||
* @param label A label string.
|
||||
* @param documentation A doc string.
|
||||
*/
|
||||
constructor(label: string, documentation?: string);
|
||||
constructor(label: string, documentation?: string | MarkdownString);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -2486,7 +2632,7 @@ declare module 'vscode' {
|
||||
* The human-readable doc-comment of this signature. Will be shown
|
||||
* in the UI but can be omitted.
|
||||
*/
|
||||
documentation?: string;
|
||||
documentation?: string | MarkdownString;
|
||||
|
||||
/**
|
||||
* The parameters of this signature.
|
||||
@@ -2499,7 +2645,7 @@ declare module 'vscode' {
|
||||
* @param label A label string.
|
||||
* @param documentation A doc string.
|
||||
*/
|
||||
constructor(label: string, documentation?: string);
|
||||
constructor(label: string, documentation?: string | MarkdownString);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -2613,6 +2759,7 @@ declare module 'vscode' {
|
||||
/**
|
||||
* A human-readable string that represents a doc-comment.
|
||||
*/
|
||||
// {{SQL CARBON EDIT}}
|
||||
documentation?: string;
|
||||
|
||||
/**
|
||||
@@ -2718,6 +2865,40 @@ declare module 'vscode' {
|
||||
constructor(items?: CompletionItem[], isIncomplete?: boolean);
|
||||
}
|
||||
|
||||
/**
|
||||
* How a [completion provider](#CompletionItemProvider) was triggered
|
||||
*/
|
||||
export enum CompletionTriggerKind {
|
||||
/**
|
||||
* Completion was triggered normally.
|
||||
*/
|
||||
Invoke = 0,
|
||||
/**
|
||||
* Completion was triggered by a trigger character.
|
||||
*/
|
||||
TriggerCharacter = 1
|
||||
}
|
||||
|
||||
/**
|
||||
* Contains additional information about the context in which
|
||||
* [completion provider](#CompletionItemProvider.provideCompletionItems) is triggered.
|
||||
*/
|
||||
export interface CompletionContext {
|
||||
/**
|
||||
* How the completion was triggered.
|
||||
*/
|
||||
readonly triggerKind: CompletionTriggerKind;
|
||||
|
||||
/**
|
||||
* Character that triggered the completion item provider.
|
||||
*
|
||||
* `undefined` if provider was not triggered by a character.
|
||||
*
|
||||
* The trigger character is already in the document when the completion provider is triggered.
|
||||
*/
|
||||
readonly triggerCharacter?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* The completion item provider interface defines the contract between extensions and
|
||||
* [IntelliSense](https://code.visualstudio.com/docs/editor/intellisense).
|
||||
@@ -2740,10 +2921,12 @@ declare module 'vscode' {
|
||||
* @param document The document in which the command was invoked.
|
||||
* @param position The position at which the command was invoked.
|
||||
* @param token A cancellation token.
|
||||
* @param context How the completion was triggered.
|
||||
*
|
||||
* @return An array of completions, a [completion list](#CompletionList), or a thenable that resolves to either.
|
||||
* The lack of a result can be signaled by returning `undefined`, `null`, or an empty array.
|
||||
*/
|
||||
provideCompletionItems(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<CompletionItem[] | CompletionList>;
|
||||
provideCompletionItems(document: TextDocument, position: Position, token: CancellationToken, context: CompletionContext): ProviderResult<CompletionItem[] | CompletionList>;
|
||||
|
||||
/**
|
||||
* Given a completion item fill in more data, like [doc-comment](#CompletionItem.documentation)
|
||||
@@ -2814,6 +2997,133 @@ declare module 'vscode' {
|
||||
resolveDocumentLink?(link: DocumentLink, token: CancellationToken): ProviderResult<DocumentLink>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents a color in RGBA space.
|
||||
*/
|
||||
export class Color {
|
||||
|
||||
/**
|
||||
* The red component of this color in the range [0-1].
|
||||
*/
|
||||
readonly red: number;
|
||||
|
||||
/**
|
||||
* The green component of this color in the range [0-1].
|
||||
*/
|
||||
readonly green: number;
|
||||
|
||||
/**
|
||||
* The blue component of this color in the range [0-1].
|
||||
*/
|
||||
readonly blue: number;
|
||||
|
||||
/**
|
||||
* The alpha component of this color in the range [0-1].
|
||||
*/
|
||||
readonly alpha: number;
|
||||
|
||||
/**
|
||||
* Creates a new color instance.
|
||||
*
|
||||
* @param red The red component.
|
||||
* @param green The green component.
|
||||
* @param blue The bluew component.
|
||||
* @param alpha The alpha component.
|
||||
*/
|
||||
constructor(red: number, green: number, blue: number, alpha: number);
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents a color range from a document.
|
||||
*/
|
||||
export class ColorInformation {
|
||||
|
||||
/**
|
||||
* The range in the document where this color appers.
|
||||
*/
|
||||
range: Range;
|
||||
|
||||
/**
|
||||
* The actual color value for this color range.
|
||||
*/
|
||||
color: Color;
|
||||
|
||||
/**
|
||||
* Creates a new color range.
|
||||
*
|
||||
* @param range The range the color appears in. Must not be empty.
|
||||
* @param color The value of the color.
|
||||
* @param format The format in which this color is currently formatted.
|
||||
*/
|
||||
constructor(range: Range, color: Color);
|
||||
}
|
||||
|
||||
/**
|
||||
* A color presentation object describes how a [`color`](#Color) should be represented as text and what
|
||||
* edits are required to refer to it from source code.
|
||||
*
|
||||
* For some languages one color can have multiple presentations, e.g. css can represent the color red with
|
||||
* the constant `Red`, the hex-value `#ff0000`, or in rgba and hsla forms. In csharp other representations
|
||||
* apply, e.g `System.Drawing.Color.Red`.
|
||||
*/
|
||||
export class ColorPresentation {
|
||||
|
||||
/**
|
||||
* The label of this color presentation. It will be shown on the color
|
||||
* picker header. By default this is also the text that is inserted when selecting
|
||||
* this color presentation.
|
||||
*/
|
||||
label: string;
|
||||
|
||||
/**
|
||||
* An [edit](#TextEdit) which is applied to a document when selecting
|
||||
* this presentation for the color. When `falsy` the [label](#ColorPresentation.label)
|
||||
* is used.
|
||||
*/
|
||||
textEdit?: TextEdit;
|
||||
|
||||
/**
|
||||
* An optional array of additional [text edits](#TextEdit) that are applied when
|
||||
* selecting this color presentation. Edits must not overlap with the main [edit](#ColorPresentation.textEdit) nor with themselves.
|
||||
*/
|
||||
additionalTextEdits?: TextEdit[];
|
||||
|
||||
/**
|
||||
* Creates a new color presentation.
|
||||
*
|
||||
* @param label The label of this color presentation.
|
||||
*/
|
||||
constructor(label: string);
|
||||
}
|
||||
|
||||
/**
|
||||
* The document color provider defines the contract between extensions and feature of
|
||||
* picking and modifying colors in the editor.
|
||||
*/
|
||||
export interface DocumentColorProvider {
|
||||
|
||||
/**
|
||||
* Provide colors for the given document.
|
||||
*
|
||||
* @param document The document in which the command was invoked.
|
||||
* @param token A cancellation token.
|
||||
* @return An array of [color informations](#ColorInformation) or a thenable that resolves to such. The lack of a result
|
||||
* can be signaled by returning `undefined`, `null`, or an empty array.
|
||||
*/
|
||||
provideDocumentColors(document: TextDocument, token: CancellationToken): ProviderResult<ColorInformation[]>;
|
||||
|
||||
/**
|
||||
* Provide [representations](#ColorPresentation) for a color.
|
||||
*
|
||||
* @param color The color to show and insert.
|
||||
* @param context A context object with additional information
|
||||
* @param token A cancellation token.
|
||||
* @return An array of color presentations or a thenable that resolves to such. The lack of a result
|
||||
* can be signaled by returning `undefined`, `null`, or an empty array.
|
||||
*/
|
||||
provideColorPresentations(color: Color, context: { document: TextDocument, range: Range }, token: CancellationToken): ProviderResult<ColorPresentation[]>;
|
||||
}
|
||||
|
||||
/**
|
||||
* A tuple of two characters, like a pair of
|
||||
* opening and closing brackets.
|
||||
@@ -3311,8 +3621,24 @@ declare module 'vscode' {
|
||||
* used to show editors side by side.
|
||||
*/
|
||||
export enum ViewColumn {
|
||||
/**
|
||||
* A *symbolic* editor column representing the currently
|
||||
* active column. This value can be used when opening editors, but the
|
||||
* *resolved* [viewColumn](#TextEditor.viewColumn)-value of editors will always
|
||||
* be `One`, `Two`, `Three`, or `undefined` but never `Active`.
|
||||
*/
|
||||
Active = -1,
|
||||
/**
|
||||
* The left most editor column.
|
||||
*/
|
||||
One = 1,
|
||||
/**
|
||||
* The center editor column.
|
||||
*/
|
||||
Two = 2,
|
||||
/**
|
||||
* The right most editor column.
|
||||
*/
|
||||
Three = 3
|
||||
}
|
||||
|
||||
@@ -3869,13 +4195,30 @@ declare module 'vscode' {
|
||||
options?: ShellExecutionOptions;
|
||||
}
|
||||
|
||||
/**
|
||||
* The scope of a task.
|
||||
*/
|
||||
export enum TaskScope {
|
||||
/**
|
||||
* The task is a global task
|
||||
*/
|
||||
Global = 1,
|
||||
|
||||
/**
|
||||
* The task is a workspace task
|
||||
*/
|
||||
Workspace = 2
|
||||
}
|
||||
|
||||
/**
|
||||
* A task to execute
|
||||
*/
|
||||
export class Task {
|
||||
|
||||
/**
|
||||
* Creates a new task.
|
||||
* ~~Creates a new task.~~
|
||||
*
|
||||
* @deprecated Use the new constructors that allow specifying a target for the task.
|
||||
*
|
||||
* @param definition The task definition as defined in the taskDefinitions extension point.
|
||||
* @param name The task's name. Is presented in the user interface.
|
||||
@@ -3887,11 +4230,30 @@ declare module 'vscode' {
|
||||
*/
|
||||
constructor(taskDefinition: TaskDefinition, name: string, source: string, execution?: ProcessExecution | ShellExecution, problemMatchers?: string | string[]);
|
||||
|
||||
/**
|
||||
* Creates a new task.
|
||||
*
|
||||
* @param definition The task definition as defined in the taskDefinitions extension point.
|
||||
* @param target Specifies the task's target. It is either a global or a workspace task or a task for a specific workspace folder.
|
||||
* @param name The task's name. Is presented in the user interface.
|
||||
* @param source The task's source (e.g. 'gulp', 'npm', ...). Is presented in the user interface.
|
||||
* @param execution The process or shell execution.
|
||||
* @param problemMatchers the names of problem matchers to use, like '$tsc'
|
||||
* or '$eslint'. Problem matchers can be contributed by an extension using
|
||||
* the `problemMatchers` extension point.
|
||||
*/
|
||||
constructor(taskDefinition: TaskDefinition, target: WorkspaceFolder | TaskScope.Global | TaskScope.Workspace, name: string, source: string, execution?: ProcessExecution | ShellExecution, problemMatchers?: string | string[]);
|
||||
|
||||
/**
|
||||
* The task's definition.
|
||||
*/
|
||||
definition: TaskDefinition;
|
||||
|
||||
/**
|
||||
* The task's scope.
|
||||
*/
|
||||
scope?: TaskScope.Global | TaskScope.Workspace | WorkspaceFolder;
|
||||
|
||||
/**
|
||||
* The task's name
|
||||
*/
|
||||
@@ -4175,8 +4537,9 @@ declare module 'vscode' {
|
||||
* to control where the editor is being shown. Might change the [active editor](#window.activeTextEditor).
|
||||
*
|
||||
* @param document A text document to be shown.
|
||||
* @param column A view column in which the editor should be shown. The default is the [one](#ViewColumn.One), other values
|
||||
* are adjusted to be __Min(column, columnCount + 1)__.
|
||||
* @param column A view column in which the [editor](#TextEditor) should be shown. The default is the [one](#ViewColumn.One), other values
|
||||
* are adjusted to be `Min(column, columnCount + 1)`, the [active](#ViewColumn.Active)-column is
|
||||
* not adjusted.
|
||||
* @param preserveFocus When `true` the editor will not take focus.
|
||||
* @return A promise that resolves to an [editor](#TextEditor).
|
||||
*/
|
||||
@@ -4187,7 +4550,7 @@ declare module 'vscode' {
|
||||
* to control options of the editor is being shown. Might change the [active editor](#window.activeTextEditor).
|
||||
*
|
||||
* @param document A text document to be shown.
|
||||
* @param options [Editor options](#ShowTextDocumentOptions) to configure the behavior of showing the [editor](#TextEditor).
|
||||
* @param options [Editor options](#TextDocumentShowOptions) to configure the behavior of showing the [editor](#TextEditor).
|
||||
* @return A promise that resolves to an [editor](#TextEditor).
|
||||
*/
|
||||
export function showTextDocument(document: TextDocument, options?: TextDocumentShowOptions): Thenable<TextEditor>;
|
||||
@@ -4198,7 +4561,7 @@ declare module 'vscode' {
|
||||
* @see [openTextDocument](#openTextDocument)
|
||||
*
|
||||
* @param uri A resource identifier.
|
||||
* @param options [Editor options](#ShowTextDocumentOptions) to configure the behavior of showing the [editor](#TextEditor).
|
||||
* @param options [Editor options](#TextDocumentShowOptions) to configure the behavior of showing the [editor](#TextEditor).
|
||||
* @return A promise that resolves to an [editor](#TextEditor).
|
||||
*/
|
||||
export function showTextDocument(uri: Uri, options?: TextDocumentShowOptions): Thenable<TextEditor>;
|
||||
@@ -4367,6 +4730,33 @@ declare module 'vscode' {
|
||||
*/
|
||||
export function showQuickPick<T extends QuickPickItem>(items: T[] | Thenable<T[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<T | undefined>;
|
||||
|
||||
/**
|
||||
* Shows a selection list of [workspace folders](#workspace.workspaceFolders) to pick from.
|
||||
* Returns `undefined` if no folder is open.
|
||||
*
|
||||
* @param options Configures the behavior of the workspace folder list.
|
||||
* @return A promise that resolves to the workspace folder or `undefined`.
|
||||
*/
|
||||
export function showWorkspaceFolderPick(options?: WorkspaceFolderPickOptions): Thenable<WorkspaceFolder | undefined>;
|
||||
|
||||
/**
|
||||
* Shows a file open dialog to the user which allows to select a file
|
||||
* for opening-purposes.
|
||||
*
|
||||
* @param options Options that control the dialog.
|
||||
* @returns A promise that resolves to the selected resources or `undefined`.
|
||||
*/
|
||||
export function showOpenDialog(options: OpenDialogOptions): Thenable<Uri[] | undefined>;
|
||||
|
||||
/**
|
||||
* Shows a file save dialog to the user which allows to select a file
|
||||
* for saving-purposes.
|
||||
*
|
||||
* @param options Options that control the dialog.
|
||||
* @returns A promise that resolves to the selected resource or `undefined`.
|
||||
*/
|
||||
export function showSaveDialog(options: SaveDialogOptions): Thenable<Uri | undefined>;
|
||||
|
||||
/**
|
||||
* Opens an input box to ask the user for input.
|
||||
*
|
||||
@@ -4590,6 +4980,10 @@ declare module 'vscode' {
|
||||
* Args for the custom shell executable, this does not work on Windows (see #8429)
|
||||
*/
|
||||
shellArgs?: string[];
|
||||
/**
|
||||
* Object with environment variables that will be added to the VS Code process.
|
||||
*/
|
||||
env?: { [key: string]: string | null };
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -4756,13 +5150,16 @@ declare module 'vscode' {
|
||||
export interface WorkspaceFolder {
|
||||
|
||||
/**
|
||||
* The associated URI for this workspace folder.
|
||||
* The associated uri for this workspace folder.
|
||||
*
|
||||
* *Note:* The [Uri](#Uri)-type was intentionally chosen such that future releases of the editor can support
|
||||
* workspace folders that are not stored on the local disk, e.g. `ftp://server/workspaces/foo`.
|
||||
*/
|
||||
readonly uri: Uri;
|
||||
|
||||
/**
|
||||
* The name of this workspace folder. Defaults to
|
||||
* the basename its [uri-path](#Uri.path)
|
||||
* the basename of its [uri-path](#Uri.path)
|
||||
*/
|
||||
readonly name: string;
|
||||
|
||||
@@ -4801,14 +5198,23 @@ declare module 'vscode' {
|
||||
*/
|
||||
export let workspaceFolders: WorkspaceFolder[] | undefined;
|
||||
|
||||
/**
|
||||
* The name of the workspace. `undefined` when no folder
|
||||
* has been opened.
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
export let name: string | undefined;
|
||||
|
||||
/**
|
||||
* An event that is emitted when a workspace folder is added or removed.
|
||||
*/
|
||||
export const onDidChangeWorkspaceFolders: Event<WorkspaceFoldersChangeEvent>;
|
||||
|
||||
/**
|
||||
* Returns a [workspace folder](#WorkspaceFolder) for the provided resource. When the resource
|
||||
* is a workspace folder itself, its parent workspace folder or `undefined` is returned.
|
||||
* Returns the [workspace folder](#WorkspaceFolder) that contains a given uri.
|
||||
* * returns `undefined` when the given uri doesn't match any workspace folder
|
||||
* * returns the *input* when the given uri is a workspace folder itself
|
||||
*
|
||||
* @param uri An uri.
|
||||
* @return A workspace folder or `undefined`
|
||||
@@ -4832,30 +5238,35 @@ declare module 'vscode' {
|
||||
/**
|
||||
* Creates a file system watcher.
|
||||
*
|
||||
* A glob pattern that filters the file events must be provided. Optionally, flags to ignore certain
|
||||
* kinds of events can be provided. To stop listening to events the watcher must be disposed.
|
||||
* A glob pattern that filters the file events on their absolute path must be provided. Optionally,
|
||||
* flags to ignore certain kinds of events can be provided. To stop listening to events the watcher must be disposed.
|
||||
*
|
||||
* *Note* that only files within the current [workspace folders](#workspace.workspaceFolders) can be watched.
|
||||
*
|
||||
* @param globPattern A glob pattern that is applied to the names of created, changed, and deleted files.
|
||||
* @param globPattern A [glob pattern](#GlobPattern) that is applied to the absolute paths of created, changed,
|
||||
* and deleted files. Use a [relative pattern](#RelativePattern) to limit events to a certain [workspace folder](#WorkspaceFolder).
|
||||
* @param ignoreCreateEvents Ignore when files have been created.
|
||||
* @param ignoreChangeEvents Ignore when files have been changed.
|
||||
* @param ignoreDeleteEvents Ignore when files have been deleted.
|
||||
* @return A new file system watcher instance.
|
||||
*/
|
||||
export function createFileSystemWatcher(globPattern: string, ignoreCreateEvents?: boolean, ignoreChangeEvents?: boolean, ignoreDeleteEvents?: boolean): FileSystemWatcher;
|
||||
export function createFileSystemWatcher(globPattern: GlobPattern, ignoreCreateEvents?: boolean, ignoreChangeEvents?: boolean, ignoreDeleteEvents?: boolean): FileSystemWatcher;
|
||||
|
||||
/**
|
||||
* Find files in the workspace.
|
||||
* Find files across all [workspace folders](#workspace.workspaceFolders) in the workspace.
|
||||
*
|
||||
* @sample `findFiles('**∕*.js', '**∕node_modules∕**', 10)`
|
||||
* @param include A glob pattern that defines the files to search for.
|
||||
* @param exclude A glob pattern that defines files and folders to exclude.
|
||||
* @param include A [glob pattern](#GlobPattern) that defines the files to search for. The glob pattern
|
||||
* will be matched against the file paths of resulting matches relative to their workspace. Use a [relative pattern](#RelativePattern)
|
||||
* to restrict the search results to a [workspace folder](#WorkspaceFolder).
|
||||
* @param exclude A [glob pattern](#GlobPattern) that defines files and folders to exclude. The glob pattern
|
||||
* will be matched against the file paths of resulting matches relative to their workspace.
|
||||
* @param maxResults An upper-bound for the result.
|
||||
* @param token A token that can be used to signal cancellation to the underlying search engine.
|
||||
* @return A thenable that resolves to an array of resource identifiers.
|
||||
* @return A thenable that resolves to an array of resource identifiers. Will return no results if no
|
||||
* [workspace folders](#workspace.workspaceFolders) are opened.
|
||||
*/
|
||||
export function findFiles(include: string, exclude?: string, maxResults?: number, token?: CancellationToken): Thenable<Uri[]>;
|
||||
export function findFiles(include: GlobPattern, exclude?: GlobPattern, maxResults?: number, token?: CancellationToken): Thenable<Uri[]>;
|
||||
|
||||
/**
|
||||
* Save all dirty files.
|
||||
@@ -4947,7 +5358,7 @@ declare module 'vscode' {
|
||||
/**
|
||||
* An event that is emitted when a [text document](#TextDocument) is changed. This usually happens
|
||||
* when the [contents](#TextDocument.getText) changes but also when other things like the
|
||||
* [dirty](TextDocument#isDirty)-state changes.
|
||||
* [dirty](#TextDocument.isDirty)-state changes.
|
||||
*/
|
||||
export const onDidChangeTextDocument: Event<TextDocumentChangeEvent>;
|
||||
|
||||
@@ -4989,7 +5400,7 @@ declare module 'vscode' {
|
||||
/**
|
||||
* An event that is emitted when the [configuration](#WorkspaceConfiguration) changed.
|
||||
*/
|
||||
export const onDidChangeConfiguration: Event<void>;
|
||||
export const onDidChangeConfiguration: Event<ConfigurationChangeEvent>;
|
||||
|
||||
/**
|
||||
* Register a task provider.
|
||||
@@ -5001,6 +5412,21 @@ declare module 'vscode' {
|
||||
export function registerTaskProvider(type: string, provider: TaskProvider): Disposable;
|
||||
}
|
||||
|
||||
/**
|
||||
* An event describing the change in Configuration
|
||||
*/
|
||||
export interface ConfigurationChangeEvent {
|
||||
|
||||
/**
|
||||
* Returns `true` if the given section for the given resource (if provided) is affected.
|
||||
*
|
||||
* @param section Configuration name, supports _dotted_ names.
|
||||
* @param resource A resource Uri.
|
||||
* @return `true` if the given section for the given resource (if provided) is affected.
|
||||
*/
|
||||
affectsConfiguration(section: string, resource?: Uri): boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Namespace for participating in language-specific editor [features](https://code.visualstudio.com/docs/editor/editingevolved),
|
||||
* like IntelliSense, code actions, diagnostics etc.
|
||||
@@ -5314,6 +5740,19 @@ declare module 'vscode' {
|
||||
*/
|
||||
export function registerDocumentLinkProvider(selector: DocumentSelector, provider: DocumentLinkProvider): Disposable;
|
||||
|
||||
/**
|
||||
* Register a color provider.
|
||||
*
|
||||
* Multiple providers can be registered for a language. In that case providers are asked in
|
||||
* parallel and the results are merged. A failing provider (rejected promise or exception) will
|
||||
* not cause a failure of the whole operation.
|
||||
*
|
||||
* @param selector A selector that defines the documents this provider is applicable to.
|
||||
* @param provider A color provider.
|
||||
* @return A [disposable](#Disposable) that unregisters this provider when being disposed.
|
||||
*/
|
||||
export function registerColorProvider(selector: DocumentSelector, provider: DocumentColorProvider): Disposable;
|
||||
|
||||
/**
|
||||
* Set a [language configuration](#LanguageConfiguration) for a language.
|
||||
*
|
||||
@@ -5469,6 +5908,11 @@ declare module 'vscode' {
|
||||
*/
|
||||
readonly label: string;
|
||||
|
||||
/**
|
||||
* The (optional) Uri of the root of this source control.
|
||||
*/
|
||||
readonly rootUri: Uri | undefined;
|
||||
|
||||
/**
|
||||
* The [input box](#SourceControlInputBox) for this source control.
|
||||
*/
|
||||
@@ -5528,7 +5972,7 @@ declare module 'vscode' {
|
||||
* ~~The [input box](#SourceControlInputBox) for the last source control
|
||||
* created by the extension.~~
|
||||
*
|
||||
* @deprecated Use [SourceControl.inputBox](#SourceControl.inputBox) instead
|
||||
* @deprecated Use SourceControl.inputBox instead
|
||||
*/
|
||||
export const inputBox: SourceControlInputBox;
|
||||
|
||||
@@ -5537,9 +5981,10 @@ declare module 'vscode' {
|
||||
*
|
||||
* @param id An `id` for the source control. Something short, eg: `git`.
|
||||
* @param label A human-readable string for the source control. Eg: `Git`.
|
||||
* @param rootUri An optional Uri of the root of the source control. Eg: `Uri.parse(workspaceRoot)`.
|
||||
* @return An instance of [source control](#SourceControl).
|
||||
*/
|
||||
export function createSourceControl(id: string, label: string): SourceControl;
|
||||
export function createSourceControl(id: string, label: string, rootUri?: Uri): SourceControl;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user