@codingame/monaco-vscode-api 20.1.1 → 20.2.0

package/vscode/src/vs/editor/contrib/rename/browser/renameWidget.css

@@ -1,23 +1,33 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
 .monaco-editor .rename-box {
 	z-index: 100;
 	color: inherit;
 	border-radius: 4px;
 }
+
 .monaco-editor .rename-box.preview {
 	padding: 4px 4px 0 4px;
 }
+
 .monaco-editor .rename-box .rename-input-with-button {
 	padding: 3px;
 	border-radius: 2px;
-	width: calc(100% - 8px);
+	width: calc(100% - 8px); /* 4px padding on each side */
 }
+
 .monaco-editor .rename-box .rename-input {
-	width: calc(100% - 8px);
+	width: calc(100% - 8px); /* 4px padding on each side */
 	padding: 0;
 }
+
 .monaco-editor .rename-box .rename-input:focus {
 	outline: none;
 }
+
 .monaco-editor .rename-box .rename-suggestions-button {
 	display: flex;
 	align-items: center;
@@ -27,16 +37,20 @@
 	border-radius: 5px;
 	cursor: pointer;
 }
+
 .monaco-editor .rename-box .rename-suggestions-button:hover {
 	background-color: var(--vscode-toolbar-hoverBackground)
 }
+
 .monaco-editor .rename-box .rename-candidate-list-container .monaco-list-row {
 	border-radius: 2px;
 }
+
 .monaco-editor .rename-box .rename-label {
 	display: none;
 	opacity: .8;
 }
+
 .monaco-editor .rename-box.preview .rename-label {
 	display: inherit;
 }

package/vscode/src/vs/editor/contrib/rename/browser/renameWidget.d.ts

@@ -11,6 +11,12 @@ import { ILogService } from "../../../../platform/log/common/log.service.js";
 import { IThemeService } from "../../../../platform/theme/common/themeService.service.js";
 export declare const CONTEXT_RENAME_INPUT_VISIBLE: RawContextKey<boolean>;
 export declare const CONTEXT_RENAME_INPUT_FOCUSED: RawContextKey<boolean>;
