@vscode/chat-lib 0.0.1 → 0.0.2

package/src/_internal/extension/vscode.proposed.terminalQuickFixProvider.d.ts

@@ -1,87 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-
-declare module 'vscode' {
-
-	// https://github.com/microsoft/vscode/issues/162950
-
-	export type SingleOrMany<T> = T[] | T;
-
-	export interface TerminalQuickFixProvider {
-		/**
-		 * Provides terminal quick fixes
-		 * @param commandMatchResult The command match result for which to provide quick fixes
-		 * @param token A cancellation token indicating the result is no longer needed
-		 * @return Terminal quick fix(es) if any
-		 */
-		provideTerminalQuickFixes(commandMatchResult: TerminalCommandMatchResult, token: CancellationToken): ProviderResult<SingleOrMany<TerminalQuickFixTerminalCommand | TerminalQuickFixOpener | Command>>;
-	}
-
-
-	export interface TerminalCommandMatchResult {
-		commandLine: string;
-		commandLineMatch: RegExpMatchArray;
-		outputMatch?: {
-			regexMatch: RegExpMatchArray;
-			outputLines: string[];
-		};
-	}
-
-	export namespace window {
-		/**
-		 * @param provider A terminal quick fix provider
-		 * @return A {@link Disposable} that unregisters the provider when being disposed
-		 */
-		export function registerTerminalQuickFixProvider(id: string, provider: TerminalQuickFixProvider): Disposable;
-	}
-
-	export class TerminalQuickFixTerminalCommand {
-		/**
-		 * The terminal command to insert or run
-		 */
-		terminalCommand: string;
-		/**
-		 * Whether the command should be executed or just inserted (default)
-		 */
-		shouldExecute?: boolean;
-		constructor(terminalCommand: string, shouldExecute?: boolean);
-	}
-	export class TerminalQuickFixOpener {
-		/**
-		 * The uri to open
-		 */
-		uri: Uri;
-		constructor(uri: Uri);
-	}
-
-	/**
-	 * A matcher that runs on a sub-section of a terminal command's output
-	 */
-	interface TerminalOutputMatcher {
-		/**
-		 * A string or regex to match against the unwrapped line. If this is a regex with the multiline
-		 * flag, it will scan an amount of lines equal to `\n` instances in the regex + 1.
-		 */
-		lineMatcher: string | RegExp;
-		/**
-		 * Which side of the output to anchor the {@link offset} and {@link length} against.
-		 */
-		anchor: TerminalOutputAnchor;
-		/**
-			 * The number of rows above or below the {@link anchor} to start matching against.
-			 */
-		offset: number;
-		/**
-		 * The number of wrapped lines to match against, this should be as small as possible for performance
-		 * reasons. This is capped at 40.
-		 */
-		length: number;
-	}
-
-	enum TerminalOutputAnchor {
-		Top = 0,
-		Bottom = 1
-	}
-}

package/src/_internal/extension/vscode.proposed.terminalSelection.d.ts

@@ -1,16 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-
-declare module 'vscode' {
-
-	// https://github.com/microsoft/vscode/issues/188173
-
-	export interface Terminal {
-		/**
-		 * The selected text of the terminal or undefined if there is no selection.
-		 */
-		readonly selection: string | undefined;
-	}
-}

package/src/_internal/extension/vscode.proposed.testObserver.d.ts

