@codingame/monaco-vscode-api 21.6.0 → 22.0.0

package/vscode-dts/vscode.proposed.terminalCompletionProvider.d.ts

@@ -7,10 +7,22 @@ declare module 'vscode' {
 
 	// https://github.com/microsoft/vscode/issues/226562
 
+	/**
+	 * A provider that supplies terminal completion items.
+	 *
+	 * Implementations of this interface should return an array of {@link TerminalCompletionItem} or a
+	 * {@link TerminalCompletionList} describing completions for the current command line.
+	 *
+	 * @example <caption>Simple provider returning a single completion</caption>
+	 * window.registerTerminalCompletionProvider('extension-provider-id', {
+	 * 	provideTerminalCompletions(terminal, context) {
+	 * 		return [{ label: '--help', replacementIndex: Math.max(0, context.cursorPosition - 2), replacementLength: 2 }];
+	 * 	}
+	 * });
+	 */
 	export interface TerminalCompletionProvider<T extends TerminalCompletionItem> {
-		id: string;
 		/**
-		 * Provide completions for the given position and document.
+		 * Provide completions for the given terminal and context.
 		 * @param terminal The terminal for which completions are being provided.
 		 * @param context Information about the terminal's current state.
 		 * @param token A cancellation token.
@@ -20,6 +32,21 @@ declare module 'vscode' {
 	}
 
 
+	/**
+	 * Represents a completion suggestion for a terminal command line.
+	 *
+	 * @example <caption>Completion item for `ls -|`</caption>
+	 * const item = {
+	 * 	label: '-A',
+	 * 	replacementIndex: 3,
+	 * 	replacementLength: 1,
+	 * 	detail: 'List all entries except for . and .. (always set for the super-user)',
+	 * 	kind: TerminalCompletionItemKind.Flag
+	 * };
+	 *
+	 * The fields on a completion item describe what text should be shown to the user
+	 * and which portion of the command line should be replaced when the item is accepted.
+	 */
 	export interface TerminalCompletionItem {
 		/**
 		 * The label of the completion.
@@ -41,7 +68,6 @@ declare module 'vscode' {
 		 */
 		detail?: string;
 
-
 		/**
 		 * A human-readable string that represents a doc-comment.
 		 */
@@ -55,7 +81,11 @@ declare module 'vscode' {
 
 
 	/**
-	 * Terminal item kinds.
+	 * The kind of an individual terminal completion item.
+	 *
+	 * The kind is used to render an appropriate icon in the suggest list and to convey the semantic
+	 * meaning of the suggestion (file, folder, flag, commit, branch, etc.).
+	 *
 	 */
 	export enum TerminalCompletionItemKind {
 		File = 0,
@@ -77,6 +107,13 @@ declare module 'vscode' {
 		PullRequestDone = 16,
 	}
 
+
+	/**
+	 * Context information passed to {@link TerminalCompletionProvider.provideTerminalCompletions}.
+	 *
+	 * It contains the full command line, the current cursor position, and a flag indicating whether
+	 * fallback completions are allowed when the exact completion type cannot be determined.
+	 */
 	export interface TerminalCompletionContext {
 		/**
 		 * The complete terminal command line.
@@ -95,17 +132,31 @@ declare module 'vscode' {
 
 	export namespace window {
 		/**
-		 * Register a completion provider for a certain type of terminal.
-		 *
+		 * Register a completion provider for terminals.
+		 * @param id The unique identifier of the terminal provider, used as a settings key and shown in the information hover of the suggest widget.
 		 * @param provider The completion provider.
 		 * @returns A {@link Disposable} that unregisters this provider when being disposed.
-		 */
-		export function registerTerminalCompletionProvider<T extends TerminalCompletionItem>(provider: TerminalCompletionProvider<T>, ...triggerCharacters: string[]): Disposable;
+		 *
+		 * @example <caption>Register a provider for an extension</caption>
+		 * window.registerTerminalCompletionProvider('extension-provider-id', {
+		 * 	provideTerminalCompletions(terminal, context) {
+		 * 		return new TerminalCompletionList([
+		 * 			{ label: '--version', replacementIndex: Math.max(0, context.cursorPosition - 2), replacementLength: 2 }
+		 * 		]);
+		 * 	}
+		 * });
+		 */
+		export function registerTerminalCompletionProvider<T extends TerminalCompletionItem>(id: string, provider: TerminalCompletionProvider<T>, ...triggerCharacters: string[]): Disposable;
 	}
 
 	/**
 	 * Represents a collection of {@link TerminalCompletionItem completion items} to be presented
 	 * in the terminal.
+	 *
+	 * @example <caption>Create a completion list that requests files for the terminal cwd</caption>
+	 * const list = new TerminalCompletionList([
+	 * 	{ label: 'ls', replacementIndex: 0, replacementLength: 0, kind: TerminalCompletionItemKind.Method }
+	 * ], { filesRequested: true, cwd: Uri.file('/home/user') });
 	 */
 	export class TerminalCompletionList<T extends TerminalCompletionItem = TerminalCompletionItem> {
 
@@ -128,6 +179,13 @@ declare module 'vscode' {
 		constructor(items?: T[], resourceRequestConfig?: TerminalResourceRequestConfig);
 	}
 
+
+	/**
+	 * Configuration for requesting file and folder resources to be shown as completions.
+	 *
+	 * When a provider indicates that it wants file/folder resources, the terminal will surface completions for files and
+	 * folders that match {@link globPattern} from the provided {@link cwd}.
+	 */
 	export interface TerminalResourceRequestConfig {
 		/**
 		 * Show files as completion items.
@@ -138,16 +196,12 @@ declare module 'vscode' {
 		 */
 		foldersRequested?: boolean;
 		/**
-		 * File extensions to filter by.
-		 */
-		fileExtensions?: string[];
-		/**
-		 * If no cwd is provided, no resources will be shown as completions.
+		 * A {@link GlobPattern glob pattern} that controls which files suggest should surface.
 		 */
-		cwd?: Uri;
+		globPattern?: GlobPattern;
 		/**
-		 * Environment variables to use when constructing paths.
+		 * The cwd from which to request resources.
 		 */
-		env?: { [key: string]: string | null | undefined };
+		cwd: Uri;
 	}
 }

package/vscode/src/vs/workbench/contrib/chat/common/chatLayoutService.d.ts

@@ -1,8 +0,0 @@
-export interface ChatFontSize {
-    readonly xs: number;
-    readonly s: number;
-    readonly m: number;
-    readonly l: number;
-    readonly xl: number;
-    readonly xxl: number;
-}

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/frontMatterCodec/tokens/index.d.ts

@@ -1,5 +0,0 @@
-export { FrontMatterArray } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/frontMatterCodec/tokens/frontMatterArray";
-export { FrontMatterString } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/frontMatterCodec/tokens/frontMatterString";
-export { FrontMatterBoolean } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/frontMatterCodec/tokens/frontMatterBoolean";
-export { FrontMatterToken, FrontMatterValueToken } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/frontMatterCodec/tokens/frontMatterToken";
-export { FrontMatterRecordName, FrontMatterRecordDelimiter, FrontMatterRecord, type TNameToken as TRecordNameToken, } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/frontMatterCodec/tokens/frontMatterRecord";

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/tokens.d.ts

@@ -1,20 +0,0 @@
-export { At } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/at";
-export { Tab } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/tab";
-export { Dash } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/dash";
-export { Hash } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/hash";
-export { Word } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/word";
-export { Colon } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/colon";
-export { Quote } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/quote";
-export { Slash } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/slash";
-export { Space } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/space";
-export { Comma } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/comma";
-export { FormFeed } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/formFeed";
-export { DollarSign } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/dollarSign";
-export { VerticalTab } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/verticalTab";
-export { DoubleQuote } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/doubleQuote";
-export { ExclamationMark } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/exclamationMark";
-export { SimpleToken, SpacingToken } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/simpleToken";
-export { type TBracket, LeftBracket, RightBracket } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/brackets";
-export { type TCurlyBrace, LeftCurlyBrace, RightCurlyBrace } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/curlyBraces";
-export { type TParenthesis, LeftParenthesis, RightParenthesis } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/parentheses";
-export { type TAngleBracket, LeftAngleBracket, RightAngleBracket } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/angleBrackets";

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/contentProviders/types.d.ts

@@ -1,55 +0,0 @@
-import { URI } from "../../../../../../base/common/uri.js";
-import { Event } from "../../../../../../base/common/event.js";
-import { ResolveError } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptFileReferenceErrors";
-import { IDisposable } from "../../../../../../base/common/lifecycle.js";
-import { VSBufferReadableStream } from "../../../../../../base/common/buffer.js";
-import { PromptsType } from "@codingame/monaco-vscode-e28ac690-06d5-5ee9-92d1-02df70296354-common/vscode/vs/workbench/contrib/chat/common/promptSyntax/promptTypes";
-import { CancellationToken } from "../../../../../../base/common/cancellation.js";
-import { IPromptContentsProviderOptions } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/contentProviders/promptContentsProviderBase";
-/**
- * Interface for a prompt contents provider. Prompt contents providers are
- * responsible for providing contents of a prompt as a byte streams and
- * allow to subscribe to the change events of the prompt contents.
- */
-export interface IPromptContentsProvider extends IDisposable {
-    /**
-     * URI component of the prompt associated with this contents provider.
-     */
-    readonly uri: URI;
-    /**
-     * Language ID of the prompt contents.
-     */
-    readonly languageId: string;
-    /**
-     * Prompt type used to determine how to interpret file contents.
-     */
-    readonly promptType: PromptsType | "non-prompt";
-    /**
-     * Prompt contents stream.
-     */
-    readonly contents: Promise<VSBufferReadableStream>;
-    /**
-     * Prompt contents source name.
-     */
-    readonly sourceName: string;
-    /**
-     * Event that fires when the prompt contents change. The event is either a
-     * {@linkcode VSBufferReadableStream} stream with changed contents or
-     * an instance of the {@linkcode ResolveError} error.
-     */
-    readonly onContentChanged: Event<VSBufferReadableStream | ResolveError>;
-    /**
-     * Subscribe to `onDispose` event of the contents provider.
-     */
-    readonly onDispose: Event<void>;
-    /**
-     * Start the contents provider to produce the underlying contents.
-     */
-    start(token?: CancellationToken): this;
-    /**
-     * Create a new instance of prompt contents provider.
-     */
-    createNew(promptContentsSource: {
-        uri: URI;
-    }, options: IPromptContentsProviderOptions): IPromptContentsProvider;
-}

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/parsers/types.d.ts

@@ -1,91 +0,0 @@
-import { URI } from "../../../../../../base/common/uri.js";
-import { ResolveError } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptFileReferenceErrors";
-import { IRange, Range } from "../../../../../../editor/common/core/range.js";
-/**
- * A resolve error with a parent prompt URI, if any.
- */
-export interface IResolveError {
-    /**
-     * Original error instance.
-     */
-    readonly originalError: ResolveError;
-    /**
-     * URI of the parent that references this error.
-     */
-    readonly parentUri?: URI;
-}
-/**
- * Top most error of the reference tree.
- */
-export interface ITopError extends IResolveError {
-    /**
-     * Where does the error belong to:
-     *
-     *  - `root` - the error is the top most error of the entire tree
-     *  - `child` - the error is a child of the root error
-     *  - `indirect-child` - the error is a child of a child of the root error
-     */
-    readonly errorSubject: "root" | "child" | "indirect-child";
-    /**
-     * Total number of all errors in the references tree, including the error
-     * of the current reference and all possible errors of its children.
-     */
-    readonly errorsCount: number;
-    /**
-     * Localized error message.
-     */
-    readonly localizedMessage: string;
-}
-/**
- * Base interface for a generic prompt reference.
- */
-interface IPromptReferenceBase {
-    /**
-     * Type of the prompt reference. E.g., `file`, `http`, `image`, etc.
-     */
-    readonly type: string;
-    /**
-     * Subtype of the prompt reference. For instance a `file` reference
-     * can be a `markdown link` or a prompt `#file:` variable reference.
-     */
-    readonly subtype: string;
-    /**
-     * URI component of the associated with this reference.
-     */
-    readonly uri: URI;
-    /**
-     * The full range of the prompt reference in the source text,
-     * including the {@link linkRange} and any additional
-     * parts the reference may contain (e.g., the `#file:` prefix).
-     */
-    readonly range: Range;
-    /**
-     * Range of the link part that the reference points to.
-     */
-    readonly linkRange: IRange | undefined;
-    /**
-     * Text of the reference as it appears in the source.
-     */
-    readonly text: string;
-    /**
-     * Original link path as it appears in the source.
-     */
-    readonly path: string;
-}
-/**
- * The special case of the {@link IPromptReferenceBase} that pertains
- * to a file resource on the disk.
- */
-export interface IPromptFileReference extends IPromptReferenceBase {
-    readonly type: "file";
-    /**
-     * Subtype of a file reference, - either a prompt `#file` variable,
-     * or a `markdown link` (e.g., `[caption](/path/to/file.md)`).
-     */
-    readonly subtype: "prompt" | "markdown";
-}
-/**
- * List of all known prompt reference types.
- */
-export type TPromptReference = IPromptFileReference;
-export {};

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/service/promptsService.d.ts

@@ -1,125 +0,0 @@
-import { ChatModeKind } from "../../constants.js";
-import { URI } from "../../../../../../base/common/uri.js";
-import { TMetadata } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/parsers/promptHeader/headerBase";
-import { TextModelPromptParser } from "@codingame/monaco-vscode-chat-service-override/vscode/vs/workbench/contrib/chat/common/promptSyntax/parsers/textModelPromptParser";
-import { PromptsType } from "@codingame/monaco-vscode-e28ac690-06d5-5ee9-92d1-02df70296354-common/vscode/vs/workbench/contrib/chat/common/promptSyntax/promptTypes";
-import { ITopError } from "../parsers/types.js";
-/**
- * Where the prompt is stored.
- */
-export type TPromptsStorage = "local" | "user";
-/**
- * Represents a prompt path with its type.
- * This is used for both prompt files and prompt source folders.
- */
-export interface IPromptPath {
-    /**
-     * URI of the prompt.
-     */
-    readonly uri: URI;
-    /**
-     * Storage of the prompt.
-     */
-    readonly storage: TPromptsStorage;
-    /**
-     * Type of the prompt (e.g. 'prompt' or 'instructions').
-     */
-    readonly type: PromptsType;
-}
-/**
- * Type for a shared prompt parser instance returned by the {@link IPromptsService}.
- * Because the parser is shared, we omit the `dispose` method from
- * the original type so the caller cannot dispose it prematurely
- */
-export type TSharedPrompt = Omit<TextModelPromptParser, "dispose">;
-/**
- * Metadata node object in a hierarchical tree of prompt references.
- */
-export interface IMetadata {
-    /**
-     * URI of a prompt file.
-     */
-    readonly uri: URI;
-    /**
-     * Metadata of the prompt file.
-     */
-    readonly metadata: TMetadata | null;
-    /**
-     * List of metadata for each valid child prompt reference.
-     */
-    readonly children?: readonly IMetadata[];
-}
-export interface ICustomChatMode {
-    /**
-     * URI of a custom chat mode file.
-     */
-    readonly uri: URI;
-    /**
-     * Name of the custom chat mode as used in prompt files or contexts
-     */
-    readonly name: string;
-    /**
-     * Description of the mode
-     */
-    readonly description?: string;
-    /**
-     * Tools metadata in the prompt header.
-     */
-    readonly tools?: readonly string[];
-    /**
-     * Model metadata in the prompt header.
-     */
-    readonly model?: string;
-    /**
-     * Contents of the custom chat mode file body.
-     */
-    readonly body: string;
-}
-/**
- * Type of combined tools metadata for the case
- * when the prompt is in the agent mode.
- */
-interface ICombinedAgentToolsMetadata {
-    /**
-     * List of combined tools metadata for
-     * the entire tree of prompt references.
-     */
-    readonly tools: readonly string[] | undefined;
-    /**
-     * Resulting chat mode of a prompt, based on modes
-     * used in the entire tree of prompt references.
-     */
-    readonly mode: ChatModeKind.Agent;
-}
-/**
- * Type of combined tools metadata for the case
- * when the prompt is in non-agent mode.
- */
-interface ICombinedNonAgentToolsMetadata {
-    /**
-     * List of combined tools metadata is empty
-     * when the prompt is in non-agent mode.
-     */
-    readonly tools: undefined;
-    /**
-     * Resulting chat mode of a prompt, based on modes
-     * used in the entire tree of prompt references.
-     */
-    readonly mode?: ChatModeKind.Ask | ChatModeKind.Edit;
-}
-/**
- * General type of the combined tools metadata.
- */
-export type TCombinedToolsMetadata = ICombinedAgentToolsMetadata | ICombinedNonAgentToolsMetadata;
-export interface IChatPromptSlashCommand {
-    readonly command: string;
-    readonly detail: string;
-    readonly promptPath?: IPromptPath;
-}
-export interface IPromptParserResult {
-    readonly uri: URI;
-    readonly metadata: TMetadata | null;
-    readonly topError: ITopError | undefined;
-    readonly references: readonly URI[];
-}
-export {};