@codingame/monaco-vscode-api 20.1.1 → 20.2.1

package/vscode/src/vs/editor/standalone/browser/quickInput/standaloneQuickInput.css

@@ -1,26 +1,37 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
 .quick-input-widget {
 	font-size: 13px;
 }
+
 .quick-input-widget .monaco-highlighted-label .highlight,
 .quick-input-widget .monaco-highlighted-label .highlight {
 	color: #0066BF;
 }
+
 .vs .quick-input-widget .monaco-list-row.focused .monaco-highlighted-label .highlight,
 .vs .quick-input-widget .monaco-list-row.focused .monaco-highlighted-label .highlight {
 	color: #9DDDFF;
 }
+
 .vs-dark .quick-input-widget .monaco-highlighted-label .highlight,
 .vs-dark .quick-input-widget .monaco-highlighted-label .highlight {
 	color: #0097fb;
 }
+
 .hc-black .quick-input-widget .monaco-highlighted-label .highlight,
 .hc-black .quick-input-widget .monaco-highlighted-label .highlight {
 	color: #F38518;
 }
+
 .hc-light .quick-input-widget .monaco-highlighted-label .highlight,
 .hc-light .quick-input-widget .monaco-highlighted-label .highlight {
 	color: #0F4A85;
 }
+
 .monaco-keybinding > .monaco-keybinding-key {
 	background-color: rgba(221, 221, 221, 0.4);
 	border: solid 1px rgba(204, 204, 204, 0.4);
@@ -28,18 +39,21 @@
 	box-shadow: inset 0 -1px 0 rgba(187, 187, 187, 0.4);
 	color: #555;
 }
+
 .hc-black .monaco-keybinding > .monaco-keybinding-key {
 	background-color: transparent;
 	border: solid 1px rgb(111, 195, 223);
 	box-shadow: none;
 	color: #fff;
 }
+
 .hc-light .monaco-keybinding > .monaco-keybinding-key {
 	background-color: transparent;
 	border: solid 1px #0F4A85;
 	box-shadow: none;
 	color: #292929;
 }