+/**
+ * "Source" of the new name:
+ * - 'inputField' - user entered the new name
+ * - 'renameSuggestion' - user picked from rename suggestions
+ * - 'userEditedRenameSuggestion' - user _likely_ edited a rename suggestion ("likely" because when input started being edited, a rename suggestion had focus)
+ */
 export type NewNameSource = {
     k: "inputField";
 } | {
@@ -18,6 +24,9 @@ export type NewNameSource = {
 } | {
     k: "userEditedRenameSuggestion";
 };
+/**
+ * Various statistics regarding rename input field
+ */
 export type RenameWidgetStats = {
     nRenameSuggestions: number;
     source: NewNameSource;
@@ -26,11 +35,17 @@ export type RenameWidgetStats = {
     hadAutomaticRenameSuggestionsInvocation: boolean;
 };
 export type RenameWidgetResult = {
+    /**
+     * The new name to be used
+     */
     newName: string;
     wantsPreview?: boolean;
     stats: RenameWidgetStats;
 };
 interface IRenameWidget {
+    /**
+     * @returns a `boolean` standing for `shouldFocusEditor`, if user didn't pick a new name, or a {@link RenameWidgetResult}
+     */
     getInput(where: IRange, currentName: string, supportPreview: boolean, requestRenameSuggestions: (triggerKind: NewSymbolNameTriggerKind, cts: CancellationToken) => ProviderResult<NewSymbolName[]>[], cts: CancellationTokenSource): Promise<RenameWidgetResult | boolean>;
     acceptInput(wantsPreview: boolean): void;
     cancelInput(focusEditor: boolean, caller: string): void;
@@ -52,10 +67,16 @@ export declare class RenameWidget implements IRenameWidget, IContentWidget, IDis
     private _nPxAvailableBelow?;
     private _position?;
     private _currentName?;
+    /** Is true if input field got changes when a rename candidate was focused; otherwise, false */
     private _isEditingRenameCandidate;
     private readonly _candidates;
     private _visible?;
+    /** must be reset at session start */
     private _beforeFirstInputFieldEditSW;
+    /**
+     * Milliseconds before user edits the input field for the first time
+     * @remarks must be set once per session
+     */
     private _timeBeforeFirstInputFieldEdit;
     private _nRenameSuggestionsInvocations;
     private _hadAutomaticRenameSuggestionsInvocation;
@@ -83,8 +104,14 @@ export declare class RenameWidget implements IRenameWidget, IContentWidget, IDis
     cancelInput(focusEditor: boolean, caller: string): void;
     focusNextRenameSuggestion(): void;
     focusPreviousRenameSuggestion(): void;
+    /**
+     * @param requestRenameCandidates is `undefined` when there are no rename suggestion providers
+     */
     getInput(where: IRange, currentName: string, supportPreview: boolean, requestRenameCandidates: undefined | ((triggerKind: NewSymbolNameTriggerKind, cts: CancellationToken) => ProviderResult<NewSymbolName[]>[]), cts: CancellationTokenSource): Promise<RenameWidgetResult | boolean>;
     private _requestRenameCandidates;
+    /**
+     * This allows selecting only part of the symbol name in the input field based on the selection in the editor
+     */
     private _getSelection;
     private _show;
     private _updateRenameCandidates;

package/vscode/src/vs/editor/contrib/snippet/browser/snippetParser.d.ts

@@ -122,6 +122,10 @@ export declare class TextmateSnippet extends Marker {
 }
 export declare class SnippetParser {
     static escape(value: string): string;
+    /**
+     * Takes a snippet and returns the insertable string, e.g return the snippet-string
+     * without any placeholder, tabstop, variables etc...
+     */
     static asInsertText(value: string): string;
     static guessNeedsClipboard(template: string): boolean;
     private _scanner;

package/vscode/src/vs/editor/contrib/snippet/browser/snippetSession.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 .snippet-placeholder {
 	min-width: 2px;
 	outline-style: solid;
@@ -5,6 +10,7 @@
 	background-color: var(--vscode-editor-snippetTabstopHighlightBackground, transparent);
 	outline-color: var(--vscode-editor-snippetTabstopHighlightBorder, transparent);
 }
+
 .monaco-editor .finish-snippet-placeholder {
 	outline-style: solid;
 	outline-width: 1px;

package/vscode/src/vs/editor/contrib/snippet/browser/snippetSession.d.ts

@@ -27,6 +27,10 @@ export declare class OneSnippet {
     get isAtFirstPlaceholder(): boolean;
     get isAtLastPlaceholder(): boolean;
     get hasPlaceholder(): boolean;
+    /**
+     * A snippet is trivial when it has no placeholder or only a final placeholder at
+     * its very end
+     */
     get isTrivialSnippet(): boolean;
     computePossibleSelections(): Map<number, Range[]>;
     get activeChoice(): {

package/vscode/src/vs/editor/contrib/stickyScroll/browser/stickyScroll.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 .sticky-widget {
 	overflow: hidden;
 	border-bottom: 1px solid var(--vscode-editorStickyScroll-border);
@@ -7,13 +12,16 @@
 	right: initial !important;
 	margin-left: '0px';
 }
+
 .monaco-editor .sticky-widget .sticky-widget-line-numbers {
 	float: left;
 	background-color: var(--vscode-editorStickyScrollGutter-background);
 }
+
 .monaco-editor .sticky-widget.peek .sticky-widget-line-numbers {
 	background-color: var(--vscode-peekViewEditorStickyScrollGutter-background);
 }
+
 .monaco-editor .sticky-widget .sticky-widget-lines-scrollable {
 	display: inline-block;
 	position: absolute;
@@ -21,13 +29,16 @@
 	width: var(--vscode-editorStickyScroll-scrollableWidth);
 	background-color: var(--vscode-editorStickyScroll-background);
 }
+
 .monaco-editor .sticky-widget.peek .sticky-widget-lines-scrollable {
 	background-color: var(--vscode-peekViewEditorStickyScroll-background);
 }
+
 .monaco-editor .sticky-widget .sticky-widget-lines {
 	position: absolute;
 	background-color: inherit;
 }
+
 .monaco-editor .sticky-widget .sticky-line-number,
 .monaco-editor .sticky-widget .sticky-line-content {
 	color: var(--vscode-editorLineNumber-foreground);
@@ -36,6 +47,7 @@
 	position: absolute;
 	background-color: inherit;
 }
+
 .monaco-editor .sticky-widget .sticky-line-number .codicon-folding-expanded,
 .monaco-editor .sticky-widget .sticky-line-number .codicon-folding-collapsed {
 	float: right;
@@ -43,15 +55,18 @@
 	position: absolute;
 	margin-left: 2px;
 }
+
 .monaco-editor .sticky-widget .sticky-line-content {
 	width: var(--vscode-editorStickyScroll-scrollableWidth);
 	background-color: inherit;
 	white-space: nowrap;
 }
+
 .monaco-editor .sticky-widget .sticky-line-number-inner {
 	display: inline-block;
 	text-align: right;
 }
+
 .monaco-editor .sticky-widget .sticky-line-content:hover {
 	background-color: var(--vscode-editorStickyScrollHover-background);
 	cursor: pointer;

package/vscode/src/vs/editor/contrib/stickyScroll/browser/stickyScrollElement.d.ts

@@ -5,10 +5,31 @@ export declare class StickyRange {
     constructor(startLineNumber: number, endLineNumber: number);
 }
 export declare class StickyElement {
+    /**
+     * Range of line numbers spanned by the current scope
+     */
     readonly range: StickyRange | undefined;
+    /**
+     * Must be sorted by start line number
+    */
     readonly children: StickyElement[];
+    /**
+     * Parent sticky outline element
+     */
     readonly parent: StickyElement | undefined;
-    constructor(range: StickyRange | undefined, children: StickyElement[], parent: StickyElement | undefined);
+    constructor(
+    /**
+     * Range of line numbers spanned by the current scope
+     */
+    range: StickyRange | undefined, 
+    /**
+     * Must be sorted by start line number
+    */
+    children: StickyElement[], 
+    /**
+     * Parent sticky outline element
+     */
+    parent: StickyElement | undefined);
 }
 export declare class StickyModel {
     readonly uri: URI;

package/vscode/src/vs/editor/contrib/stickyScroll/browser/stickyScrollModelProvider.d.ts

@@ -5,6 +5,11 @@ import { CancellationToken } from "../../../../base/common/cancellation.js";
 import { ILanguageConfigurationService } from "../../../common/languages/languageConfigurationRegistry.service.js";
 import { StickyModel } from "./stickyScrollElement.js";
 export interface IStickyModelProvider extends IDisposable {
+    /**
+     * Method which updates the sticky model
+     * @param token cancellation token
+     * @returns the sticky model
+     */
     update(token: CancellationToken): Promise<StickyModel | null>;
 }
 export declare class StickyModelProvider extends Disposable implements IStickyModelProvider {

package/vscode/src/vs/editor/contrib/stickyScroll/browser/stickyScrollProvider.d.ts

@@ -12,10 +12,25 @@ export declare class StickyLineCandidate {
     constructor(startLineNumber: number, endLineNumber: number, top: number, height: number);
 }
 export interface IStickyLineCandidateProvider {
+    /**
+     * Dispose resources used by the provider.
+     */
     dispose(): void;
+    /**
+     * Get the version ID of the sticky model.
+     */
     getVersionId(): number | undefined;
+    /**
+     * Update the sticky line candidates.
+     */
     update(): Promise<void>;
+    /**
+     * Get sticky line candidates intersecting a given range.
+     */
     getCandidateStickyLinesIntersecting(range: StickyRange): StickyLineCandidate[];
+    /**
+     * Event triggered when sticky scroll changes.
+     */
     onDidChangeStickyScroll: Event<void>;
 }
 export declare class StickyLineCandidateProvider extends Disposable implements IStickyLineCandidateProvider {
@@ -31,13 +46,40 @@ export declare class StickyLineCandidateProvider extends Disposable implements I
     private _cts;
     private _stickyModelProvider;
     constructor(editor: ICodeEditor, _languageFeaturesService: ILanguageFeaturesService, _languageConfigurationService: ILanguageConfigurationService);
+    /**
+     * Read and apply the sticky scroll configuration.
+     */
     private readConfiguration;
+    /**
+     * Get the version ID of the sticky model.
+     */
     getVersionId(): number | undefined;
+    /**
+     * Update the sticky model provider.
+     */
     private updateStickyModelProvider;
+    /**
+     * Update the sticky line candidates.
+     */
     update(): Promise<void>;
+    /**
+     * Update the sticky model based on the current editor state.
+     */
     private updateStickyModel;
+    /**
+     * Get sticky line candidates intersecting a given range.
+     */
     getCandidateStickyLinesIntersecting(range: StickyRange): StickyLineCandidate[];
+    /**
+     * Get sticky line candidates intersecting a given range from the sticky model.
+     */
     private getCandidateStickyLinesIntersectingFromStickyModel;
+    /**
+     * Filter out sticky line candidates that are within hidden ranges.
+     */
     private filterHiddenRanges;
+    /**
+     * Update the binary search index.
+     */
     private updateIndex;
 }

package/vscode/src/vs/editor/contrib/stickyScroll/browser/stickyScrollWidget.d.ts

@@ -55,12 +55,31 @@ export declare class StickyScrollWidget extends Disposable implements IOverlayWi
     getPosition(): IOverlayWidgetPosition | null;
     getMinContentWidthInPx(): number;
     focusLineWithIndex(index: number): void;
+    /**
+     * Given a leaf dom node, tries to find the editor position.
+     */
     getEditorPositionFromNode(spanDomNode: HTMLElement | null): Position | null;
     getLineNumberFromChildDomNode(domNode: HTMLElement | null): number | null;
     private _getRenderedStickyLineFromChildDomNode;
+    /**
+     * Given a child dom node, tries to find the line number attribute that was stored in the node.
+     * @returns the attribute value or null if none is found.
+     */
     getLineIndexFromChildDomNode(domNode: HTMLElement | null): number | null;
+    /**
+     * Given a child dom node, tries to find if it is (contained in) a sticky line.
+     * @returns a boolean.
+     */
     isInStickyLine(domNode: HTMLElement | null): boolean;
+    /**
+     * Given a child dom node, tries to find if this dom node is (contained in) a sticky folding icon.
+     * @returns a boolean.
+     */
     isInFoldingIconDomNode(domNode: HTMLElement | null): boolean;
+    /**
+     * Given the dom node, finds if it or its parent sequence contains the given attribute.
+     * @returns the attribute value or undefined.
+     */
     private _getAttributeValue;
 }
 declare class RenderedStickyLine {

package/vscode/src/vs/editor/contrib/suggest/browser/completionModel.d.ts

@@ -11,6 +11,9 @@ export declare class LineContext {
     readonly characterCountDelta: number;
     constructor(leadingLineContent: string, characterCountDelta: number);
 }
+/**
+ * Sorted, filtered completion view model
+ * */
 export declare class CompletionModel {
     readonly clipboardText: string | undefined;
     private readonly _items;