@codingame/monaco-vscode-api 20.1.1 → 20.2.1

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

@@ -3,13 +3,61 @@ import { FontInfo } from "./config/fontInfo.js";
 import { Position } from "./core/position.js";
 import { InjectedTextOptions, PositionAffinity } from "./model.js";
 import { LineInjectedText } from "./textModelEvents.js";
+/**
+ * *input*:
+ * ```
+ * xxxxxxxxxxxxxxxxxxxxxxxxxxx
+ * ```
+ *
+ * -> Applying injections `[i...i]`, *inputWithInjections*:
+ * ```
+ * xxxxxx[iiiiiiiiii]xxxxxxxxxxxxxxxxx[ii]xxxx
+ * ```
+ *
+ * -> breaking at offsets `|` in `xxxxxx[iiiiiii|iii]xxxxxxxxxxx|xxxxxx[ii]xxxx|`:
+ * ```
+ * xxxxxx[iiiiiii
+ * iii]xxxxxxxxxxx
+ * xxxxxx[ii]xxxx
+ * ```
+ *
+ * -> applying wrappedTextIndentLength, *output*:
+ * ```
+ * xxxxxx[iiiiiii
+ *    iii]xxxxxxxxxxx
+ *    xxxxxx[ii]xxxx
+ * ```
+ */
 export declare class ModelLineProjectionData {
     injectionOffsets: number[] | null;
+    /**
+     * `injectionOptions.length` must equal `injectionOffsets.length`
+     */
     injectionOptions: InjectedTextOptions[] | null;
+    /**
+     * Refers to offsets after applying injections to the source.
+     * The last break offset indicates the length of the source after applying injections.
+     */
     breakOffsets: number[];
+    /**
+     * Refers to offsets after applying injections
+     */
     breakOffsetsVisibleColumn: number[];
     wrappedTextIndentLength: number;
-    constructor(injectionOffsets: number[] | null, injectionOptions: InjectedTextOptions[] | null, breakOffsets: number[], breakOffsetsVisibleColumn: number[], wrappedTextIndentLength: number);
+    constructor(injectionOffsets: number[] | null, 
+    /**
+     * `injectionOptions.length` must equal `injectionOffsets.length`
+     */
+    injectionOptions: InjectedTextOptions[] | null, 
+    /**
+     * Refers to offsets after applying injections to the source.
+     * The last break offset indicates the length of the source after applying injections.
+     */
+    breakOffsets: number[], 
+    /**
+     * Refers to offsets after applying injections
+     */
+    breakOffsetsVisibleColumn: number[], wrappedTextIndentLength: number);
     getOutputLineCount(): number;
     getMinOutputOffset(outputLineIndex: number): number;
     getLineLength(outputLineIndex: number): number;
@@ -38,6 +86,9 @@ export interface ILineBreaksComputerFactory {
     createLineBreaksComputer(fontInfo: FontInfo, tabSize: number, wrappingColumn: number, wrappingIndent: WrappingIndent, wordBreak: "normal" | "keepAll", wrapOnEscapedLineFeeds: boolean): ILineBreaksComputer;
 }
 export interface ILineBreaksComputer {
+    /**
+     * Pass in `previousLineBreakData` if the only difference is in breaking columns!!!
+     */
     addRequest(lineText: string, injectedText: LineInjectedText[] | null, previousLineBreakData: ModelLineProjectionData | null): void;
     finalize(): (ModelLineProjectionData | null)[];
 }

package/vscode/src/vs/editor/common/services/editorWebWorker.d.ts

@@ -19,13 +19,32 @@ export interface IMirrorModel extends IMirrorTextModel {
     getValue(): string;
 }
 export interface IWorkerContext<H = {}> {
+    /**
+     * A proxy to the main thread host object.
+     */
     host: H;
+    /**
+     * Get all available mirror models in this worker.
+     */
     getMirrorModels(): IMirrorModel[];
 }
+/**
+ * Range of a word inside a model.
+ * @internal
+ */
 export interface IWordRange {
+    /**
+     * The index where the word starts.
+     */
     readonly start: number;
+    /**
+     * The index where the word ends.
+     */
     readonly end: number;
 }
+/**
+ * @internal
+ */
 export declare class EditorWorker implements IDisposable, IWorkerTextModelSyncChannelServer, IWebWorkerServerRequestHandler {
     private readonly _foreignModule;
     _requestHandlerBrand: any;

package/vscode/src/vs/editor/common/services/findSectionHeaders.d.ts

@@ -11,10 +11,29 @@ export interface FindSectionHeaderOptions {
     markSectionHeaderRegex: string;
 }
 export interface SectionHeader {
+    /**
+     * The location of the header text in the text model.
+     */
     range: IRange;
+    /**
+     * The section header text.
+     */
     text: string;
+    /**
+     * Whether the section header includes a separator line.
+     */
     hasSeparatorLine: boolean;
+    /**
+     * This section should be omitted before rendering if it's not in a comment.
+     */
     shouldBeInComments: boolean;
 }
+/**
+ * Find section headers in the model.
+ *
+ * @param model the text model to search in
+ * @param options options to search with
+ * @returns an array of section headers
+ */
 export declare function findSectionHeaders(model: ISectionHeaderFinderTarget, options: FindSectionHeaderOptions): SectionHeader[];
 export declare function collectMarkHeaders(model: ISectionHeaderFinderTarget, options: FindSectionHeaderOptions): SectionHeader[];

package/vscode/src/vs/editor/common/services/languagesAssociations.d.ts

@@ -7,9 +7,32 @@ export interface ILanguageAssociation {
     readonly filepattern?: string;
     readonly firstline?: RegExp;
 }
+/**
+ * Associate a language to the registry (platform).
+ * * **NOTE**: This association will lose over associations registered using `registerConfiguredLanguageAssociation`.
+ * * **NOTE**: Use `clearPlatformLanguageAssociations` to remove all associations registered using this function.
+ */
 export declare function registerPlatformLanguageAssociation(association: ILanguageAssociation, warnOnOverwrite?: boolean): void;
+/**
+ * Associate a language to the registry (configured).
+ * * **NOTE**: This association will win over associations registered using `registerPlatformLanguageAssociation`.
+ * * **NOTE**: Use `clearConfiguredLanguageAssociations` to remove all associations registered using this function.
+ */
 export declare function registerConfiguredLanguageAssociation(association: ILanguageAssociation): void;
+/**
+ * Clear language associations from the registry (platform).
+ */
 export declare function clearPlatformLanguageAssociations(): void;
+/**
+ * Clear language associations from the registry (configured).
+ */
 export declare function clearConfiguredLanguageAssociations(): void;
+/**
+ * Given a file, return the best matching mime types for it
+ * based on the registered language associations.
+ */
 export declare function getMimeTypes(resource: URI | null, firstLine?: string): string[];
+/**
+ * @see `getMimeTypes`
+ */
 export declare function getLanguageIds(resource: URI | null, firstLine?: string): string[];

package/vscode/src/vs/editor/common/services/modelService.d.ts

@@ -27,6 +27,9 @@ export declare class ModelService extends Disposable implements IModelService {
         oldLanguageId: string;
     }>;
     private _modelCreationOptionsByLanguageAndResource;
+    /**
+     * All the models known in the system.
+     */
     private readonly _models;
     private readonly _disposedModels;
     private _disposedModelsHeapSize;
@@ -44,6 +47,9 @@ export declare class ModelService extends Disposable implements IModelService {
     updateModel(model: ITextModel, value: string | ITextBufferFactory, reason?: TextModelEditSource): void;
     private static _commonPrefix;
     private static _commonSuffix;
+    /**
+     * Compute edits to bring `model` to the state of `textSource`.
+     */
     static _computeEdits(model: ITextModel, textBuffer: ITextBuffer): ISingleEditOperation[];
     createModel(value: string | ITextBufferFactory, languageSelection: ILanguageSelection | null, resource?: URI, isForSimpleWidget?: boolean): ITextModel;
     destroyModel(resource: URI): void;

package/vscode/src/vs/editor/common/services/resolverService.service.d.ts

@@ -4,7 +4,17 @@ import { IResolvedTextEditorModel, ITextModelContentProvider } from "@codingame/
 export declare const ITextModelService: import("../../../platform/instantiation/common/instantiation.js").ServiceIdentifier<ITextModelService>;
 export interface ITextModelService {
     readonly _serviceBrand: undefined;
+    /**
+    * Provided a resource URI, it will return a model reference
+    * which should be disposed once not needed anymore.
+    */
     createModelReference(resource: URI): Promise<IReference<IResolvedTextEditorModel>>;
+    /**
+    * Registers a specific `scheme` content provider.
+    */
     registerTextModelContentProvider(scheme: string, provider: ITextModelContentProvider): IDisposable;
+    /**
+    * Check if the given resource can be resolved to a text model.
+    */
     canHandleResource(resource: URI): boolean;
 }

package/vscode/src/vs/editor/common/services/textModelSync/textModelSync.impl.d.ts

@@ -10,6 +10,9 @@ import { MirrorTextModel as BaseMirrorModel, IModelChangedEvent } from "../../mo
 import { IMirrorModel } from "../editorWebWorker.js";
 import { IModelService } from "../model.service.js";
 import { IRawModelData, IWorkerTextModelSyncChannelServer } from "./textModelSync.protocol.js";
+/**
+ * Stop syncing a model to the worker if it was not needed for 1 min.
+ */
 export declare const STOP_SYNC_MODEL_DELTA_TIME_MS: number;
 export declare const WORKER_TEXT_MODEL_SYNC_CHANNEL = "workerTextModelSync";
 export declare class WorkerTextModelSyncClient extends Disposable {

package/vscode/src/vs/editor/common/services/textResourceConfiguration.d.ts

@@ -1,5 +1,16 @@
 import { URI } from "../../../base/common/uri.js";
 export interface ITextResourceConfigurationChangeEvent {
+    /**
+     * All affected keys. Also includes language overrides and keys changed under language overrides.
+     */
     readonly affectedKeys: ReadonlySet<string>;
+    /**
+     * Returns `true` if the given section has changed for the given resource.
+     *
+     * Example: To check if the configuration section has changed for a given resource use `e.affectsConfiguration(resource, section)`.
+     *
+     * @param resource Resource for which the configuration has to be checked.
+     * @param section Section of the configuration
+     */
     affectsConfiguration(resource: URI | undefined, section: string): boolean;
 }

package/vscode/src/vs/editor/common/services/textResourceConfiguration.service.d.ts

@@ -6,14 +6,49 @@ import { ITextResourceConfigurationChangeEvent } from "./textResourceConfigurati
 export declare const ITextResourceConfigurationService: import("../../../platform/instantiation/common/instantiation.js").ServiceIdentifier<ITextResourceConfigurationService>;
 export interface ITextResourceConfigurationService {
     readonly _serviceBrand: undefined;
+    /**
+    * Event that fires when the configuration changes.
+    */
     onDidChangeConfiguration: Event<ITextResourceConfigurationChangeEvent>;
+    /**
+    * Fetches the value of the section for the given resource by applying language overrides.
+    * Value can be of native type or an object keyed off the section name.
+    *
+    * @param resource - Resource for which the configuration has to be fetched.
+    * @param position - Position in the resource for which configuration has to be fetched.
+    * @param section - Section of the configuration.
+    *
+    */
     getValue<T>(resource: URI | undefined, section?: string): T;
     getValue<T>(resource: URI | undefined, position?: IPosition, section?: string): T;
+    /**
+    * Inspects the values of the section for the given resource by applying language overrides.
+    *
+    * @param resource - Resource for which the configuration has to be fetched.
+    * @param position - Position in the resource for which configuration has to be fetched.
+    * @param section - Section of the configuration.
+    *
+    */
     inspect<T>(resource: URI | undefined, position: IPosition | null, section: string): IConfigurationValue<Readonly<T>>;
+    /**
+    * Update the configuration value for the given resource at the effective location.
+    *
+    * - If configurationTarget is not specified, target will be derived by checking where the configuration is defined.
+    * - If the language overrides for the give resource contains the configuration, then it is updated.
+    *
+    * @param resource Resource for which the configuration has to be updated
+    * @param key Configuration key
+    * @param value Configuration value
+    * @param configurationTarget Optional target into which the configuration has to be updated.
+    * If not specified, target will be derived by checking where the configuration is defined.
+    */
     updateValue(resource: URI | undefined, key: string, value: unknown, configurationTarget?: ConfigurationTarget): Promise<void>;
 }
 export declare const ITextResourcePropertiesService: import("../../../platform/instantiation/common/instantiation.js").ServiceIdentifier<ITextResourcePropertiesService>;
 export interface ITextResourcePropertiesService {
     readonly _serviceBrand: undefined;
+    /**
+    * Returns the End of Line characters for the given resource
+    */
     getEOL(resource: URI, language?: string): string;
 }

package/vscode/src/vs/editor/common/services/treeSitter/treeSitterLibraryService.service.d.ts

@@ -6,6 +6,16 @@ export interface ITreeSitterLibraryService {
     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;
 }