+
 .vs-dark .monaco-keybinding > .monaco-keybinding-key {
 	background-color: rgba(128, 128, 128, 0.17);
 	border: solid 1px rgba(51, 51, 51, 0.6);

package/vscode/src/vs/editor/standalone/browser/standaloneCodeEditor.d.ts

@@ -27,25 +27,95 @@ import { ILanguageFeaturesService } from "../../common/services/languageFeatures
 import { DiffEditorWidget } from "../../browser/widget/diffEditor/diffEditorWidget.js";
 import { IAccessibilitySignalService } from "../../../platform/accessibilitySignal/browser/accessibilitySignalService.service.js";
 import { IHoverService } from "../../../platform/hover/browser/hover.service.js";
+/**
+ * Description of an action contribution
+ */
 export type IActionDescriptor = import("monaco-editor").editor.IActionDescriptor;
+/**
+ * Options which apply for all editors.
+ */
 export interface IGlobalEditorOptions {
+    /**
+     * The number of spaces a tab is equal to.
+     * This setting is overridden based on the file contents when `detectIndentation` is on.
+     * Defaults to 4.
+     */
     tabSize?: number;
+    /**
+     * Insert spaces when pressing `Tab`.
+     * This setting is overridden based on the file contents when `detectIndentation` is on.
+     * Defaults to true.
+     */
     insertSpaces?: boolean;
+    /**
+     * Controls whether `tabSize` and `insertSpaces` will be automatically detected when a file is opened based on the file contents.
+     * Defaults to true.
+     */
     detectIndentation?: boolean;
+    /**
+     * Remove trailing auto inserted whitespace.
+     * Defaults to true.
+     */
     trimAutoWhitespace?: boolean;
+    /**
+     * Special handling for large files to disable certain memory intensive features.
+     * Defaults to true.
+     */
     largeFileOptimizations?: boolean;
+    /**
+     * Controls whether completions should be computed based on words in the document.
+     * Defaults to true.
+     */
     wordBasedSuggestions?: "off" | "currentDocument" | "matchingDocuments" | "allDocuments";
+    /**
+     * Controls whether word based completions should be included from opened documents of the same language or any language.
+     */
     wordBasedSuggestionsOnlySameLanguage?: boolean;
+    /**
+     * Controls whether the semanticHighlighting is shown for the languages that support it.
+     * true: semanticHighlighting is enabled for all themes
+     * false: semanticHighlighting is disabled for all themes
+     * 'configuredByTheme': semanticHighlighting is controlled by the current color theme's semanticHighlighting setting.
+     * Defaults to 'byTheme'.
+     */
     "semanticHighlighting.enabled"?: true | false | "configuredByTheme";
+    /**
+     * Keep peek editors open even when double-clicking their content or when hitting `Escape`.
+     * Defaults to false.
+     */
     stablePeek?: boolean;
+    /**
+     * Lines above this length will not be tokenized for performance reasons.
+     * Defaults to 20000.
+     */
     maxTokenizationLineLength?: number;
+    /**
+     * Theme to be used for rendering.
+     * The current out-of-the-box available themes are: 'vs' (default), 'vs-dark', 'hc-black', 'hc-light'.
+     * You can create custom themes via `monaco.editor.defineTheme`.
+     * To switch a theme, use `monaco.editor.setTheme`.
+     * **NOTE**: The theme might be overwritten if the OS is in high contrast mode, unless `autoDetectHighContrast` is set to false.
+     */
     theme?: string;
+    /**
+     * If enabled, will automatically change to high contrast theme if the OS is using a high contrast theme.
+     * Defaults to true.
+     */
     autoDetectHighContrast?: boolean;
 }
+/**
+ * The options to create an editor.
+ */
 export type IStandaloneEditorConstructionOptions = import("monaco-editor").editor.IStandaloneEditorConstructionOptions;
+/**
+ * The options to create a diff editor.
+ */
 export type IStandaloneDiffEditorConstructionOptions = import("monaco-editor").editor.IStandaloneDiffEditorConstructionOptions;
 export type IStandaloneCodeEditor = import("monaco-editor").editor.IStandaloneCodeEditor;
 export type IStandaloneDiffEditor = import("monaco-editor").editor.IStandaloneDiffEditor;
+/**
+ * A code editor to be used both by the standalone editor and the standalone diff editor.
+ */
 export declare class StandaloneCodeEditor extends CodeEditorWidget implements IStandaloneCodeEditor {
     private readonly _standaloneKeybindingService;
     constructor(domElement: HTMLElement, _options: Readonly<IStandaloneEditorConstructionOptions>, instantiationService: IInstantiationService, codeEditorService: ICodeEditorService, commandService: ICommandService, contextKeyService: IContextKeyService, hoverService: IHoverService, keybindingService: IKeybindingService, themeService: IThemeService, notificationService: INotificationService, accessibilityService: IAccessibilityService, languageConfigurationService: ILanguageConfigurationService, languageFeaturesService: ILanguageFeaturesService);
@@ -76,4 +146,7 @@ export declare class StandaloneDiffEditor2 extends DiffEditorWidget implements I
     createContextKey<T extends ContextKeyValue = ContextKeyValue>(key: string, defaultValue: T): IContextKey<T>;
     addAction(descriptor: IActionDescriptor): IDisposable;
 }
+/**
+ * @internal
+ */
 export declare function createTextModel(modelService: IModelService, languageService: ILanguageService, value: string, languageId: string | undefined, uri: URI | undefined): ITextModel;

package/vscode/src/vs/editor/standalone/browser/standaloneServices.d.ts

@@ -68,6 +68,9 @@ export declare class StandaloneKeybindingService extends AbstractKeybindingServi
     _dumpDebugInfo(): string;
     _dumpDebugInfoJSON(): string;
     registerSchemaContribution(contribution: KeybindingsSchemaContribution): IDisposable;
+    /**
+     * not yet supported
+     */
     enableKeybindingHoldMode(commandId: string): Promise<void> | undefined;
 }
 export declare class StandaloneConfigurationService implements IConfigurationService {
@@ -98,8 +101,15 @@ export declare class StandaloneConfigurationService implements IConfigurationSer
 }
 export declare function updateConfigurationService(configurationService: IConfigurationService, source: any, isDiffEditor: boolean): void;
 export type IEditorOverrideServices = import("monaco-editor").editor.IEditorOverrideServices;