@@ -1,199 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-
-declare module 'vscode' {
-
-	// https://github.com/microsoft/vscode/issues/107467
-
-	export namespace tests {
-		/**
-		 * Requests that tests be run by their controller.
-		 * @param run Run options to use.
-		 * @param token Cancellation token for the test run
-		 */
-		export function runTests(run: TestRunRequest, token?: CancellationToken): Thenable<void>;
-
-		/**
-		 * Registers a provider that can provide follow-up actions for a test failure.
-		 */
-		export function registerTestFollowupProvider(provider: TestFollowupProvider): Disposable;
-
-		/**
-		 * Returns an observer that watches and can request tests.
-		 */
-		export function createTestObserver(): TestObserver;
-		/**
-		 * List of test results stored by the editor, sorted in descending
-		 * order by their `completedAt` time.
-		 */
-		export const testResults: ReadonlyArray<TestRunResult>;
-
-		/**
-		 * Event that fires when the {@link testResults} array is updated.
-		 */
-		export const onDidChangeTestResults: Event<void>;
-	}
-
-	export interface TestFollowupProvider {
-		provideFollowup(result: TestRunResult, test: TestResultSnapshot, taskIndex: number, messageIndex: number, token: CancellationToken): ProviderResult<Command[]>;
-	}
-
-	export interface TestObserver {
-		/**
-		 * List of tests returned by test provider for files in the workspace.
-		 */
-		readonly tests: ReadonlyArray<TestItem>;
-
-		/**
-		 * An event that fires when an existing test in the collection changes, or
-		 * null if a top-level test was added or removed. When fired, the consumer
-		 * should check the test item and all its children for changes.
-		 */
-		readonly onDidChangeTest: Event<TestsChangeEvent>;
-
-		/**
-		 * Dispose of the observer, allowing the editor to eventually tell test
-		 * providers that they no longer need to update tests.
-		 */
-		dispose(): void;
-	}
-
-	export interface TestsChangeEvent {
-		/**
-		 * List of all tests that are newly added.
-		 */
-		readonly added: ReadonlyArray<TestItem>;
-
-		/**
-		 * List of existing tests that have updated.
-		 */
-		readonly updated: ReadonlyArray<TestItem>;
-
-		/**
-		 * List of existing tests that have been removed.
-		 */
-		readonly removed: ReadonlyArray<TestItem>;
-	}
-
-	/**
-	 * TestResults can be provided to the editor in {@link tests.publishTestResult},
-	 * or read from it in {@link tests.testResults}.
-	 *
-	 * The results contain a 'snapshot' of the tests at the point when the test
-	 * run is complete. Therefore, information such as its {@link Range} may be
-	 * out of date. If the test still exists in the workspace, consumers can use
-	 * its `id` to correlate the result instance with the living test.
-	 */
-	export interface TestRunResult {
-		/**
-		 * Unix milliseconds timestamp at which the test run was completed.
-		 */
-		readonly completedAt: number;
-
-		/**
-		 * Optional raw output from the test run.
-		 */
-		readonly output?: string;
-
-		/**
-		 * List of test results. The items in this array are the items that
-		 * were passed in the {@link tests.runTests} method.
-		 */
-		readonly results: ReadonlyArray<Readonly<TestResultSnapshot>>;
-
-		/**
-		 * Gets coverage information for a URI. This function is available only
-		 * when a test run reported coverage.
-		 */
-		getDetailedCoverage?(uri: Uri, token?: CancellationToken): Thenable<FileCoverageDetail[]>;
-	}
-
-	/**
-	 * A {@link TestItem}-like interface with an associated result, which appear
-	 * or can be provided in {@link TestResult} interfaces.
-	 */
-	export interface TestResultSnapshot {
-		/**
-		 * Unique identifier that matches that of the associated TestItem.
-		 * This is used to correlate test results and tests in the document with
-		 * those in the workspace (test explorer).
-		 */
-		readonly id: string;
-
-		/**
-		 * Parent of this item.
-		 */
-		readonly parent?: TestResultSnapshot;
-
-		/**
-		 * URI this TestItem is associated with. May be a file or file.
-		 */
-		readonly uri?: Uri;
-
-		/**
-		 * Display name describing the test case.
-		 */
-		readonly label: string;
-
-		/**
-		 * Optional description that appears next to the label.
-		 */
-		readonly description?: string;
-
-		/**
-		 * Location of the test item in its `uri`. This is only meaningful if the
-		 * `uri` points to a file.
-		 */
-		readonly range?: Range;
-
-		/**
-		 * State of the test in each task. In the common case, a test will only
-		 * be executed in a single task and the length of this array will be 1.
-		 */
-		readonly taskStates: ReadonlyArray<TestSnapshotTaskState>;
-
-		/**
-		 * Optional list of nested tests for this item.
-		 */
-		readonly children: Readonly<TestResultSnapshot>[];
-	}
-
-	export interface TestSnapshotTaskState {
-		/**
-		 * Current result of the test.
-		 */
-		readonly state: TestResultState;
-
-		/**
-		 * The number of milliseconds the test took to run. This is set once the
-		 * `state` is `Passed`, `Failed`, or `Errored`.
-		 */
-		readonly duration?: number;
-
-		/**
-		 * Associated test run message. Can, for example, contain assertion
-		 * failure information if the test fails.
-		 */
-		readonly messages: ReadonlyArray<TestMessage>;
-	}
-
-	/**
-	 * Possible states of tests in a test run.
-	 */
-	export enum TestResultState {
-		// Test will be run, but is not currently running.
-		Queued = 1,
-		// Test is currently running
-		Running = 2,
-		// Test run has passed
-		Passed = 3,
-		// Test run has failed (on an assertion)
-		Failed = 4,
-		// Test run has been skipped
-		Skipped = 5,
-		// Test run failed for some other reason (compilation error, timeout, etc)
-		Errored = 6
-	}
-}

