@codingame/monaco-vscode-api 20.1.1 → 20.2.1

package/vscode/src/vs/editor/browser/widget/codeEditor/codeEditorContributions.d.ts

@@ -6,8 +6,17 @@ import { IInstantiationService } from "../../../../platform/instantiation/common
 export declare class CodeEditorContributions extends Disposable {
     private _editor;
     private _instantiationService;
+    /**
+     * Contains all instantiated contributions.
+     */
     private readonly _instances;
+    /**
+     * Contains contributions which are not yet instantiated.
+     */
     private readonly _pending;
+    /**
+     * Tracks which instantiation kinds are still left in `_pending`.
+     */
     private readonly _finishedInstantiation;
     constructor();
     initialize(editor: ICodeEditor, contributions: IEditorContributionDescription[], instantiationService: IInstantiationService): void;
@@ -18,6 +27,9 @@ export declare class CodeEditorContributions extends Disposable {
         [key: string]: any;
     }): void;
     get(id: string): IEditorContribution | null;
+    /**
+     * used by tests
+     */
     set(id: string, value: IEditorContribution): void;
     onBeforeInteractionEvent(): void;
     onAfterModelAttached(): IDisposable;

package/vscode/src/vs/editor/browser/widget/codeEditor/codeEditorWidget.d.ts

@@ -153,6 +153,9 @@ export declare class CodeEditorWidget extends Disposable implements editorBrowse
     private _contentWidgets;
     private _overlayWidgets;
     private _glyphMarginWidgets;
+    /**
+     * map from "parent" decoration type to live decoration ids.
+     */
     private _decorationTypeKeysToIds;
     private _decorationTypeSubtypes;
     private _bannerDomNode;
@@ -264,6 +267,9 @@ export declare class CodeEditorWidget extends Disposable implements editorBrowse
     getLineDecorations(lineNumber: number): IModelDecoration[] | null;
     getDecorationsInRange(range: Range): IModelDecoration[] | null;
     getFontSizeAtPosition(position: IPosition): string | null;
+    /**
+     * @deprecated
+     */
     deltaDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[]): string[];
     removeDecorations(decorationIds: string[]): void;
     setDecorationsByType(description: string, decorationTypeKey: string, decorationOptions: editorCommon.IDecorationOptions[]): readonly string[];