+/**
+ * We don't want to eagerly instantiate services because embedders get a one time chance
+ * to override services when they create the first editor.
+ */
 export declare namespace StandaloneServices {
     function get<T>(serviceId: ServiceIdentifier<T>): T;
     function initialize(overrides: IEditorOverrideServices): IInstantiationService;
+    /**
+     * Executes callback once services are initialized.
+     */
     function withServices(callback: () => IDisposable): IDisposable;
 }

package/vscode/src/vs/editor/standalone/browser/standaloneTreeSitterLibraryService.d.ts

@@ -6,6 +6,16 @@ export declare class StandaloneTreeSitterLibraryService implements ITreeSitterLi
     getParserClass(): Promise<typeof Parser>;
     supportsLanguage(languageId: string, reader: IReader | undefined): boolean;
     getLanguage(languageId: string, reader: IReader | undefined): Language | undefined;
+    /**
+     * Return value of null indicates that there are no injection queries for this language.
+     * @param languageId
+     * @param reader
+     */
     getInjectionQueries(languageId: string, reader: IReader | undefined): Query | null | undefined;
+    /**
+     * Return value of null indicates that there are no highlights queries for this language.
+     * @param languageId
+     * @param reader
+     */
     getHighlightingQueries(languageId: string, reader: IReader | undefined): Query | null | undefined;
 }

package/vscode/src/vs/nls.d.ts

@@ -8,28 +8,124 @@ export interface ILocalizedString {
     value: string;
 }
 export declare function isInitialized(): boolean;
+/**
+ * Marks a string to be localized. Returns the localized string.
+ *
+ * @param info The {@linkcode ILocalizeInfo} which describes the id and comments associated with the localized string.
+ * @param message The string to localize
+ * @param args The arguments to the string
+ *
+ * @note `message` can contain `{n}` notation where it is replaced by the nth value in `...args`
+ * @example `localize({ key: 'sayHello', comment: ['Welcomes user'] }, 'hello {0}', name)`
+ *
+ * @returns string The localized string.
+ */
 export declare function localize(info: ILocalizeInfo, message: string, ...args: (string | number | boolean | undefined | null)[]): string;
+/**
+ * Marks a string to be localized. Returns the localized string.
+ *
+ * @param key The key to use for localizing the string
+ * @param message The string to localize
+ * @param args The arguments to the string
+ *
+ * @note `message` can contain `{n}` notation where it is replaced by the nth value in `...args`
+ * @example For example, `localize('sayHello', 'hello {0}', name)`
+ *
+ * @returns string The localized string.
+ */
 export declare function localize(key: string, message: string, ...args: (string | number | boolean | undefined | null)[]): string;
+/**
+ * Marks a string to be localized. Returns an {@linkcode ILocalizedString}
+ * which contains the localized string and the original string.
+ *
+ * @param info The {@linkcode ILocalizeInfo} which describes the id and comments associated with the localized string.
+ * @param message The string to localize
+ * @param args The arguments to the string
+ *
+ * @note `message` can contain `{n}` notation where it is replaced by the nth value in `...args`
+ * @example `localize2({ key: 'sayHello', comment: ['Welcomes user'] }, 'hello {0}', name)`
+ *
+ * @returns ILocalizedString which contains the localized string and the original string.
+ */
 export declare function localize2(info: ILocalizeInfo, message: string, ...args: (string | number | boolean | undefined | null)[]): ILocalizedString;
