@codingame/monaco-vscode-api 20.1.1 → 20.2.0

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

@@ -1,27 +1,91 @@
 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

@@ -4,34 +4,112 @@ import { TMetadata } from "@codingame/monaco-vscode-chat-service-override/vscode
 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.
+     */
     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;

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

@@ -5,19 +5,59 @@ import { URI } from "../../../../../../base/common/uri.js";
 import { ITextModel } from "../../../../../../editor/common/model.js";
 import { PromptsType } from "@codingame/monaco-vscode-e28ac690-06d5-5ee9-92d1-02df70296354-common/vscode/vs/workbench/contrib/chat/common/promptSyntax/promptTypes";
 import { TSharedPrompt, IPromptPath, IChatPromptSlashCommand, IPromptParserResult, ICustomChatMode } from "./promptsService.js";
+/**
+* Provides prompt services.
+*/
 export declare const IPromptsService: import("../../../../../../platform/instantiation/common/instantiation.js").ServiceIdentifier<IPromptsService>;
+/**
+* Provides prompt services.
+*/
 export interface IPromptsService extends IDisposable {
     readonly _serviceBrand: undefined;
+    /**
+    * Get a prompt syntax parser for the provided text model.
+    * See {@link TextModelPromptParser} for more info on the parser API.
+    */
     getSyntaxParserFor(model: ITextModel): TSharedPrompt & {
         isDisposed: false;
     };
+    /**
+    * List all available prompt files.
+    */
     listPromptFiles(type: PromptsType, token: CancellationToken): Promise<readonly IPromptPath[]>;
+    /**
+    * Get a list of prompt source folders based on the provided prompt type.
+    */
     getSourceFolders(type: PromptsType): readonly IPromptPath[];
+    /**
+    * Returns a prompt command if the command name.
+    * Undefined is returned if the name does not look like a file name of a prompt file.
+    */
     asPromptSlashCommand(name: string): IChatPromptSlashCommand | undefined;
+    /**
+    * Gets the prompt file for a slash command.
+    */
     resolvePromptSlashCommand(data: IChatPromptSlashCommand, _token: CancellationToken): Promise<IPromptParserResult | undefined>;
+    /**
+    * Returns a prompt command if the command name is valid.
+    */
     findPromptSlashCommands(): Promise<IChatPromptSlashCommand[]>;
+    /**
+    * Event that is triggered when the list of custom chat modes changes.
+    */
     readonly onDidChangeCustomChatModes: Event<void>;
+    /**
+    * Finds all available custom chat modes
+    */
     getCustomChatModes(token: CancellationToken): Promise<readonly ICustomChatMode[]>;
+    /**
+    * Parses the provided URI
+    * @param uris
+    */
     parse(uri: URI, type: PromptsType, token: CancellationToken): Promise<IPromptParserResult>;
+    /**
+    * Returns the prompt file type for the given URI.
+    * @param resource the URI of the resource
+    */
     getPromptFileType(resource: URI): PromptsType | undefined;
 }

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

