@codingame/monaco-vscode-api 20.1.1 → 20.2.1

package/vscode/src/vs/editor/common/standalone/standaloneEnums.d.ts

@@ -1,4 +1,7 @@
 export declare enum AccessibilitySupport {
+    /**
+     * This should be the browser case where it is not known if a screen reader is attached or no.
+     */
     Unknown = 0,
     Disabled = 1,
     Enabled = 2
@@ -9,7 +12,14 @@ export declare enum CodeActionTriggerType {
 }
 export declare enum CompletionItemInsertTextRule {
     None = 0,
+    /**
+     * Adjust whitespace/indentation of multiline insert texts to
+     * match the current line indentation.
+     */
     KeepWhitespace = 1,
+    /**
+     * `insertText` is a snippet.
+     */
     InsertAsSnippet = 4
 }
 export declare enum CompletionItemKind {
@@ -46,34 +56,97 @@ export declare enum CompletionItemKind {
 export declare enum CompletionItemTag {
     Deprecated = 1
 }
+/**
+ * How a suggest provider was triggered.
+ */
 export declare enum CompletionTriggerKind {
     Invoke = 0,
     TriggerCharacter = 1,
     TriggerForIncompleteCompletions = 2
 }
+/**
+ * A positioning preference for rendering content widgets.
+ */
 export declare enum ContentWidgetPositionPreference {
+    /**
+     * Place the content widget exactly at a position
+     */
     EXACT = 0,
+    /**
+     * Place the content widget above a position
+     */
     ABOVE = 1,
+    /**
+     * Place the content widget below a position
+     */
     BELOW = 2
 }
+/**
+ * Describes the reason the cursor has changed its position.
+ */
 export declare enum CursorChangeReason {
+    /**
+     * Unknown or not set.
+     */
     NotSet = 0,
+    /**
+     * A `model.setValue()` was called.
+     */
     ContentFlush = 1,
+    /**
+     * The `model` has been changed outside of this cursor and the cursor recovers its position from associated markers.
+     */
     RecoverFromMarkers = 2,
+    /**
+     * There was an explicit user gesture.
+     */
     Explicit = 3,
+    /**
+     * There was a Paste.
+     */
     Paste = 4,
+    /**
+     * There was an Undo.
+     */
     Undo = 5,
+    /**
+     * There was a Redo.
+     */
     Redo = 6
 }
+/**
+ * The default end of line to use when instantiating models.
+ */
 export declare enum DefaultEndOfLine {
+    /**
+     * Use line feed (\n) as the end of line character.
+     */
     LF = 1,
+    /**
+     * Use carriage return and line feed (\r\n) as the end of line character.
+     */
     CRLF = 2
 }
+/**
+ * A document highlight kind.
+ */
 export declare enum DocumentHighlightKind {
+    /**
+     * A textual occurrence.
+     */
     Text = 0,
+    /**
+     * Read-access of a symbol, like reading a variable.
+     */
     Read = 1,
+    /**
+     * Write-access of a symbol, like writing to a variable.
+     */
     Write = 2
 }
+/**
+ * Configuration options for auto indentation in the editor
+ */
 export declare enum EditorAutoIndentStrategy {
     None = 0,
     Keep = 1,
@@ -255,28 +328,75 @@ export declare enum EditorOption {
     scrollOnMiddleClick = 170,
     effectiveAllowVariableFonts = 171
 }
+/**
+ * End of line character preference.
+ */
 export declare enum EndOfLinePreference {
+    /**
+     * Use the end of line character identified in the text buffer.
+     */
     TextDefined = 0,
+    /**
+     * Use line feed (\n) as the end of line character.
+     */
     LF = 1,
+    /**
+     * Use carriage return and line feed (\r\n) as the end of line character.
+     */
     CRLF = 2
 }
+/**
+ * End of line character preference.
+ */
 export declare enum EndOfLineSequence {
+    /**
+     * Use line feed (\n) as the end of line character.
+     */
     LF = 0,
+    /**
+     * Use carriage return and line feed (\r\n) as the end of line character.
+     */
     CRLF = 1
 }
+/**
+ * Vertical Lane in the glyph margin of the editor.
+ */
 export declare enum GlyphMarginLane {
     Left = 1,
     Center = 2,
     Right = 3
 }
 export declare enum HoverVerbosityAction {
+    /**
+     * Increase the verbosity of the hover
+     */
     Increase = 0,
+    /**
+     * Decrease the verbosity of the hover
+     */
     Decrease = 1
 }
+/**
+ * Describes what to do with the indentation when pressing Enter.
+ */
 export declare enum IndentAction {
+    /**
+     * Insert new line and copy the previous line's indentation.
+     */
     None = 0,
+    /**
+     * Insert new line and indent once (relative to the previous line's indentation).
+     */
     Indent = 1,
+    /**
+     * Insert two new lines:
+     *  - the first one indented which will hold the cursor
+     *  - the second one at the same indentation level
+     */
     IndentOutdent = 2,
+    /**
+     * Insert new line and outdent once (relative to the previous line's indentation).
+     */
     Outdent = 3
 }
 export declare enum InjectedTextCursorStops {
@@ -294,12 +414,31 @@ export declare enum InlineCompletionEndOfLifeReasonKind {
     Rejected = 1,
     Ignored = 2
 }
+/**
+ * How an {@link InlineCompletionsProvider inline completion provider} was triggered.
+ */
 export declare enum InlineCompletionTriggerKind {
+    /**
+     * Completion was triggered automatically while editing.
+     * It is sufficient to return a single completion item in this case.
+     */
     Automatic = 0,
+    /**
+     * Completion was triggered explicitly by a user gesture.
+     * Return multiple completion items to enable cycling through them.
+     */
     Explicit = 1
 }
+/**
+ * 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,
@@ -385,38 +524,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,
@@ -431,7 +623,14 @@ 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
 }
 export declare enum MarkerSeverity {
@@ -444,28 +643,79 @@ export declare enum MarkerTag {
     Unnecessary = 1,
     Deprecated = 2
 }
+/**
+ * Position in the minimap to render the decoration.
+ */
 export declare enum MinimapPosition {
     Inline = 1,
     Gutter = 2
 }
+/**
+ * Section header style.
+ */
 export declare enum MinimapSectionHeaderStyle {
     Normal = 1,
     Underlined = 2
 }
+/**
+ * Type of hit element with the mouse in the editor.
+ */
 export declare enum MouseTargetType {
+    /**
+     * Mouse is on top of an unknown element.
+     */
     UNKNOWN = 0,
+    /**
+     * Mouse is on top of the textarea used for input.
+     */
     TEXTAREA = 1,
+    /**
+     * Mouse is on top of the glyph margin
+     */
     GUTTER_GLYPH_MARGIN = 2,
+    /**
+     * Mouse is on top of the line numbers
+     */
     GUTTER_LINE_NUMBERS = 3,
+    /**
+     * Mouse is on top of the line decorations
+     */
     GUTTER_LINE_DECORATIONS = 4,
+    /**
+     * Mouse is on top of the whitespace left in the gutter by a view zone.
+     */
     GUTTER_VIEW_ZONE = 5,
+    /**
+     * Mouse is on top of text in the content.
+     */
     CONTENT_TEXT = 6,
+    /**
+     * Mouse is on top of empty space in the content (e.g. after line text or below last line)
+     */
     CONTENT_EMPTY = 7,
+    /**
+     * Mouse is on top of a view zone in the content.
+     */
     CONTENT_VIEW_ZONE = 8,
+    /**
+     * Mouse is on top of a content widget.
+     */
     CONTENT_WIDGET = 9,
+    /**
+     * Mouse is on top of the decorations overview ruler.
+     */
     OVERVIEW_RULER = 10,
+    /**
+     * Mouse is on top of a scrollbar.
+     */
     SCROLLBAR = 11,
+    /**
+     * Mouse is on top of an overlay widget.
+     */
     OVERLAY_WIDGET = 12,
+    /**
+     * Mouse is outside of the editor.
+     */
     OUTSIDE_EDITOR = 13
 }
 export declare enum NewSymbolNameTag {
@@ -475,27 +725,60 @@ export declare enum NewSymbolNameTriggerKind {
     Invoke = 0,
     Automatic = 1
 }
+/**
+ * A positioning preference for rendering overlay widgets.
+ */
 export declare enum OverlayWidgetPositionPreference {
+    /**
+     * Position the overlay widget in the top right corner
+     */
     TOP_RIGHT_CORNER = 0,
+    /**
+     * Position the overlay widget in the bottom right corner
+     */
     BOTTOM_RIGHT_CORNER = 1,
+    /**
+     * Position the overlay widget in the top center
+     */
     TOP_CENTER = 2
 }
+/**
+ * Vertical Lane in the overview ruler of the editor.
+ */
 export declare enum OverviewRulerLane {
     Left = 1,
     Center = 2,
     Right = 4,
     Full = 7
 }
+/**
+ * How a partial acceptance was triggered.
+ */
 export declare enum PartialAcceptTriggerKind {
     Word = 0,
     Line = 1,
     Suggest = 2
 }
 export declare enum PositionAffinity {
+    /**
+     * Prefers the left most position.
+    */
     Left = 0,
+    /**
+     * Prefers the right most position.
+    */
     Right = 1,
+    /**
+     * No preference.
+    */
     None = 2,
+    /**
+     * If the given position is on injected text, prefers the position left of it.
+    */
     LeftOfInjectedText = 3,
+    /**
+     * If the given position is on injected text, prefers the position right of it.
+    */
     RightOfInjectedText = 4
 }
 export declare enum RenderLineNumbersType {
@@ -519,8 +802,17 @@ export declare enum ScrollbarVisibility {
     Hidden = 2,
     Visible = 3
 }
+/**
+ * The direction of a selection.
+ */
 export declare enum SelectionDirection {
+    /**
+     * The selection starts above where it ends.
+     */
     LTR = 0,
+    /**
+     * The selection starts below where it ends.
+     */
     RTL = 1
 }
 export declare enum ShowLightbulbIconMode {
@@ -533,6 +825,9 @@ export declare enum SignatureHelpTriggerKind {
     TriggerCharacter = 2,
     ContentChange = 3
 }
+/**
+ * A symbol kind.
+ */
 export declare enum SymbolKind {
     File = 0,
     Module = 1,
@@ -564,35 +859,99 @@ export declare enum SymbolKind {
 export declare enum SymbolTag {
     Deprecated = 1
 }
+/**
+ * Text Direction for a decoration.
+ */
 export declare enum TextDirection {
     LTR = 0,
     RTL = 1
 }
+/**
+ * The kind of animation in which the editor's cursor should be rendered.
+ */
 export declare enum TextEditorCursorBlinkingStyle {
+    /**
+     * Hidden
+     */
     Hidden = 0,
+    /**
+     * Blinking
+     */
     Blink = 1,
+    /**
+     * Blinking with smooth fading
+     */
     Smooth = 2,
+    /**
+     * Blinking with prolonged filled state and smooth fading
+     */
     Phase = 3,
+    /**
+     * Expand collapse animation on the y axis
+     */
     Expand = 4,
+    /**
+     * No-Blinking
+     */
     Solid = 5
 }
+/**
+ * The style in which the editor's cursor should be rendered.
+ */
 export declare enum TextEditorCursorStyle {
+    /**
+     * As a vertical line (sitting between two characters).
+     */
     Line = 1,
+    /**
+     * As a block (sitting on top of a character).
+     */
     Block = 2,
+    /**
+     * As a horizontal line (sitting under a character).
+     */
     Underline = 3,
+    /**
+     * As a thin vertical line (sitting between two characters).
+     */
     LineThin = 4,
+    /**
+     * As an outlined block (sitting on top of a character).
+     */
     BlockOutline = 5,
+    /**
+     * As a thin horizontal line (sitting under a character).
+     */
     UnderlineThin = 6
 }
+/**
+ * Describes the behavior of decorations when typing/editing near their edges.
+ * Note: Please do not edit the values, as they very carefully match `DecorationRangeBehavior`
+ */
 export declare enum TrackedRangeStickiness {
     AlwaysGrowsWhenTypingAtEdges = 0,
     NeverGrowsWhenTypingAtEdges = 1,
     GrowsOnlyWhenTypingBefore = 2,
     GrowsOnlyWhenTypingAfter = 3
 }
+/**
+ * Describes how to indent wrapped lines.
+ */
 export declare enum WrappingIndent {
+    /**
+     * No indentation => wrapped lines begin at column 1.
+     */
     None = 0,
+    /**
+     * Same => wrapped lines get the same indentation as the parent.
+     */
     Same = 1,
+    /**
+     * Indent => wrapped lines get +1 indentation toward the parent.
+     */
     Indent = 2,
+    /**
+     * DeepIndent => wrapped lines get +2 indentation toward the parent.
+     */
     DeepIndent = 3
 }

package/vscode/src/vs/editor/common/textModelBracketPairs.d.ts

@@ -5,17 +5,53 @@ import { IRange, Range } from "./core/range.js";
 import { ClosingBracketKind, OpeningBracketKind } from "./languages/supports/languageBracketsConfiguration.js";
 import { PairAstNode } from "./model/bracketPairsTextModelPart/bracketPairsTree/ast.js";
 export interface IBracketPairsTextModelPart {
+    /**
+     * Is fired when bracket pairs change, either due to a text or a settings change.
+    */
     onDidChange: Event<void>;
+    /**
+     * Gets all bracket pairs that intersect the given position.
+     * The result is sorted by the start position.
+     */
     getBracketPairsInRange(range: IRange): CallbackIterable<BracketPairInfo>;
+    /**
+     * Gets all bracket pairs that intersect the given position.
+     * The result is sorted by the start position.
+     */
     getBracketPairsInRangeWithMinIndentation(range: IRange): CallbackIterable<BracketPairWithMinIndentationInfo>;
     getBracketsInRange(range: IRange, onlyColorizedBrackets?: boolean): CallbackIterable<BracketInfo>;
+    /**
+     * Find the matching bracket of `request` up, counting brackets.
+     * @param request The bracket we're searching for
+     * @param position The position at which to start the search.
+     * @return The range of the matching bracket, or null if the bracket match was not found.
+     */
     findMatchingBracketUp(bracket: string, position: IPosition, maxDuration?: number): Range | null;
+    /**
+     * Find the first bracket in the model before `position`.
+     * @param position The position at which to start the search.
+     * @return The info for the first bracket before `position`, or null if there are no more brackets before `positions`.
+     */
     findPrevBracket(position: IPosition): IFoundBracket | null;
+    /**
+     * Find the first bracket in the model after `position`.
+     * @param position The position at which to start the search.
+     * @return The info for the first bracket after `position`, or null if there are no more brackets after `positions`.
+     */
     findNextBracket(position: IPosition): IFoundBracket | null;
+    /**
+     * Find the enclosing brackets that contain `position`.
+     * @param position The position at which to start the search.
+     */
     findEnclosingBrackets(position: IPosition, maxDuration?: number): [
         Range,
         Range
     ] | null;
+    /**
+     * Given a `position`, if the position is on top or near a bracket,
+     * find the matching bracket of that bracket and return the ranges of both brackets.
+     * @param position The position at which to look for a bracket.
+     */
     matchBracket(position: IPosition, maxDuration?: number): [
         Range,
         Range
@@ -27,23 +63,40 @@ export interface IFoundBracket {
 }
 export declare class BracketInfo {
     readonly range: Range;
+    /** 0-based level */
     readonly nestingLevel: number;
     readonly nestingLevelOfEqualBracketType: number;
     readonly isInvalid: boolean;
-    constructor(range: Range, nestingLevel: number, nestingLevelOfEqualBracketType: number, isInvalid: boolean);
+    constructor(range: Range, 
+    /** 0-based level */
+    nestingLevel: number, nestingLevelOfEqualBracketType: number, isInvalid: boolean);
 }
 export declare class BracketPairInfo {
     readonly range: Range;
     readonly openingBracketRange: Range;
     readonly closingBracketRange: Range | undefined;
+    /** 0-based */
     readonly nestingLevel: number;
     readonly nestingLevelOfEqualBracketType: number;
     private readonly bracketPairNode;
-    constructor(range: Range, openingBracketRange: Range, closingBracketRange: Range | undefined, nestingLevel: number, nestingLevelOfEqualBracketType: number, bracketPairNode: PairAstNode);
+    constructor(range: Range, openingBracketRange: Range, closingBracketRange: Range | undefined, 
+    /** 0-based */
+    nestingLevel: number, nestingLevelOfEqualBracketType: number, bracketPairNode: PairAstNode);
     get openingBracketInfo(): OpeningBracketKind;
     get closingBracketInfo(): ClosingBracketKind | undefined;
 }
 export declare class BracketPairWithMinIndentationInfo extends BracketPairInfo {
+    /**
+     * -1 if not requested, otherwise the size of the minimum indentation in the bracket pair in terms of visible columns.
+    */
     readonly minVisibleColumnIndentation: number;
-    constructor(range: Range, openingBracketRange: Range, closingBracketRange: Range | undefined, nestingLevel: number, nestingLevelOfEqualBracketType: number, bracketPairNode: PairAstNode, minVisibleColumnIndentation: number);
+    constructor(range: Range, openingBracketRange: Range, closingBracketRange: Range | undefined, 
+    /**
+     * 0-based
+    */
+    nestingLevel: number, nestingLevelOfEqualBracketType: number, bracketPairNode: PairAstNode, 
+    /**
+     * -1 if not requested, otherwise the size of the minimum indentation in the bracket pair in terms of visible columns.
+    */
+    minVisibleColumnIndentation: number);
 }