+/**
+ * Marks a string to be localized. Returns an {@linkcode ILocalizedString}
+ * which contains the localized string and the original string.
+ *
+ * @param key The key to use for localizing the string
+ * @param message The string to localize
+ * @param args The arguments to the string
+ *
+ * @note `message` can contain `{n}` notation where it is replaced by the nth value in `...args`
+ * @example `localize('sayHello', 'hello {0}', name)`
+ *
+ * @returns ILocalizedString which contains the localized string and the original string.
+ */
 export declare function localize2(key: string, message: string, ...args: (string | number | boolean | undefined | null)[]): ILocalizedString;
 export interface INLSLanguagePackConfiguration {
+    /**
+     * The path to the translations config file that contains pointers to
+     * all message bundles for `main` and extensions.
+     */
     readonly translationsConfigFile: string;
+    /**
+     * The path to the file containing the translations for this language
+     * pack as flat string array.
+     */
     readonly messagesFile: string;
+    /**
+     * The path to the file that can be used to signal a corrupt language
+     * pack, for example when reading the `messagesFile` fails. This will
+     * instruct the application to re-create the cache on next startup.
+     */
     readonly corruptMarkerFile: string;
 }
 export interface INLSConfiguration {
+    /**
+     * Locale as defined in `argv.json` or `app.getLocale()`.
+     */
     readonly userLocale: string;
+    /**
+     * Locale as defined by the OS (e.g. `app.getPreferredSystemLanguages()`).
+     */
     readonly osLocale: string;
+    /**
+     * The actual language of the UI that ends up being used considering `userLocale`
+     * and `osLocale`.
+     */
     readonly resolvedLanguage: string;
+    /**
+     * Defined if a language pack is used that is not the
+     * default english language pack. This requires a language
+     * pack to be installed as extension.
+     */
     readonly languagePack?: INLSLanguagePackConfiguration;
+    /**
+     * The path to the file containing the default english messages
+     * as flat string array. The file is only present in built
+     * versions of the application.
+     */
     readonly defaultMessagesFile: string;
+    /**
+     * Below properties are deprecated and only there to continue support
+     * for `vscode-nls` module that depends on them.
+     * Refs https://github.com/microsoft/vscode-nls/blob/main/src/node/main.ts#L36-L46
+     */
+    /** @deprecated */
     readonly locale: string;
+    /** @deprecated */
     readonly availableLanguages: Record<string, string>;
+    /** @deprecated */
     readonly _languagePackSupport?: boolean;
+    /** @deprecated */
     readonly _languagePackId?: string;
+    /** @deprecated */
     readonly _translationsConfigFile?: string;
+    /** @deprecated */
     readonly _cacheRoot?: string;
+    /** @deprecated */
     readonly _resolvedLanguagePackCoreLocation?: string;
+    /** @deprecated */
     readonly _corruptedFile?: string;
 }
 export interface ILanguagePack {

package/vscode/src/vs/platform/accessibility/browser/accessibleView.d.ts

@@ -40,19 +40,50 @@ export declare enum NavigationType {
 }
 export interface IAccessibleViewOptions {
     readMoreUrl?: string;
+    /**
+     * Defaults to markdown
+     */
     language?: string;
     type: AccessibleViewType;
+    /**
+     * By default, places the cursor on the top line of the accessible view.
+     * If set to 'initial-bottom', places the cursor on the bottom line of the accessible view and preserves it henceforth.
+     * If set to 'bottom', places the cursor on the bottom line of the accessible view.
+     */
     position?: "bottom" | "initial-bottom";
+    /**
+     * @returns a string that will be used as the content of the help dialog
+     * instead of the one provided by default.
+     */
     customHelp?: () => string;
+    /**
+     * If this provider might want to request to be shown again, provide an ID.
+     */
     id?: AccessibleViewProviderId;
+    /**
+     * Keybinding items to configure
+     */
     configureKeybindingItems?: IQuickPickItem[];
+    /**
+     * Keybinding items that are already configured
+     */
     configuredKeybindingItems?: IQuickPickItem[];
 }
 export interface IAccessibleViewContentProvider extends IBasicContentProvider, IDisposable {
     id: AccessibleViewProviderId;
     verbositySettingKey: string;
+    /**
+     * Note that a Codicon class should be provided for each action.
+     * If not, a default will be used.
+     */
     onKeyDown?(e: IKeyboardEvent): void;
+    /**
+     * When the language is markdown, this is provided by default.
+     */
     getSymbols?(): IAccessibleViewSymbol[];
+    /**
+     * Note that this will only take effect if the provider has an ID.
+     */
     onDidRequestClearLastProvider?: Event<AccessibleViewProviderId>;
 }
 export interface IAccessibleViewSymbol extends IPickerQuickAccessItem {

package/vscode/src/vs/platform/accessibility/browser/accessibleView.service.d.ts

@@ -13,6 +13,10 @@ export interface IAccessibleViewService {
     getPosition(id: AccessibleViewProviderId): IPosition | undefined;
     setPosition(position: IPosition, reveal?: boolean, select?: boolean): void;
     getLastPosition(): IPosition | undefined;
+    /**
+    * If the setting is enabled, provides the open accessible view hint as a localized string.
+    * @param verbositySettingKey The setting key for the verbosity of the feature
+    */
     getOpenAriaHint(verbositySettingKey: string): string | null;
     getCodeBlockContext(): ICodeBlockActionContext | undefined;
     configureKeybindings(unassigned: boolean): void;

package/vscode/src/vs/platform/accessibility/browser/accessibleViewRegistry.d.ts

@@ -6,6 +6,9 @@ export interface IAccessibleViewImplementation {
     type: AccessibleViewType;
     priority: number;
     name: string;
+    /**
+     * @returns the provider or undefined if the view should not be shown
+     */
     getProvider: (accessor: ServicesAccessor) => AccessibleContentProvider | ExtensionContentProvider | undefined;
     when?: ContextKeyExpression | undefined;
 }

package/vscode/src/vs/platform/accessibility/common/accessibility.d.ts

@@ -1,5 +1,8 @@
 import { RawContextKey } from "../../contextkey/common/contextkey.js";
 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

package/vscode/src/vs/platform/accessibilitySignal/browser/accessibilitySignalService.d.ts

@@ -4,13 +4,26 @@ import { IAccessibilityService } from "../../accessibility/common/accessibility.
 import { IConfigurationService } from "../../configuration/common/configuration.service.js";
 import { ITelemetryService } from "../../telemetry/common/telemetry.service.js";
 import { IAccessibilitySignalService } from "./accessibilitySignalService.service.js";
+/** Make sure you understand the doc comments of the method you want to call when using this token! */
 export declare const AcknowledgeDocCommentsToken: unique symbol;
 export type AccessibilityModality = "sound" | "announcement";
 export interface IAccessbilitySignalOptions {
     allowManyInParallel?: boolean;
     modality?: AccessibilityModality;
+    /**
+     * The source that triggered the signal (e.g. "diffEditor.cursorPositionChanged").
+     */
     source?: string;
+    /**
+     * For actions like save or format, depending on the
+     * configured value, we will only
+     * play the sound if the user triggered the action.
+     */
     userGesture?: boolean;
+    /**
+     * The custom message to alert with.
+     * This will override the default announcement message.
+     */
     customAlertMessage?: string;
 }
 export declare class AccessibilitySignalService extends Disposable implements IAccessibilitySignalService {
@@ -40,6 +53,9 @@ export declare class AccessibilitySignalService extends Disposable implements IA
     onSoundEnabledChanged(signal: AccessibilitySignal): Event<void>;
     getDelayMs(signal: AccessibilitySignal, modality: AccessibilityModality, mode: "line" | "positional"): number;
 }
+/**
+ * Corresponds to the audio files in ./media.
+*/
 export declare class Sound {
     readonly fileName: string;
     private static register;

package/vscode/src/vs/platform/accessibilitySignal/browser/accessibilitySignalService.service.d.ts

@@ -12,8 +12,15 @@ export interface IAccessibilitySignalService {
     playSignalLoop(signal: AccessibilitySignal, milliseconds: number): IDisposable;
     getEnabledState(signal: AccessibilitySignal, userGesture: boolean, modality?: AccessibilityModality | undefined): IValueWithChangeEvent<boolean>;
     getDelayMs(signal: AccessibilitySignal, modality: AccessibilityModality, mode: "line" | "positional"): number;
+    /**
+    * Avoid this method and prefer `.playSignal`!
+    * Only use it when you want to play the sound regardless of enablement, e.g. in the settings quick pick.
+    */
     playSound(signal: Sound, allowManyInParallel: boolean, token: typeof AcknowledgeDocCommentsToken): Promise<void>;
+    /** @deprecated Use getEnabledState(...).onChange */
     isSoundEnabled(signal: AccessibilitySignal): boolean;
+    /** @deprecated Use getEnabledState(...).value */
     isAnnouncementEnabled(signal: AccessibilitySignal): boolean;
+    /** @deprecated Use getEnabledState(...).onChange */
     onSoundEnabledChanged(signal: AccessibilitySignal): Event<void>;
 }

package/vscode/src/vs/platform/action/common/action.d.ts

@@ -4,11 +4,20 @@ import { ThemeIcon } from "../../../base/common/themables.js";
 import { Categories } from "./actionCommonCategories.js";
 import { ICommandMetadata } from "../../commands/common/commands.js";
 export interface ILocalizedString {
+    /**
+     * The localized value of the string.
+     */
     value: string;
+    /**
+     * The original (non localized value of the string)
+     */
     original: string;
 }
 export declare function isLocalizedString(thing: any): thing is ILocalizedString;
 export interface ICommandActionTitle extends ILocalizedString {
+    /**
+     * The title with a mnemonic designation. && precedes the mnemonic.
+     */
     mnemonicTitle?: string;
 }
 export type Icon = {
@@ -16,10 +25,19 @@ export type Icon = {
     light?: URI;
 } | ThemeIcon;
 export interface ICommandActionToggleInfo {
+    /**
+     * The condition that marks the action as toggled.
+     */
     condition: ContextKeyExpression;
     icon?: Icon;
     tooltip?: string;
+    /**
+     * The title that goes well with a a check mark, e.g "(check) Line Numbers" vs "Toggle Line Numbers"
+     */
     title?: string;
+    /**
+     * Like title but with a mnemonic designation.
+     */
     mnemonicTitle?: string;
 }
 export declare function isICommandActionToggleInfo(thing: ContextKeyExpression | ICommandActionToggleInfo | undefined): thing is ICommandActionToggleInfo;
@@ -31,12 +49,26 @@ export interface ICommandAction {
     id: string;
     title: string | ICommandActionTitle;
     shortTitle?: string | ICommandActionTitle;
+    /**
+     * Metadata about this command, used for:
+     * - API commands
+     * - when showing keybindings that have no other UX
+     * - when searching for commands in the Command Palette
+     */
     metadata?: ICommandMetadata;
     category?: keyof typeof Categories | ILocalizedString | string;
     tooltip?: string | ILocalizedString;
     icon?: Icon;
     source?: ICommandActionSource;
+    /**
+     * Precondition controls enablement (for example for a menu item, show
+     * it in grey or for a command, do not allow to invoke it)
+     */
     precondition?: ContextKeyExpression;
+    /**
+     * The action is a toggle action. Define the context key expression that reflects its toggle-state
+     * or define toggle-info including an icon and a title that goes well with a checkmark.
+     */
     toggled?: ContextKeyExpression | ICommandActionToggleInfo;
 }
 export type ISerializableCommandAction = UriDto<ICommandAction>;