@@ -321,11 +327,37 @@ export declare class CodeEditorWidget extends Disposable implements editorBrowse
     private _endUpdate;
 }
 export interface ICodeEditorWidgetOptions {
+    /**
+     * Is this a simple widget (not a real code editor)?
+     * Defaults to false.
+     */
     isSimpleWidget?: boolean;
+    /**
+     * Is this a standalone editor
+     * Defaults to false.
+     */
     isStandaloneEditor?: boolean;
+    /**
+     * Contributions to instantiate.
+     * When provided, only the contributions included will be instantiated.
+     * To include the defaults, those must be provided as well via [...EditorExtensionsRegistry.getEditorContributions()]
+     * Defaults to EditorExtensionsRegistry.getEditorContributions().
+     */
     contributions?: IEditorContributionDescription[];
+    /**
+     * Telemetry data associated with this CodeEditorWidget.
+     * Defaults to null.
+     */
     telemetryData?: object;
+    /**
+     * The ID of the context menu.
+     * Defaults to MenuId.SimpleEditorContext or MenuId.EditorContext depending on whether the widget is simple.
+     */
     contextMenuId?: MenuId;
+    /**
+     * Define extra context keys that will be defined in the context service
+     * for the editor.
+     */
     contextKeyValues?: Record<string, ContextKeyValue>;
 }
 declare class ModelData {

package/vscode/src/vs/editor/browser/widget/codeEditor/editor.css

@@ -1,9 +1,22 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+/* -------------------- IE10 remove auto clear button -------------------- */
+
 ::-ms-clear {
 	display: none;
 }
+
+/* All widgets */
+/* I am not a big fan of this rule */
 .monaco-editor .editor-widget input {
 	color: inherit;
 }
+
+/* -------------------- Editor -------------------- */
+
 .monaco-editor {
 	position: relative;
 	overflow: visible;
@@ -31,6 +44,7 @@
 .monaco-editor.hc-black .symbolHighlight, .monaco-editor.hc-light .symbolHighlight {
 	border-style: dotted;
 }
+
 .monaco-editor .editorCanvas {
 	position: absolute;
 	width: 100%;
@@ -38,18 +52,31 @@
 	z-index: 0;
 	pointer-events: none;
 }
+
+/* -------------------- Misc -------------------- */
+
 .monaco-editor .overflow-guard {
 	position: relative;
 	overflow: hidden;
 }
+
 .monaco-editor .view-overlays {
 	position: absolute;
 	top: 0;
 }
+
 .monaco-editor .view-overlays > div, .monaco-editor .margin-view-overlays > div {
 	position: absolute;
 	width: 100%;
 }
+
+/*
+.monaco-editor .auto-closed-character {
+	opacity: 0.3;
+}
+*/
+
+
 .monaco-editor .squiggly-error {
 	border-bottom: 4px double var(--vscode-editorError-border);
 }

package/vscode/src/vs/editor/browser/widget/diffEditor/commands.d.ts

@@ -49,4 +49,8 @@ export declare class AccessibleDiffViewerPrev extends Action2 {
 }
 export declare function findDiffEditor(accessor: ServicesAccessor, originalUri: URI, modifiedUri: URI): IDiffEditor | null;
 export declare function findFocusedDiffEditor(accessor: ServicesAccessor): IDiffEditor | null;
+/**
+ * If `editor` is the original or modified editor of a diff editor, it returns it.
+ * It returns null otherwise.
+ */
 export declare function findDiffEditorContainingCodeEditor(accessor: ServicesAccessor, editor: ICodeEditor): IDiffEditor | null;

package/vscode/src/vs/editor/browser/widget/diffEditor/components/accessibleDiffViewer.css

@@ -1,41 +1,58 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
 .monaco-diff-editor .diff-review {
 	position: absolute;
+
 }
+
 .monaco-component.diff-review {
 	user-select: none;
 	-webkit-user-select: none;
 	z-index: 99;
+
+
 	.diff-review-line-number {
 		text-align: right;
 		display: inline-block;
 		color: var(--vscode-editorLineNumber-foreground);
 	}
+
 	.diff-review-summary {
 		padding-left: 10px;
 	}
+
 	.diff-review-shadow {
 		position: absolute;
 		box-shadow: var(--vscode-scrollbar-shadow) 0 -6px 6px -6px inset;
 	}
+
 	.diff-review-row {
 		white-space: pre;
 	}
+
 	.diff-review-table {
 		display: table;
 		min-width: 100%;
 	}
+
 	.diff-review-row {
 		display: table-row;
 		width: 100%;
 	}
+
 	.diff-review-spacer {
 		display: inline-block;
 		width: 10px;
 		vertical-align: middle;
 	}
+
 	.diff-review-spacer > .codicon {
 		font-size: 9px !important;
 	}
+
 	.diff-review-actions {
 		display: inline-block;
 		position: absolute;
@@ -43,14 +60,17 @@
 		top: 2px;
 		z-index: 100;
 	}
+
 	.diff-review-actions .action-label {
 		width: 16px;
 		height: 16px;
 		margin: 2px 0;
 	}
+
 	.revertButton {
 		cursor: pointer;
 	}
+
 	.action-label {
 		background: var(--vscode-editorActionList-background);
 	}

package/vscode/src/vs/editor/browser/widget/diffEditor/components/accessibleDiffViewer.d.ts

@@ -10,9 +10,15 @@ import { DiffEditorEditors } from "./diffEditorEditors.js";
 export interface IAccessibleDiffViewerModel {
     getOriginalModel(): ITextModel;
     getOriginalOptions(): IComputedEditorOptions;
+    /**
+     * Should do: `setSelection`, `revealLine` and `focus`
+     */
     originalReveal(range: Range): void;
     getModifiedModel(): ITextModel;
     getModifiedOptions(): IComputedEditorOptions;
+    /**
+     * Should do: `setSelection`, `revealLine` and `focus`
+     */
     modifiedReveal(range?: Range): void;
     modifiedSetSelection(range: Range): void;
     modifiedFocus(): void;

package/vscode/src/vs/editor/browser/widget/diffEditor/components/diffEditorSash.d.ts

@@ -15,6 +15,7 @@ export declare class SashLayout {
         height: IObservable<number>;
         width: IObservable<number>;
     });
+    /** @pure */
     private _computeSashLeft;
 }
 export declare class DiffEditorSash extends Disposable {

package/vscode/src/vs/editor/browser/widget/diffEditor/components/diffEditorViewZones/diffEditorViewZones.d.ts

@@ -9,6 +9,13 @@ import { IClipboardService } from "../../../../../../platform/clipboard/common/c
 import { IContextMenuService } from "../../../../../../platform/contextview/browser/contextView.service.js";
 import { DiffEditorOptions } from "../../diffEditorOptions.js";
 import { Range } from "../../../../../common/core/range.js";
+/**
+ * Ensures both editors have the same height by aligning unchanged lines.
+ * In inline view mode, inserts viewzones to show deleted code from the original text model in the modified code editor.
+ * Synchronizes scrolling.
+ *
+ * Make sure to add the view zones!
+ */
 export declare class DiffEditorViewZones extends Disposable {
     private readonly _targetWindow;
     private readonly _editors;

package/vscode/src/vs/editor/browser/widget/diffEditor/diffEditorWidget.d.ts

@@ -22,6 +22,10 @@ import { RefCounted } from "./utils.js";
 export interface IDiffCodeEditorWidgetOptions {
     originalEditor?: ICodeEditorWidgetOptions;
     modifiedEditor?: ICodeEditorWidgetOptions;
+    /**
+     * Is this a standalone editor
+     * Defaults to false.
+     */
     isStandaloneEditor?: boolean;
 }
 export declare class DiffEditorWidget extends DelegatingEditor implements IDiffEditor {
@@ -71,6 +75,9 @@ export declare class DiffEditorWidget extends DelegatingEditor implements IDiffE
     getModel(): IDiffEditorModel | null;
     setModel(model: IDiffEditorModel | null | IDiffEditorViewModel): void;
     setDiffModel(viewModel: RefCounted<IDiffEditorViewModel> | null, tx?: ITransaction): void;
+    /**
+     * @param changedOptions Only has values for top-level options that have actually changed.
+     */
     updateOptions(changedOptions: IDiffEditorOptions): void;
     getDomNode(): HTMLElement;
     getContainerDomNode(): HTMLElement;
@@ -82,6 +89,9 @@ export declare class DiffEditorWidget extends DelegatingEditor implements IDiffE
     get ignoreTrimWhitespace(): boolean;
     get maxComputationTime(): number;
     get renderSideBySide(): boolean;
+    /**
+     * @deprecated Use `this.getDiffComputationResult().changes2` instead.
+     */
     getLineChanges(): ILineChange[] | null;
     getDiffComputationResult(): IDiffComputationResult | null;
     revert(diff: LineRangeMapping): void;

package/vscode/src/vs/editor/browser/widget/diffEditor/features/gutterFeature.d.ts

@@ -33,6 +33,9 @@ export declare class DiffEditorGutter extends Disposable {
 }
 export interface DiffEditorSelectionHunkToolbarContext {
     mapping: DetailedLineRangeMapping;
+    /**
+     * The original text with the selected modified changes applied.
+    */
     originalWithModifiedChanges: string;
     modifiedUri: URI;
     originalUri: URI;

package/vscode/src/vs/editor/browser/widget/diffEditor/features/hideUnchangedRegionsFeature.d.ts

@@ -8,6 +8,9 @@ import { DiffEditorEditors } from "../components/diffEditorEditors.js";
 import { DiffEditorOptions } from "../diffEditorOptions.js";
 import { DiffEditorViewModel } from "../diffEditorViewModel.js";
 import { IObservableViewZone } from "../utils.js";
+/**
+ * Make sure to add the view zones to the editor!
+ */
 export declare class HideUnchangedRegionsFeature extends Disposable {
     private readonly _editors;
     private readonly _diffModel;

package/vscode/src/vs/editor/browser/widget/diffEditor/features/revertButtonsFeature.d.ts

@@ -24,6 +24,12 @@ export declare class RevertButton extends Disposable implements IGlyphMarginWidg
     getId(): string;
     private readonly _domNode;
     constructor(_lineNumber: number, _widget: DiffEditorWidget, _diffs: RangeMapping[] | LineRangeMapping, _revertSelection: boolean);
+    /**
+     * Get the dom node of the glyph widget.
+     */
     getDomNode(): HTMLElement;
+    /**
+     * Get the placement of the glyph widget.
+     */
     getPosition(): IGlyphMarginWidgetPosition;
 }