@codingame/monaco-vscode-api 20.1.1 → 20.2.1

package/vscode/src/vs/base/common/hotReload.d.ts

@@ -1,6 +1,12 @@
 import { IDisposable } from "./lifecycle.js";
 export declare function isHotReloadEnabled(): boolean;
 export declare function registerHotReloadHandler(handler: HotReloadHandler): IDisposable;
+/**
+ * Takes the old exports of the module to reload and returns a function to apply the new exports.
+ * If `undefined` is returned, this handler is not able to handle the module.
+ *
+ * If no handler can apply the new exports, the module will not be reloaded.
+ */
 export type HotReloadHandler = (args: {
     oldExports: Record<string, unknown>;
     newSrc: string;

package/vscode/src/vs/base/common/htmlContent.d.ts

@@ -41,6 +41,9 @@ export declare function isEmptyMarkdownString(oneOrMany: IMarkdownString | IMark
 export declare function isMarkdownString(thing: unknown): thing is IMarkdownString;
 export declare function markdownStringEqual(a: IMarkdownString, b: IMarkdownString): boolean;
 export declare function escapeMarkdownSyntaxTokens(text: string): string;
+/**
+ * @see https://github.com/microsoft/vscode/issues/193746
+ */
 export declare function appendEscapedMarkdownCodeBlockFence(code: string, langId: string): string;
 export declare function escapeDoubleQuotes(input: string): string;
 export declare function removeMarkdownEscapes(text: string): string;

package/vscode/src/vs/base/common/iconLabels.d.ts

@@ -1,11 +1,20 @@
 import { IMatch } from "./filters.js";
 export declare function escapeIcons(text: string): string;
 export declare function markdownEscapeEscapedIcons(text: string): string;
+/**
+ * Takes a label with icons (`$(iconId)xyz`)  and strips the icons out (`xyz`)
+ */
 export declare function stripIcons(text: string): string;
+/**
+ * Takes a label with icons (`$(iconId)xyz`), removes the icon syntax adds whitespace so that screen readers can read the text better.
+ */
 export declare function getCodiconAriaLabel(text: string | undefined): string;
 export interface IParsedLabelWithIcons {
     readonly text: string;
     readonly iconOffsets?: readonly number[];
 }
+/**
+ * Takes a label with icons (`abc $(iconId)xyz`) and returns the text (`abc xyz`) and the offsets of the icons (`[3]`)
+ */
 export declare function parseLabelWithIcons(input: string): IParsedLabelWithIcons;
 export declare function matchesFuzzyIconAware(query: string, target: IParsedLabelWithIcons, enableSeparateSubstringMatching?: boolean): IMatch[] | null;

package/vscode/src/vs/base/common/ime.d.ts

@@ -3,7 +3,13 @@ export declare class IMEImpl {
     readonly onDidChange: import("./event.js").Event<void>;
     private _enabled;
     get enabled(): boolean;
+    /**
+     * Enable IME
+     */
     enable(): void;
+    /**
+     * Disable IME
+     */
     disable(): void;
 }
 export declare const IME: IMEImpl;

package/vscode/src/vs/base/common/iterator.d.ts

@@ -18,7 +18,14 @@ export declare namespace Iterable {
     function concat<T>(...iterables: (Iterable<T> | T)[]): Iterable<T>;
     function reduce<T, R>(iterable: Iterable<T>, reducer: (previousValue: R, currentValue: T) => R, initialValue: R): R;
     function length<T>(iterable: Iterable<T>): number;
+    /**
+     * Returns an iterable slice of the array, with the same semantics as `array.slice()`.
+     */
     function slice<T>(arr: ReadonlyArray<T>, from: number, to?: number): Iterable<T>;
+    /**
+     * Consumes `atMost` elements from iterable and returns the consumed elements,
+     * and an iterable for the rest of the elements.
+     */
     function consume<T>(iterable: Iterable<T>, atMost?: number): [
         T[],
         Iterable<T>

package/vscode/src/vs/base/common/json.d.ts

@@ -26,14 +26,41 @@ export declare enum SyntaxKind {
     Unknown = 16,
     EOF = 17
 }
+/**
+ * The scanner object, representing a JSON scanner at a position in the input string.
+ */
 export interface JSONScanner {
+    /**
+     * Sets the scan position to a new offset. A call to 'scan' is needed to get the first token.
+     */
     setPosition(pos: number): void;
+    /**
+     * Read the next token. Returns the token code.
+     */
     scan(): SyntaxKind;
+    /**
+     * Returns the current scan position, which is after the last read token.
+     */
     getPosition(): number;
+    /**
+     * Returns the last read token.
+     */
     getToken(): SyntaxKind;
+    /**
+     * Returns the last read token value. The value for strings is the decoded string content. For numbers its of type number, for boolean it's true or false.
+     */
     getTokenValue(): string;
+    /**
+     * The start offset of the last read token.
+     */
     getTokenOffset(): number;
+    /**
+     * The length of the last read token.
+     */
     getTokenLength(): number;
+    /**
+     * An error code of the last scan.
+     */
     getTokenError(): ScanError;
 }
 export interface ParseError {
@@ -72,9 +99,24 @@ export interface Node {
 export type Segment = string | number;
 export type JSONPath = Segment[];
 export interface Location {
+    /**
+     * The previous property key or literal value (string, number, boolean or null) or undefined.
+     */
     previousNode?: Node;
+    /**
+     * The path describing the location in the JSON document. The path consists of a sequence strings
+     * representing an object property or numbers for array indices.
+     */
     path: JSONPath;
+    /**
+     * Matches the locations path against a pattern consisting of strings (for properties) and numbers (for array indices).
+     * '*' will match a single segment, of any property name or index.
+     * '**' will match a sequence of segments or no segment, of any property name or index.
+     */
     matches: (patterns: JSONPath) => boolean;
+    /**
+     * If set, the location's offset is at a property key.
+     */
     isAtPropertyKey: boolean;
 }
 export interface ParseOptions {
@@ -88,24 +130,80 @@ export declare namespace ParseOptions {
     };
 }
 export interface JSONVisitor {
+    /**
+     * Invoked when an open brace is encountered and an object is started. The offset and length represent the location of the open brace.
+     */
     onObjectBegin?: (offset: number, length: number) => void;
+    /**
+     * Invoked when a property is encountered. The offset and length represent the location of the property name.
+     */
     onObjectProperty?: (property: string, offset: number, length: number) => void;
+    /**
+     * Invoked when a closing brace is encountered and an object is completed. The offset and length represent the location of the closing brace.
+     */
     onObjectEnd?: (offset: number, length: number) => void;
+    /**
+     * Invoked when an open bracket is encountered. The offset and length represent the location of the open bracket.
+     */
     onArrayBegin?: (offset: number, length: number) => void;
+    /**
+     * Invoked when a closing bracket is encountered. The offset and length represent the location of the closing bracket.
+     */
     onArrayEnd?: (offset: number, length: number) => void;
+    /**
+     * Invoked when a literal value is encountered. The offset and length represent the location of the literal value.
+     */
     onLiteralValue?: (value: any, offset: number, length: number) => void;
+    /**
+     * Invoked when a comma or colon separator is encountered. The offset and length represent the location of the separator.
+     */
     onSeparator?: (character: string, offset: number, length: number) => void;
+    /**
+     * When comments are allowed, invoked when a line or block comment is encountered. The offset and length represent the location of the comment.
+     */
     onComment?: (offset: number, length: number) => void;
+    /**
+     * Invoked on an error.
+     */
     onError?: (error: ParseErrorCode, offset: number, length: number) => void;
 }
+/**
+ * Creates a JSON scanner on the given text.
+ * If ignoreTrivia is set, whitespaces or comments are ignored.
+ */
 export declare function createScanner(text: string, ignoreTrivia?: boolean): JSONScanner;
+/**
+ * For a given offset, evaluate the location in the JSON document. Each segment in the location path is either a property name or an array index.
+ */
 export declare function getLocation(text: string, position: number): Location;
+/**
+ * Parses the given text and returns the object the JSON content represents. On invalid input, the parser tries to be as fault tolerant as possible, but still return a result.
+ * Therefore always check the errors list to find out if the input was valid.
+ */
 export declare function parse(text: string, errors?: ParseError[], options?: ParseOptions): any;
+/**
+ * Parses the given text and returns a tree representation the JSON content. On invalid input, the parser tries to be as fault tolerant as possible, but still return a result.
+ */
 export declare function parseTree(text: string, errors?: ParseError[], options?: ParseOptions): Node;
+/**
+ * Finds the node at the given path in a JSON DOM.
+ */
 export declare function findNodeAtLocation(root: Node, path: JSONPath): Node | undefined;
+/**
+ * Gets the JSON path of the given JSON DOM node
+ */
 export declare function getNodePath(node: Node): JSONPath;
+/**
+ * Evaluates the JavaScript object of the given JSON DOM node
+ */
 export declare function getNodeValue(node: Node): any;
 export declare function contains(node: Node, offset: number, includeRightBound?: boolean): boolean;
+/**
+ * Finds the most inner node at the given offset. If includeRightBound is set, also finds nodes that end at the given offset.
+ */
 export declare function findNodeAtOffset(node: Node, offset: number, includeRightBound?: boolean): Node | undefined;
+/**
+ * Parses the given text and invokes the visitor functions for each object, array and literal reached.
+ */
 export declare function visit(text: string, visitor: JSONVisitor, options?: ParseOptions): any;
 export declare function getNodeType(value: unknown): NodeType;

package/vscode/src/vs/base/common/jsonSchema.d.ts

@@ -86,6 +86,11 @@ export interface IJSONSchemaSnippet {
     body?: any;
     bodyText?: string;
 }
+/**
+ * Converts a basic JSON schema to a TypeScript type.
+ *
+ * TODO: only supports basic schemas. Doesn't support all JSON schema features.
+ */
 export type SchemaToType<T> = T extends {
     type: "string";
 } ? string : T extends {

package/vscode/src/vs/base/common/keyCodes.d.ts

@@ -1,5 +1,13 @@
+/**
+ * Virtual Key Codes, the value does not hold any inherent meaning.
+ * Inspired somewhat from https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx
+ * But these are "more general", as they should work across browsers & OS`s.
+ */
 export declare enum KeyCode {
     DependsOnKbLayout = -1,
+    /**
+     * Placed first to cover the 0 value of the enum.
+     */
     Unknown = 0,
     Backspace = 1,
     Tab = 2,
@@ -85,38 +93,91 @@ export declare enum KeyCode {
     F24 = 82,
     NumLock = 83,
     ScrollLock = 84,
+    /**
+     * Used for miscellaneous characters; it can vary by keyboard.
+     * For the US standard keyboard, the ';:' key
+     */
     Semicolon = 85,
+    /**
+     * For any country/region, the '+' key
+     * For the US standard keyboard, the '=+' key
+     */
     Equal = 86,
+    /**
+     * For any country/region, the ',' key
+     * For the US standard keyboard, the ',<' key
+     */
     Comma = 87,
+    /**
+     * For any country/region, the '-' key
+     * For the US standard keyboard, the '-_' key
+     */
     Minus = 88,
+    /**
+     * For any country/region, the '.' key
+     * For the US standard keyboard, the '.>' key
+     */
     Period = 89,
+    /**
+     * Used for miscellaneous characters; it can vary by keyboard.
+     * For the US standard keyboard, the '/?' key
+     */
     Slash = 90,
+    /**
+     * Used for miscellaneous characters; it can vary by keyboard.
+     * For the US standard keyboard, the '`~' key
+     */
     Backquote = 91,
+    /**
+     * Used for miscellaneous characters; it can vary by keyboard.
+     * For the US standard keyboard, the '[{' key
+     */
     BracketLeft = 92,
+    /**
+     * Used for miscellaneous characters; it can vary by keyboard.
+     * For the US standard keyboard, the '\|' key
+     */
     Backslash = 93,
+    /**
+     * Used for miscellaneous characters; it can vary by keyboard.
+     * For the US standard keyboard, the ']}' key
+     */
     BracketRight = 94,
+    /**
+     * Used for miscellaneous characters; it can vary by keyboard.
+     * For the US standard keyboard, the ''"' key
+     */
     Quote = 95,
+    /**
+     * Used for miscellaneous characters; it can vary by keyboard.
+     */
     OEM_8 = 96,
+    /**
+     * Either the angle bracket key or the backslash key on the RT 102-key keyboard.
+     */
     IntlBackslash = 97,
-    Numpad0 = 98,
-    Numpad1 = 99,
-    Numpad2 = 100,
-    Numpad3 = 101,
-    Numpad4 = 102,
-    Numpad5 = 103,
-    Numpad6 = 104,
-    Numpad7 = 105,
-    Numpad8 = 106,
-    Numpad9 = 107,
-    NumpadMultiply = 108,
-    NumpadAdd = 109,
-    NUMPAD_SEPARATOR = 110,
-    NumpadSubtract = 111,
-    NumpadDecimal = 112,
-    NumpadDivide = 113,
+    Numpad0 = 98,// VK_NUMPAD0, 0x60, Numeric keypad 0 key
+    Numpad1 = 99,// VK_NUMPAD1, 0x61, Numeric keypad 1 key
+    Numpad2 = 100,// VK_NUMPAD2, 0x62, Numeric keypad 2 key
+    Numpad3 = 101,// VK_NUMPAD3, 0x63, Numeric keypad 3 key
+    Numpad4 = 102,// VK_NUMPAD4, 0x64, Numeric keypad 4 key
+    Numpad5 = 103,// VK_NUMPAD5, 0x65, Numeric keypad 5 key
+    Numpad6 = 104,// VK_NUMPAD6, 0x66, Numeric keypad 6 key
+    Numpad7 = 105,// VK_NUMPAD7, 0x67, Numeric keypad 7 key
+    Numpad8 = 106,// VK_NUMPAD8, 0x68, Numeric keypad 8 key
+    Numpad9 = 107,// VK_NUMPAD9, 0x69, Numeric keypad 9 key
+    NumpadMultiply = 108,// VK_MULTIPLY, 0x6A, Multiply key
+    NumpadAdd = 109,// VK_ADD, 0x6B, Add key
+    NUMPAD_SEPARATOR = 110,// VK_SEPARATOR, 0x6C, Separator key
+    NumpadSubtract = 111,// VK_SUBTRACT, 0x6D, Subtract key
+    NumpadDecimal = 112,// VK_DECIMAL, 0x6E, Decimal key
+    NumpadDivide = 113,// VK_DIVIDE, 0x6F,
+    /**
+     * Cover all key codes when IME is processing input.
+     */
     KEY_IN_COMPOSITION = 114,
-    ABNT_C1 = 115,
-    ABNT_C2 = 116,
+    ABNT_C1 = 115,// Brazilian (ABNT) Keyboard
+    ABNT_C2 = 116,// Brazilian (ABNT) Keyboard
     AudioVolumeMute = 117,
     AudioVolumeUp = 118,
     AudioVolumeDown = 119,
@@ -131,9 +192,19 @@ export declare enum KeyCode {
     LaunchMediaPlayer = 128,
     LaunchMail = 129,
     LaunchApp2 = 130,
+    /**
+     * VK_CLEAR, 0x0C, CLEAR key
+     */
     Clear = 131,
+    /**
+     * Placed last to cover the length of the enum.
+     * Please do not depend on this value!
+     */
     MAX_VALUE = 132
 }
+/**
+ * keyboardEvent.code
+ */
 export declare enum ScanCode {
     DependsOnKbLayout = -1,
     None = 0,
@@ -342,7 +413,13 @@ export declare const ScanCodeUtils: {
     toEnum: (scanCode: string) => number;
     toString: (scanCode: ScanCode) => string;
 };
+/**
+ * -1 if a ScanCode => KeyCode mapping depends on kb layout.
+ */
 export declare const IMMUTABLE_CODE_TO_KEY_CODE: KeyCode[];
+/**
+ * -1 if a KeyCode => ScanCode mapping depends on kb layout.
+ */
 export declare const IMMUTABLE_KEY_CODE_TO_CODE: ScanCode[];
 export declare namespace KeyCodeUtils {
     function toString(keyCode: KeyCode): string;

package/vscode/src/vs/base/common/keybindingLabels.d.ts

@@ -15,7 +15,20 @@ export declare class ModifierLabelProvider {
     constructor(mac: ModifierLabels, windows: ModifierLabels, linux?: ModifierLabels);
     toLabel<T extends Modifiers>(OS: OperatingSystem, chords: readonly T[], keyLabelProvider: KeyLabelProvider<T>): string | null;
 }
+/**
+ * A label provider that prints modifiers in a suitable format for displaying in the UI.
+ */
 export declare const UILabelProvider: ModifierLabelProvider;
+/**
+ * A label provider that prints modifiers in a suitable format for ARIA.
+ */
 export declare const AriaLabelProvider: ModifierLabelProvider;
+/**
+ * A label provider that prints modifiers in a suitable format for Electron Accelerators.
+ * See https://github.com/electron/electron/blob/master/docs/api/accelerator.md
+ */
 export declare const ElectronAcceleratorLabelProvider: ModifierLabelProvider;
+/**
+ * A label provider that prints modifiers in a suitable format for user settings.
+ */
 export declare const UserSettingsLabelProvider: ModifierLabelProvider;

package/vscode/src/vs/base/common/keybindings.d.ts

@@ -8,6 +8,10 @@ export interface Modifiers {
     readonly altKey: boolean;
     readonly metaKey: boolean;
 }
+/**
+ * Represents a chord which uses the `keyCode` field of keyboard events.
+ * A chord is a combination of keys pressed simultaneously.
+ */
 export declare class KeyCodeChord implements Modifiers {
     readonly ctrlKey: boolean;
     readonly shiftKey: boolean;
@@ -19,8 +23,15 @@ export declare class KeyCodeChord implements Modifiers {
     getHashCode(): string;
     isModifierKey(): boolean;
     toKeybinding(): Keybinding;
+    /**
+     * Does this keybinding refer to the key code of a modifier and it also has the modifier flag?
+     */
     isDuplicateModifierCase(): boolean;
 }
+/**
+ * Represents a chord which uses the `code` field of keyboard events.
+ * A chord is a combination of keys pressed simultaneously.
+ */
 export declare class ScanCodeChord implements Modifiers {
     readonly ctrlKey: boolean;
     readonly shiftKey: boolean;
@@ -30,9 +41,15 @@ export declare class ScanCodeChord implements Modifiers {
     constructor(ctrlKey: boolean, shiftKey: boolean, altKey: boolean, metaKey: boolean, scanCode: ScanCode);
     equals(other: Chord): boolean;
     getHashCode(): string;
+    /**
+     * Does this keybinding refer to the key code of a modifier and it also has the modifier flag?
+     */
     isDuplicateModifierCase(): boolean;
 }
 export type Chord = KeyCodeChord | ScanCodeChord;
+/**
+ * A keybinding is a sequence of chords.
+ */
 export declare class Keybinding {
     readonly chords: Chord[];
     constructor(chords: Chord[]);
@@ -49,14 +66,51 @@ export declare class ResolvedChord {
     constructor(ctrlKey: boolean, shiftKey: boolean, altKey: boolean, metaKey: boolean, keyLabel: string | null, keyAriaLabel: string | null);
 }
 export type SingleModifierChord = "ctrl" | "shift" | "alt" | "meta";
+/**
+ * A resolved keybinding. Consists of one or multiple chords.
+ */
 export declare abstract class ResolvedKeybinding {
+    /**
+     * This prints the binding in a format suitable for displaying in the UI.
+     */
     abstract getLabel(): string | null;
+    /**
+     * This prints the binding in a format suitable for ARIA.
+     */
     abstract getAriaLabel(): string | null;
+    /**
+     * This prints the binding in a format suitable for electron's accelerators.
+     * See https://github.com/electron/electron/blob/master/docs/api/accelerator.md
+     */
     abstract getElectronAccelerator(): string | null;
+    /**
+     * This prints the binding in a format suitable for user settings.
+     */
     abstract getUserSettingsLabel(): string | null;
+    /**
+     * Is the user settings label reflecting the label?
+     */
     abstract isWYSIWYG(): boolean;
+    /**
+     * Does the keybinding consist of more than one chord?
+     */
     abstract hasMultipleChords(): boolean;
+    /**
+     * Returns the chords that comprise of the keybinding.
+     */
     abstract getChords(): ResolvedChord[];
+    /**
+     * Returns the chords as strings useful for dispatching.
+     * Returns null for modifier only chords.
+     * @example keybinding "Shift" -> null
+     * @example keybinding ("D" with shift == true) -> "shift+D"
+     */
     abstract getDispatchChords(): (string | null)[];
+    /**
+     * Returns the modifier only chords as strings useful for dispatching.
+     * Returns null for chords that contain more than one modifier or a regular key.
+     * @example keybinding "Shift" -> "shift"
+     * @example keybinding ("D" with shift == true") -> null
+     */
     abstract getSingleModifierDispatchChords(): (SingleModifierChord | null)[];
 }

package/vscode/src/vs/base/common/labels.d.ts

@@ -1,11 +1,29 @@
 import { OperatingSystem } from "./platform.js";
 import { URI } from "./uri.js";
 export interface IPathLabelFormatting {
+    /**
+     * The OS the path label is from to produce a label
+     * that matches OS expectations.
+     */
     readonly os: OperatingSystem;
+    /**
+     * Whether to add a `~` when the path is in the
+     * user home directory.
+     *
+     * Note: this only applies to Linux, macOS but not
+     * Windows.
+     */
     readonly tildify?: IUserHomeProvider;
+    /**
+     * Whether to convert to a relative path if the path
+     * is within any of the opened workspace folders.
+     */
     readonly relative?: IRelativePathProvider;
 }
 export interface IRelativePathProvider {
+    /**
+     * Whether to not add a prefix when in multi-root workspace.
+     */
     readonly noPrefix?: boolean;
     getWorkspace(): {
         folders: {
@@ -29,16 +47,39 @@ export declare function shorten(paths: string[], pathSeparator?: string): string
 export interface ISeparator {
     label: string;
 }
+/**
+ * Helper to insert values for specific template variables into the string. E.g. "this $(is) a $(template)" can be
+ * passed to this function together with an object that maps "is" and "template" to strings to have them replaced.
+ * @param value string to which template is applied
+ * @param values the values of the templates to use
+ */
 export declare function template(template: string, values?: {
     [key: string]: string | ISeparator | undefined | null;
 }): string;
+/**
+ * Handles mnemonics for menu items. Depending on OS:
+ * - Windows: Supported via & character (replace && with &)
+ * -   Linux: Supported via & character (replace && with &)
+ * -   macOS: Unsupported (replace && with empty string)
+ */
 export declare function mnemonicMenuLabel(label: string, forceDisableMnemonics?: boolean): string;
+/**
+ * Handles mnemonics for buttons. Depending on OS:
+ * - Windows: Supported via & character (replace && with & and & with && for escaping)
+ * -   Linux: Supported via _ character (replace && with _)
+ * -   macOS: Unsupported (replace && with empty string)
+ * When forceDisableMnemonics is set, returns just the label without mnemonics.
+ */
 export declare function mnemonicButtonLabel(label: string, forceDisableMnemonics: true): string;
 export declare function mnemonicButtonLabel(label: string, forceDisableMnemonics?: false): {
     readonly withMnemonic: string;
     readonly withoutMnemonic: string;
 };
 export declare function unmnemonicLabel(label: string): string;
+/**
+ * Splits a recent label in name and parent path, supporting both '/' and '\' and workspace suffixes.
+ * If the location is remote, the remote name is included in the name part.
+ */
 export declare function splitRecentLabel(recentLabel: string): {
     name: string;
     parentPath: string;

package/vscode/src/vs/base/common/lazy.d.ts

@@ -4,7 +4,19 @@ export declare class Lazy<T> {
     private _value?;
     private _error;
     constructor(executor: () => T);
+    /**
+     * True if the lazy value has been resolved.
+     */
     get hasValue(): boolean;
+    /**
+     * Get the wrapped value.
+     *
+     * This will force evaluation of the lazy value if it has not been resolved yet. Lazy values are only
+     * resolved once. `getValue` will re-throw exceptions that are hit while resolving the value
+     */
     get value(): T;
+    /**
+     * Get the wrapped value without forcing evaluation.
+     */
     get rawValue(): T | undefined;
 }