@@ -1,3 +1,8 @@
+/**
+ * This is a subset of the types export from jsonTypes.d.ts in @vscode/prompt-tsx.
+ * It's just the types needed to stringify prompt-tsx tool results.
+ * It should be kept in sync with the types in that file.
+ */
 export declare enum PromptNodeType {
     Piece = 1,
     Text = 2
@@ -7,6 +12,11 @@ export interface TextJSON {
     text: string;
     lineBreakBefore: boolean | undefined;
 }
+/**
+ * Constructor kind of the node represented by {@link PieceJSON}. This is
+ * less descriptive than the actual constructor, as we only care to preserve
+ * the element data that the renderer cares about.
+ */
 export declare enum PieceCtorKind {
     BaseChatMessage = 1,
     Other = 2,

package/vscode/src/vs/workbench/contrib/codeEditor/browser/dictation/editorDictation.css

@@ -1,3 +1,8 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
 .monaco-editor .editor-dictation-widget {
 	background-color: var(--vscode-editor-background);
 	padding: 2px;
@@ -10,17 +15,21 @@
 	line-height: var(--vscode-editor-dictation-widget-height);
 	max-width: var(--vscode-editor-dictation-widget-width);
 }
+
 .monaco-editor .editor-dictation-widget.recording .codicon.codicon-mic-filled {
 	color: var(--vscode-activityBarBadge-background);
 	animation: editor-dictation-animation 1s infinite;
 }
+
 @keyframes editor-dictation-animation {
 	0% {
 		color: var(--vscode-editorCursor-background);
 	}
+
 	50% {
 		color: var(--vscode-activityBarBadge-background);
 	}
+
 	100% {
 		color: var(--vscode-editorCursor-background);
 	}

package/vscode/src/vs/workbench/contrib/codeEditor/browser/editorLineNumberMenu.d.ts

@@ -17,6 +17,12 @@ export interface IGutterActionsGenerator {
 }
 export declare class GutterActionsRegistryImpl {
     private _registeredGutterActionsGenerators;
+    /**
+     *
+     * This exists solely to allow the debug and test contributions to add actions to the gutter context menu
+     * which cannot be trivially expressed using when clauses and therefore cannot be statically registered.
+     * If you want an action to show up in the gutter context menu, you should generally use MenuId.EditorLineNumberMenu instead.
+     */
     registerGutterActionsGenerator(gutterActionsGenerator: IGutterActionsGenerator): IDisposable;
     getGutterActionsGenerators(): IGutterActionsGenerator[];
 }

package/vscode/src/vs/workbench/contrib/codeEditor/browser/largeFileOptimizations.d.ts

@@ -3,6 +3,9 @@ import { ICodeEditor } from "../../../../editor/browser/editorBrowser.js";
 import { IEditorContribution } from "../../../../editor/common/editorCommon.js";
 import { IConfigurationService } from "../../../../platform/configuration/common/configuration.service.js";
 import { INotificationService } from "../../../../platform/notification/common/notification.service.js";
+/**
+ * Shows a message when opening a large file which has been memory optimized (and features disabled).
+ */
 export declare class LargeFileOptimizationsWarner extends Disposable implements IEditorContribution {
     private readonly _editor;
     private readonly _notificationService;

package/vscode/src/vs/workbench/contrib/codeEditor/browser/menuPreventer.d.ts

@@ -1,6 +1,9 @@
 import { Disposable } from "../../../../base/common/lifecycle.js";
 import { ICodeEditor } from "../../../../editor/browser/editorBrowser.js";
 import { IEditorContribution } from "../../../../editor/common/editorCommon.js";
+/**
+ * Prevents the top-level menu from showing up when doing Alt + Click in the editor
+ */
 export declare class MenuPreventer extends Disposable implements IEditorContribution {
     static readonly ID = "editor.contrib.menuPreventer";
     private _editor;

package/vscode/src/vs/workbench/contrib/codeEditor/browser/saveParticipants.d.ts

@@ -24,6 +24,9 @@ export declare class TrimFinalNewLinesParticipant implements ITextFileSavePartic
     private readonly codeEditorService;
     constructor(configurationService: IConfigurationService, codeEditorService: ICodeEditorService);
     participate(model: ITextFileEditorModel, context: ITextFileSaveParticipantContext): Promise<void>;
+    /**
+     * returns 0 if the entire file is empty
+     */
     private findLastNonEmptyLine;
     private doTrimFinalNewLines;
 }

package/vscode/src/vs/workbench/contrib/codeEditor/browser/toggleWordWrap.d.ts

@@ -1,7 +1,16 @@
 import { ICodeEditorService } from "../../../../editor/browser/services/codeEditorService.service.js";
 import { ITextModel } from "../../../../editor/common/model.js";
+/**
+ * State written/read by the toggle word wrap action and associated with a particular model.
+ */
 export interface IWordWrapTransientState {
     readonly wordWrapOverride: "on" | "off";
 }
+/**
+ * Store (in memory) the word wrap state for a particular model.
+ */
 export declare function writeTransientState(model: ITextModel, state: IWordWrapTransientState | null, codeEditorService: ICodeEditorService): void;
+/**
+ * Read (in memory) the word wrap state for a particular model.
+ */
 export declare function readTransientState(model: ITextModel, codeEditorService: ICodeEditorService): IWordWrapTransientState | null;

package/vscode/src/vs/workbench/contrib/comments/common/commentContextKeys.d.ts

@@ -1,14 +1,47 @@
 import { RawContextKey } from "../../../../platform/contextkey/common/contextkey.js";
 export declare namespace CommentContextKeys {
+    /**
+     * A context key that is set when the active cursor is in a commenting range.
+     */
     const activeCursorHasCommentingRange: RawContextKey<boolean>;
+    /**
+     * A context key that is set when the active cursor is in the range of an existing comment.
+     */
     const activeCursorHasComment: RawContextKey<boolean>;
+    /**
+     * A context key that is set when the active editor has commenting ranges.
+     */
     const activeEditorHasCommentingRange: RawContextKey<boolean>;
+    /**
+     * A context key that is set when the workspace has either comments or commenting ranges.
+     */
     const WorkspaceHasCommenting: RawContextKey<boolean>;
+    /**
+     * A context key that is set when the comment thread has no comments.
+     */
     const commentThreadIsEmpty: RawContextKey<boolean>;
+    /**
+     * A context key that is set when the comment has no input.
+     */
     const commentIsEmpty: RawContextKey<boolean>;
+    /**
+     * The context value of the comment.
+     */
     const commentContext: RawContextKey<string>;
+    /**
+     * The context value of the comment thread.
+     */
     const commentThreadContext: RawContextKey<string>;
+    /**
+     * The comment controller id associated with a comment thread.
+     */
     const commentControllerContext: RawContextKey<string>;
+    /**
+     * The comment widget is focused.
+     */
     const commentFocused: RawContextKey<boolean>;
+    /**
+     * A context key that is set when commenting is enabled.
+     */
     const commentingEnabled: RawContextKey<boolean>;
 }

package/vscode/src/vs/workbench/contrib/debug/common/abstractDebugAdapter.d.ts

@@ -1,5 +1,9 @@
 import { Emitter, Event } from "../../../../base/common/event.js";
 import { IDebugAdapter } from "./debug.js";
+/**
+ * Abstract implementation of the low level API for a debug adapter.
+ * Missing is how this API communicates with the debug adapter.
+ */
 export declare abstract class AbstractDebugAdapter implements IDebugAdapter {
     private sequence;
     private pendingRequests;
@@ -21,7 +25,29 @@ export declare abstract class AbstractDebugAdapter implements IDebugAdapter {
     sendResponse(response: DebugProtocol.Response): void;
     sendRequest(command: string, args: any, clb: (result: DebugProtocol.Response) => void, timeout?: number): number;
     acceptMessage(message: DebugProtocol.ProtocolMessage): void;
+    /**
+     * Returns whether we should insert a timeout between processing messageA
+     * and messageB. Artificially queueing protocol messages guarantees that any
+     * microtasks for previous message finish before next message is processed.
+     * This is essential ordering when using promises anywhere along the call path.
+     *
+     * For example, take the following, where `chooseAndSendGreeting` returns
+     * a person name and then emits a greeting event:
+     *
+     * ```
+     * let person: string;
+     * adapter.onGreeting(() => console.log('hello', person));
+     * person = await adapter.chooseAndSendGreeting();
+     * ```
+     *
+     * Because the event is dispatched synchronously, it may fire before person
+     * is assigned if they're processed in the same task. Inserting a task
+     * boundary avoids this issue.
+     */
     protected needsTaskBoundaryBetween(messageA: DebugProtocol.ProtocolMessage, messageB: DebugProtocol.ProtocolMessage): boolean;
+    /**
+     * Reads and dispatches items from the queue until it is empty.
+     */
     private processQueue;
     private internalSend;
     protected cancelPendingRequests(): Promise<void>;