package/src/_internal/extension/vscode.proposed.textDocumentChangeReason.d.ts

@@ -1,30 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-
-declare module 'vscode' {
-
-	/**
-	 * Detailed information about why a text document changed.
-	 */
-	export interface TextDocumentDetailedChangeReason {
-		/**
-		 * The source of the change (e.g., 'inline-completion', 'chat-edit', 'extension')
-		 */
-		readonly source: string;
-
-		/**
-		 * Additional context-specific metadata
-		 */
-		readonly metadata: { readonly [key: string]: any };
-	}
-
-	export interface TextDocumentChangeEvent {
-		/**
-		 * The precise reason for the document change.
-		 * Only available to extensions that have enabled the `textDocumentChangeReason` proposed API.
-		 */
-		readonly detailedReason?: TextDocumentDetailedChangeReason | undefined;
-	}
-}

package/src/_internal/extension/vscode.proposed.textSearchProvider.d.ts

@@ -1,281 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-
-declare module 'vscode' {
-
-	// https://github.com/microsoft/vscode/issues/59921
-
-	/**
-	 * The parameters of a query for text search.
-	 */
-	export interface TextSearchQuery {
-		/**
-		 * The text pattern to search for.
-		 */
-		pattern: string;
-
-		/**
-		 * Whether or not `pattern` should match multiple lines of text.
-		 */
-		isMultiline?: boolean;
-
-		/**
-		 * Whether or not `pattern` should be interpreted as a regular expression.
-		 */
-		isRegExp?: boolean;
-
-		/**
-		 * Whether or not the search should be case-sensitive.
-		 */
-		isCaseSensitive?: boolean;
-
-		/**
-		 * Whether or not to search for whole word matches only.
-		 */
-		isWordMatch?: boolean;
-	}
-
-	/**
-	 * A file glob pattern to match file paths against.
-	 * TODO@roblourens merge this with the GlobPattern docs/definition in vscode.d.ts.
-	 * @see {@link GlobPattern}
-	 */
-	export type GlobString = string;
-
-	/**
-	 * Options common to file and text search
-	 */
-	export interface SearchOptions {
-		/**
-		 * The root folder to search within.
-		 */
-		folder: Uri;
-
-		/**
-		 * Files that match an `includes` glob pattern should be included in the search.
-		 */
-		includes: GlobString[];
-
-		/**
-		 * Files that match an `excludes` glob pattern should be excluded from the search.
-		 */
-		excludes: GlobString[];
-
-		/**
-		 * Whether external files that exclude files, like .gitignore, should be respected.
-		 * See the vscode setting `"search.useIgnoreFiles"`.
-		 */
-		useIgnoreFiles: boolean;
-
-		/**
-		 * Whether symlinks should be followed while searching.
-		 * See the vscode setting `"search.followSymlinks"`.
-		 */
-		followSymlinks: boolean;
-
-		/**
-		 * Whether global files that exclude files, like .gitignore, should be respected.
-		 * See the vscode setting `"search.useGlobalIgnoreFiles"`.
-		 */
-		useGlobalIgnoreFiles: boolean;
-
-		/**
-		 * Whether files in parent directories that exclude files, like .gitignore, should be respected.
-		 * See the vscode setting `"search.useParentIgnoreFiles"`.
-		 */
-		useParentIgnoreFiles: boolean;
-	}
-
-	/**
-	 * Options to specify the size of the result text preview.
-	 * These options don't affect the size of the match itself, just the amount of preview text.
-	 */
-	export interface TextSearchPreviewOptions {
-		/**
-		 * The maximum number of lines in the preview.
-		 * Only search providers that support multiline search will ever return more than one line in the match.
-		 */
-		matchLines: number;
-
-		/**
-		 * The maximum number of characters included per line.
-		 */
-		charsPerLine: number;
-	}
-
-	/**
-	 * Options that apply to text search.
-	 */
-	export interface TextSearchOptions extends SearchOptions {
-		/**
-		 * The maximum number of results to be returned.
-		 */
-		maxResults: number;
-
-		/**
-		 * Options to specify the size of the result text preview.
-		 */
-		previewOptions?: TextSearchPreviewOptions;
-
-		/**
-		 * Exclude files larger than `maxFileSize` in bytes.
-		 */
-		maxFileSize?: number;
-
-		/**
-		 * Interpret files using this encoding.
-		 * See the vscode setting `"files.encoding"`
-		 */
-		encoding?: string;
-
-		/**
-		 * Number of lines of context to include before each match.
-		 */
-		beforeContext?: number;
-
-		/**
-		 * Number of lines of context to include after each match.
-		 */
-		afterContext?: number;
-	}
-
-	/**
-	 * Represents the severity of a TextSearchComplete message.
-	 */
-	export enum TextSearchCompleteMessageType {
-		Information = 1,
-		Warning = 2,
-	}
-
-	/**
-	 * A message regarding a completed search.
-	 */
-	export interface TextSearchCompleteMessage {
-		/**
-		 * Markdown text of the message.
-		 */
-		text: string;
-		/**
-		 * Whether the source of the message is trusted, command links are disabled for untrusted message sources.
-		 * Messaged are untrusted by default.
-		 */
-		trusted?: boolean;
-		/**
-		 * The message type, this affects how the message will be rendered.
-		 */
-		type: TextSearchCompleteMessageType;
-	}
-
-	/**
-	 * Information collected when text search is complete.
-	 */
-	export interface TextSearchComplete {
-		/**
-		 * Whether the search hit the limit on the maximum number of search results.
-		 * `maxResults` on {@linkcode TextSearchOptions} specifies the max number of results.
-		 * - If exactly that number of matches exist, this should be false.
-		 * - If `maxResults` matches are returned and more exist, this should be true.
-		 * - If search hits an internal limit which is less than `maxResults`, this should be true.
-		 */
-		limitHit?: boolean;
-
-		/**
-		 * Additional information regarding the state of the completed search.
-		 *
-		 * Messages with "Information" style support links in markdown syntax:
-		 * - Click to [run a command](command:workbench.action.OpenQuickPick)
-		 * - Click to [open a website](https://aka.ms)
-		 *
-		 * Commands may optionally return { triggerSearch: true } to signal to the editor that the original search should run be again.
-		 */
-		message?: TextSearchCompleteMessage | TextSearchCompleteMessage[];
-	}
-
-	/**
-	 * A preview of the text result.
-	 */
-	export interface TextSearchMatchPreview {
-		/**
-		 * The matching lines of text, or a portion of the matching line that contains the match.
-		 */
-		text: string;
-
-		/**
-		 * The Range within `text` corresponding to the text of the match.
-		 * The number of matches must match the TextSearchMatch's range property.
-		 */
-		matches: Range | Range[];
-	}
-
-	/**
-	 * A match from a text search
-	 */
-	export interface TextSearchMatch {
-		/**
-		 * The uri for the matching document.
-		 */
-		uri: Uri;
-
-		/**
-		 * The range of the match within the document, or multiple ranges for multiple matches.
-		 */
-		ranges: Range | Range[];
-
-		/**
-		 * A preview of the text match.
-		 */
-		preview: TextSearchMatchPreview;
-	}
-
-	/**
-	 * A line of context surrounding a TextSearchMatch.
-	 */
-	export interface TextSearchContext {
-		/**
-		 * The uri for the matching document.
-		 */
-		uri: Uri;
-
-		/**
-		 * One line of text.
-		 * previewOptions.charsPerLine applies to this
-		 */
-		text: string;
-
-		/**
-		 * The line number of this line of context.
-		 */
-		lineNumber: number;
-	}
-
-	export type TextSearchResult = TextSearchMatch | TextSearchContext;
-
-	/**
-	 * A TextSearchProvider provides search results for text results inside files in the workspace.
-	 */
-	export interface TextSearchProvider {
-		/**
-		 * Provide results that match the given text pattern.
-		 * @param query The parameters for this query.
-		 * @param options A set of options to consider while searching.
-		 * @param progress A progress callback that must be invoked for all results.
-		 * @param token A cancellation token.
-		 */
-		provideTextSearchResults(query: TextSearchQuery, options: TextSearchOptions, progress: Progress<TextSearchResult>, token: CancellationToken): ProviderResult<TextSearchComplete>;
-	}
-
-	export namespace workspace {
-		/**
-		 * Register a text search provider.
-		 *
-		 * Only one provider can be registered per scheme.
-		 *
-		 * @param scheme The provider will be invoked for workspace folders that have this file scheme.
-		 * @param provider The provider.
-		 * @return A {@link Disposable} that unregisters this provider when being disposed.
-		 */
-		export function registerTextSearchProvider(scheme: string, provider: TextSearchProvider): Disposable;
-	}
-}