SystemSh0cker/monaco-editor
1
0
Fork 0
mirror of https://github.com/microsoft/monaco-editor.git synced 2025-12-22 13:55:41 +01:00
Code Issues Projects Releases Packages Activity

Merge pull request #2862 from microsoft/alex/adopt-20211228

Browse source 
Adopt latest `monaco-editor-core`
This commit is contained in:
Alexandru Dima 2021-12-29 01:12:32 +01:00 • committed by GitHub
commit 25e85af033
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 184 additions and 117 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CHANGELOG.md
View file

@ -1,5 +1,11 @@
# Monaco Editor Changelog # Monaco Editor Changelog
## [0.32.0] (TBD)
### Breaking Changes
- The binary format for `IEncodedLineTokens` has changed to support strikethrough text.
## [0.31.1] (14.12.2021) ## [0.31.1] (14.12.2021)
- Fixes [a problem with missing colors](https://github.com/microsoft/monaco-editor/issues/2822) - Fixes [a problem with missing colors](https://github.com/microsoft/monaco-editor/issues/2822)

6
package-lock.json generated
View file

@ -1159,9 +1159,9 @@
} }
}, },
"monaco-editor-core": { "monaco-editor-core": {
"version": "0.31.1", "version": "0.32.0-dev.20211228",
"resolved": "https://registry.npmjs.org/monaco-editor-core/-/monaco-editor-core-0.31.1.tgz", "resolved": "https://registry.npmjs.org/monaco-editor-core/-/monaco-editor-core-0.32.0-dev.20211228.tgz",
"integrity": "sha512-JdwqSmTJP10bhb7qc94ehWX0C1D2R2rwCHfm+5Vd2Oh0dwjfeCAWHDelnTZ+BVbGPCb+7ZGHZvG+oYZHdmuemg==", "integrity": "sha512-7Cup6hu+EkpjW5Er6nSlSCQEJziJKiddd8vUJ+12Sgloo9KtnirzuoI69KeTYsFRVay8sUgeaZS0Bii0caTqSA==",
"dev": true "dev": true
}, },
"mri": { "mri": {

2
package.json
View file

@ -41,7 +41,7 @@
"jsdom": "^18.1.0", "jsdom": "^18.1.0",
"jsonc-parser": "^3.0.0", "jsonc-parser": "^3.0.0",
"mocha": "^9.1.3", "mocha": "^9.1.3",
"monaco-editor-core": "0.31.1", "monaco-editor-core": "0.32.0-dev.20211228",
"playwright": "^1.16.3", "playwright": "^1.16.3",
"prettier": "^2.4.1", "prettier": "^2.4.1",
"pretty-quick": "^3.1.1", "pretty-quick": "^3.1.1",

31
src/basic-languages/_.contribution.ts
View file

@ -3,7 +3,7 @@
* Licensed under the MIT License. See License.txt in the project root for license information. * Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/ *--------------------------------------------------------------------------------------------*/
import { languages } from '../fillers/monaco-editor-core'; import { languages, editor } from '../fillers/monaco-editor-core';
interface ILang extends languages.ILanguageExtensionPoint { interface ILang extends languages.ILanguageExtensionPoint {
loader: () => Promise<ILangImpl>; loader: () => Promise<ILangImpl>;
@ -40,10 +40,6 @@ class LazyLanguageLoader {
}); });
} }
public whenLoaded(): Promise<ILangImpl> {
return this._lazyLoadPromise;
}
public load(): Promise<ILangImpl> { public load(): Promise<ILangImpl> {
if (!this._loadingTriggered) { if (!this._loadingTriggered) {
this._loadingTriggered = true; this._loadingTriggered = true;
@ -56,8 +52,12 @@ class LazyLanguageLoader {
} }
} }
export function loadLanguage(languageId: string): Promise<ILangImpl> { export async function loadLanguage(languageId: string): Promise<void> {
return LazyLanguageLoader.getOrCreate(languageId).load(); await LazyLanguageLoader.getOrCreate(languageId).load();
// trigger tokenizer creation by instantiating a model
const model = editor.createModel('', languageId);
model.dispose();
} }
export function registerLanguage(def: ILang): void { export function registerLanguage(def: ILang): void {
@ -67,13 +67,14 @@ export function registerLanguage(def: ILang): void {
languages.register(def); languages.register(def);
const lazyLanguageLoader = LazyLanguageLoader.getOrCreate(languageId); const lazyLanguageLoader = LazyLanguageLoader.getOrCreate(languageId);
languages.setMonarchTokensProvider( languages.registerTokensProviderFactory(languageId, {
languageId, create: async (): Promise<languages.IMonarchLanguage> => {
lazyLanguageLoader.whenLoaded().then((mod) => mod.language) const mod = await lazyLanguageLoader.load();
); return mod.language;
languages.onLanguage(languageId, () => { }
lazyLanguageLoader.load().then((mod) => { });
languages.setLanguageConfiguration(languageId, mod.conf); languages.onLanguage(languageId, async () => {
}); const mod = await lazyLanguageLoader.load();
languages.setLanguageConfiguration(languageId, mod.conf);
}); });
} }

128
website/playground/monaco.d.ts.txt
View file

@ -97,25 +97,25 @@ declare namespace monaco {
export class Uri implements UriComponents { export class Uri implements UriComponents {
static isUri(thing: any): thing is Uri; static isUri(thing: any): thing is Uri;
/** /**
* scheme is the 'http' part of 'http://www.msft.com/some/path?query#fragment'. * scheme is the 'http' part of 'http://www.example.com/some/path?query#fragment'.
* The part before the first colon. * The part before the first colon.
*/ */
readonly scheme: string; readonly scheme: string;
/** /**
* authority is the 'www.msft.com' part of 'http://www.msft.com/some/path?query#fragment'. * authority is the 'www.example.com' part of 'http://www.example.com/some/path?query#fragment'.
* The part between the first double slashes and the next slash. * The part between the first double slashes and the next slash.
*/ */
readonly authority: string; readonly authority: string;
/** /**
* path is the '/some/path' part of 'http://www.msft.com/some/path?query#fragment'. * path is the '/some/path' part of 'http://www.example.com/some/path?query#fragment'.
*/ */
readonly path: string; readonly path: string;
/** /**
* query is the 'query' part of 'http://www.msft.com/some/path?query#fragment'. * query is the 'query' part of 'http://www.example.com/some/path?query#fragment'.
*/ */
readonly query: string; readonly query: string;
/** /**
* fragment is the 'fragment' part of 'http://www.msft.com/some/path?query#fragment'. * fragment is the 'fragment' part of 'http://www.example.com/some/path?query#fragment'.
*/ */
readonly fragment: string; readonly fragment: string;
/** /**
@ -151,7 +151,7 @@ declare namespace monaco {
fragment?: string | null; fragment?: string | null;
}): Uri; }): Uri;
/** /**
* Creates a new Uri from a string, e.g. `http://www.msft.com/some/path`, * Creates a new Uri from a string, e.g. `http://www.example.com/some/path`,
* `file:///usr/home`, or `scheme:with/path`. * `file:///usr/home`, or `scheme:with/path`.
* *
* @param value A string which represents an Uri (see `Uri#toString`). * @param value A string which represents an Uri (see `Uri#toString`).
@ -2041,32 +2041,32 @@ declare namespace monaco.editor {
* An event emitted when decorations of the model have changed. * An event emitted when decorations of the model have changed.
* @event * @event
*/ */
onDidChangeDecorations(listener: (e: IModelDecorationsChangedEvent) => void): IDisposable; readonly onDidChangeDecorations: IEvent<IModelDecorationsChangedEvent>;
/** /**
* An event emitted when the model options have changed. * An event emitted when the model options have changed.
* @event * @event
*/ */
onDidChangeOptions(listener: (e: IModelOptionsChangedEvent) => void): IDisposable; readonly onDidChangeOptions: IEvent<IModelOptionsChangedEvent>;
/** /**
* An event emitted when the language associated with the model has changed. * An event emitted when the language associated with the model has changed.
* @event * @event
*/ */
onDidChangeLanguage(listener: (e: IModelLanguageChangedEvent) => void): IDisposable; readonly onDidChangeLanguage: IEvent<IModelLanguageChangedEvent>;
/** /**
* An event emitted when the language configuration associated with the model has changed. * An event emitted when the language configuration associated with the model has changed.
* @event * @event
*/ */
onDidChangeLanguageConfiguration(listener: (e: IModelLanguageConfigurationChangedEvent) => void): IDisposable; readonly onDidChangeLanguageConfiguration: IEvent<IModelLanguageConfigurationChangedEvent>;
/** /**
* An event emitted when the model has been attached to the first editor or detached from the last editor. * An event emitted when the model has been attached to the first editor or detached from the last editor.
* @event * @event
*/ */
onDidChangeAttached(listener: () => void): IDisposable; readonly onDidChangeAttached: IEvent<void>;
/** /**
* An event emitted right before disposing the model. * An event emitted right before disposing the model.
* @event * @event
*/ */
onWillDispose(listener: () => void): IDisposable; readonly onWillDispose: IEvent<void>;
/** /**
* Destroy this model. * Destroy this model.
*/ */
@ -3888,10 +3888,12 @@ declare namespace monaco.editor {
invisibleCharacters?: boolean; invisibleCharacters?: boolean;
ambiguousCharacters?: boolean; ambiguousCharacters?: boolean;
includeComments?: boolean | InUntrustedWorkspace; includeComments?: boolean | InUntrustedWorkspace;
includeStrings?: boolean | InUntrustedWorkspace;
/** /**
* A map of allowed characters (true: allowed). * A map of allowed characters (true: allowed).
*/ */
allowedCharacters?: Record<string, true>; allowedCharacters?: Record<string, true>;
allowedLocales?: Record<string | '_os' | '_vscode', true>;
} }
export interface IInlineSuggestOptions { export interface IInlineSuggestOptions {
@ -4772,140 +4774,140 @@ declare namespace monaco.editor {
* An event emitted when the content of the current model has changed. * An event emitted when the content of the current model has changed.
* @event * @event
*/ */
onDidChangeModelContent: IEvent<IModelContentChangedEvent>; readonly onDidChangeModelContent: IEvent<IModelContentChangedEvent>;
/** /**
* An event emitted when the language of the current model has changed. * An event emitted when the language of the current model has changed.
* @event * @event
*/ */
onDidChangeModelLanguage: IEvent<IModelLanguageChangedEvent>; readonly onDidChangeModelLanguage: IEvent<IModelLanguageChangedEvent>;
/** /**
* An event emitted when the language configuration of the current model has changed. * An event emitted when the language configuration of the current model has changed.
* @event * @event
*/ */
onDidChangeModelLanguageConfiguration: IEvent<IModelLanguageConfigurationChangedEvent>; readonly onDidChangeModelLanguageConfiguration: IEvent<IModelLanguageConfigurationChangedEvent>;
/** /**
* An event emitted when the options of the current model has changed. * An event emitted when the options of the current model has changed.
* @event * @event
*/ */
onDidChangeModelOptions: IEvent<IModelOptionsChangedEvent>; readonly onDidChangeModelOptions: IEvent<IModelOptionsChangedEvent>;
/** /**
* An event emitted when the configuration of the editor has changed. (e.g. `editor.updateOptions()`) * An event emitted when the configuration of the editor has changed. (e.g. `editor.updateOptions()`)
* @event * @event
*/ */
onDidChangeConfiguration: IEvent<ConfigurationChangedEvent>; readonly onDidChangeConfiguration: IEvent<ConfigurationChangedEvent>;
/** /**
* An event emitted when the cursor position has changed. * An event emitted when the cursor position has changed.
* @event * @event
*/ */
onDidChangeCursorPosition: IEvent<ICursorPositionChangedEvent>; readonly onDidChangeCursorPosition: IEvent<ICursorPositionChangedEvent>;
/** /**
* An event emitted when the cursor selection has changed. * An event emitted when the cursor selection has changed.
* @event * @event
*/ */
onDidChangeCursorSelection: IEvent<ICursorSelectionChangedEvent>; readonly onDidChangeCursorSelection: IEvent<ICursorSelectionChangedEvent>;
/** /**
* An event emitted when the model of this editor has changed (e.g. `editor.setModel()`). * An event emitted when the model of this editor has changed (e.g. `editor.setModel()`).
* @event * @event
*/ */
onDidChangeModel: IEvent<IModelChangedEvent>; readonly onDidChangeModel: IEvent<IModelChangedEvent>;
/** /**
* An event emitted when the decorations of the current model have changed. * An event emitted when the decorations of the current model have changed.
* @event * @event
*/ */
onDidChangeModelDecorations: IEvent<IModelDecorationsChangedEvent>; readonly onDidChangeModelDecorations: IEvent<IModelDecorationsChangedEvent>;
/** /**
* An event emitted when the text inside this editor gained focus (i.e. cursor starts blinking). * An event emitted when the text inside this editor gained focus (i.e. cursor starts blinking).
* @event * @event
*/ */
onDidFocusEditorText(listener: () => void): IDisposable; readonly onDidFocusEditorText: IEvent<void>;
/** /**
* An event emitted when the text inside this editor lost focus (i.e. cursor stops blinking). * An event emitted when the text inside this editor lost focus (i.e. cursor stops blinking).
* @event * @event
*/ */
onDidBlurEditorText(listener: () => void): IDisposable; readonly onDidBlurEditorText: IEvent<void>;
/** /**
* An event emitted when the text inside this editor or an editor widget gained focus. * An event emitted when the text inside this editor or an editor widget gained focus.
* @event * @event
*/ */
onDidFocusEditorWidget(listener: () => void): IDisposable; readonly onDidFocusEditorWidget: IEvent<void>;
/** /**
* An event emitted when the text inside this editor or an editor widget lost focus. * An event emitted when the text inside this editor or an editor widget lost focus.
* @event * @event
*/ */
onDidBlurEditorWidget(listener: () => void): IDisposable; readonly onDidBlurEditorWidget: IEvent<void>;
/** /**
* An event emitted after composition has started. * An event emitted after composition has started.
*/ */
onDidCompositionStart(listener: () => void): IDisposable; readonly onDidCompositionStart: IEvent<void>;
/** /**
* An event emitted after composition has ended. * An event emitted after composition has ended.
*/ */
onDidCompositionEnd(listener: () => void): IDisposable; readonly onDidCompositionEnd: IEvent<void>;
/** /**
* An event emitted when editing failed because the editor is read-only. * An event emitted when editing failed because the editor is read-only.
* @event * @event
*/ */
onDidAttemptReadOnlyEdit(listener: () => void): IDisposable; readonly onDidAttemptReadOnlyEdit: IEvent<void>;
/** /**
* An event emitted when users paste text in the editor. * An event emitted when users paste text in the editor.
* @event * @event
*/ */
onDidPaste: IEvent<IPasteEvent>; readonly onDidPaste: IEvent<IPasteEvent>;
/** /**
* An event emitted on a "mouseup". * An event emitted on a "mouseup".
* @event * @event
*/ */
onMouseUp: IEvent<IEditorMouseEvent>; readonly onMouseUp: IEvent<IEditorMouseEvent>;
/** /**
* An event emitted on a "mousedown". * An event emitted on a "mousedown".
* @event * @event
*/ */
onMouseDown: IEvent<IEditorMouseEvent>; readonly onMouseDown: IEvent<IEditorMouseEvent>;
/** /**
* An event emitted on a "contextmenu". * An event emitted on a "contextmenu".
* @event * @event
*/ */
onContextMenu: IEvent<IEditorMouseEvent>; readonly onContextMenu: IEvent<IEditorMouseEvent>;
/** /**
* An event emitted on a "mousemove". * An event emitted on a "mousemove".
* @event * @event
*/ */
onMouseMove: IEvent<IEditorMouseEvent>; readonly onMouseMove: IEvent<IEditorMouseEvent>;
/** /**
* An event emitted on a "mouseleave". * An event emitted on a "mouseleave".
* @event * @event
*/ */
onMouseLeave: IEvent<IPartialEditorMouseEvent>; readonly onMouseLeave: IEvent<IPartialEditorMouseEvent>;
/** /**
* An event emitted on a "keyup". * An event emitted on a "keyup".
* @event * @event
*/ */
onKeyUp: IEvent<IKeyboardEvent>; readonly onKeyUp: IEvent<IKeyboardEvent>;
/** /**
* An event emitted on a "keydown". * An event emitted on a "keydown".
* @event * @event
*/ */
onKeyDown: IEvent<IKeyboardEvent>; readonly onKeyDown: IEvent<IKeyboardEvent>;
/** /**
* An event emitted when the layout of the editor has changed. * An event emitted when the layout of the editor has changed.
* @event * @event
*/ */
onDidLayoutChange: IEvent<EditorLayoutInfo>; readonly onDidLayoutChange: IEvent<EditorLayoutInfo>;
/** /**
* An event emitted when the content width or content height in the editor has changed. * An event emitted when the content width or content height in the editor has changed.
* @event * @event
*/ */
onDidContentSizeChange: IEvent<IContentSizeChangedEvent>; readonly onDidContentSizeChange: IEvent<IContentSizeChangedEvent>;
/** /**
* An event emitted when the scroll in the editor has changed. * An event emitted when the scroll in the editor has changed.
* @event * @event
*/ */
onDidScrollChange: IEvent<IScrollEvent>; readonly onDidScrollChange: IEvent<IScrollEvent>;
/** /**
* An event emitted when hidden areas change in the editor (e.g. due to folding). * An event emitted when hidden areas change in the editor (e.g. due to folding).
* @event * @event
*/ */
onDidChangeHiddenAreas: IEvent<void>; readonly onDidChangeHiddenAreas: IEvent<void>;
/** /**
* Saves current view state of the editor in a serializable object. * Saves current view state of the editor in a serializable object.
*/ */
@ -4923,7 +4925,7 @@ declare namespace monaco.editor {
* @id Unique identifier of the contribution. * @id Unique identifier of the contribution.
* @return The contribution or null if contribution not found. * @return The contribution or null if contribution not found.
*/ */
getContribution<T extends IEditorContribution>(id: string): T; getContribution<T extends IEditorContribution>(id: string): T | null;
/** /**
* Type the getModel() of IEditor. * Type the getModel() of IEditor.
*/ */
@ -5154,7 +5156,7 @@ declare namespace monaco.editor {
* An event emitted when the diff information computed by this diff editor has been updated. * An event emitted when the diff information computed by this diff editor has been updated.
* @event * @event
*/ */
onDidUpdateDiff(listener: () => void): IDisposable; readonly onDidUpdateDiff: IEvent<void>;
/** /**
* Saves current view state of the editor in a serializable object. * Saves current view state of the editor in a serializable object.
*/ */
@ -5297,11 +5299,11 @@ declare namespace monaco.languages {
* 3322 2222 2222 1111 1111 1100 0000 0000 * 3322 2222 2222 1111 1111 1100 0000 0000
* 1098 7654 3210 9876 5432 1098 7654 3210 * 1098 7654 3210 9876 5432 1098 7654 3210
* - ------------------------------------------- * - -------------------------------------------
* bbbb bbbb bfff ffff ffFF FTTT LLLL LLLL * bbbb bbbb bfff ffff ffFF FFTT LLLL LLLL
* - ------------------------------------------- * - -------------------------------------------
* - L = EncodedLanguageId (8 bits): Use `getEncodedLanguageId` to get the encoded ID of a language. * - L = EncodedLanguageId (8 bits): Use `getEncodedLanguageId` to get the encoded ID of a language.
* - T = StandardTokenType (3 bits): Other = 0, Comment = 1, String = 2, RegEx = 4. * - T = StandardTokenType (2 bits): Other = 0, Comment = 1, String = 2, RegEx = 3.
* - F = FontStyle (3 bits): None = 0, Italic = 1, Bold = 2, Underline = 4. * - F = FontStyle (4 bits): None = 0, Italic = 1, Bold = 2, Underline = 4, Strikethrough = 8.
* - f = foreground ColorId (9 bits) * - f = foreground ColorId (9 bits)
* - b = background ColorId (9 bits) * - b = background ColorId (9 bits)
* - The color value for each colorId is defined in IStandaloneThemeData.customTokenColors: * - The color value for each colorId is defined in IStandaloneThemeData.customTokenColors:
@ -5316,6 +5318,13 @@ declare namespace monaco.languages {
endState: IState; endState: IState;
} }
/**
* A factory for token providers.
*/
export interface TokensProviderFactory {
create(): ProviderResult<TokensProvider | EncodedTokensProvider | IMonarchLanguage>;
}
/** /**
* A "manual" provider of tokens. * A "manual" provider of tokens.
*/ */
@ -5355,12 +5364,25 @@ declare namespace monaco.languages {
export function setColorMap(colorMap: string[] | null): void; export function setColorMap(colorMap: string[] | null): void;
/** /**
* Set the tokens provider for a language (manual implementation). * Register a tokens provider factory for a language. This tokenizer will be exclusive with a tokenizer
* set using `setTokensProvider` or one created using `setMonarchTokensProvider`, but will work together
* with a tokens provider set using `registerDocumentSemanticTokensProvider` or `registerDocumentRangeSemanticTokensProvider`.
*/
export function registerTokensProviderFactory(languageId: string, factory: TokensProviderFactory): IDisposable;
/**
* Set the tokens provider for a language (manual implementation). This tokenizer will be exclusive
* with a tokenizer created using `setMonarchTokensProvider`, or with `registerTokensProviderFactory`,
* but will work together with a tokens provider set using `registerDocumentSemanticTokensProvider`
* or `registerDocumentRangeSemanticTokensProvider`.
*/ */
export function setTokensProvider(languageId: string, provider: TokensProvider | EncodedTokensProvider | Thenable<TokensProvider | EncodedTokensProvider>): IDisposable; export function setTokensProvider(languageId: string, provider: TokensProvider | EncodedTokensProvider | Thenable<TokensProvider | EncodedTokensProvider>): IDisposable;
/** /**
* Set the tokens provider for a language (monarch implementation). * Set the tokens provider for a language (monarch implementation). This tokenizer will be exclusive
* with a tokenizer set using `setTokensProvider`, or with `registerTokensProviderFactory`, but will
* work together with a tokens provider set using `registerDocumentSemanticTokensProvider` or
* `registerDocumentRangeSemanticTokensProvider`.
*/ */
export function setMonarchTokensProvider(languageId: string, languageDef: IMonarchLanguage | Thenable<IMonarchLanguage>): IDisposable; export function setMonarchTokensProvider(languageId: string, languageDef: IMonarchLanguage | Thenable<IMonarchLanguage>): IDisposable;
@ -5470,12 +5492,20 @@ declare namespace monaco.languages {
export function registerSelectionRangeProvider(languageId: string, provider: SelectionRangeProvider): IDisposable; export function registerSelectionRangeProvider(languageId: string, provider: SelectionRangeProvider): IDisposable;
/** /**
* Register a document semantic tokens provider * Register a document semantic tokens provider. A semantic tokens provider will complement and enhance a
* simple top-down tokenizer. Simple top-down tokenizers can be set either via `setMonarchTokensProvider`
* or `setTokensProvider`.
*
* For the best user experience, register both a semantic tokens provider and a top-down tokenizer.
*/ */
export function registerDocumentSemanticTokensProvider(languageId: string, provider: DocumentSemanticTokensProvider): IDisposable; export function registerDocumentSemanticTokensProvider(languageId: string, provider: DocumentSemanticTokensProvider): IDisposable;
/** /**
* Register a document range semantic tokens provider * Register a document range semantic tokens provider. A semantic tokens provider will complement and enhance a
* simple top-down tokenizer. Simple top-down tokenizers can be set either via `setMonarchTokensProvider`
* or `setTokensProvider`.
*
* For the best user experience, register both a semantic tokens provider and a top-down tokenizer.
*/ */
export function registerDocumentRangeSemanticTokensProvider(languageId: string, provider: DocumentRangeSemanticTokensProvider): IDisposable; export function registerDocumentRangeSemanticTokensProvider(languageId: string, provider: DocumentRangeSemanticTokensProvider): IDisposable;

128
website/typedoc/monaco.d.ts vendored
View file

@ -97,25 +97,25 @@ declare namespace monaco {
export class Uri implements UriComponents { export class Uri implements UriComponents {
static isUri(thing: any): thing is Uri; static isUri(thing: any): thing is Uri;
/** /**
* scheme is the 'http' part of 'http://www.msft.com/some/path?query#fragment'. * scheme is the 'http' part of 'http://www.example.com/some/path?query#fragment'.
* The part before the first colon. * The part before the first colon.
*/ */
readonly scheme: string; readonly scheme: string;
/** /**
* authority is the 'www.msft.com' part of 'http://www.msft.com/some/path?query#fragment'. * authority is the 'www.example.com' part of 'http://www.example.com/some/path?query#fragment'.
* The part between the first double slashes and the next slash. * The part between the first double slashes and the next slash.
*/ */
readonly authority: string; readonly authority: string;
/** /**
* path is the '/some/path' part of 'http://www.msft.com/some/path?query#fragment'. * path is the '/some/path' part of 'http://www.example.com/some/path?query#fragment'.
*/ */
readonly path: string; readonly path: string;
/** /**
* query is the 'query' part of 'http://www.msft.com/some/path?query#fragment'. * query is the 'query' part of 'http://www.example.com/some/path?query#fragment'.
*/ */
readonly query: string; readonly query: string;
/** /**
* fragment is the 'fragment' part of 'http://www.msft.com/some/path?query#fragment'. * fragment is the 'fragment' part of 'http://www.example.com/some/path?query#fragment'.
*/ */
readonly fragment: string; readonly fragment: string;
/** /**
@ -151,7 +151,7 @@ declare namespace monaco {
fragment?: string | null; fragment?: string | null;
}): Uri; }): Uri;
/** /**
* Creates a new Uri from a string, e.g. `http://www.msft.com/some/path`, * Creates a new Uri from a string, e.g. `http://www.example.com/some/path`,
* `file:///usr/home`, or `scheme:with/path`. * `file:///usr/home`, or `scheme:with/path`.
* *
* @param value A string which represents an Uri (see `Uri#toString`). * @param value A string which represents an Uri (see `Uri#toString`).
@ -2041,32 +2041,32 @@ declare namespace monaco.editor {
* An event emitted when decorations of the model have changed. * An event emitted when decorations of the model have changed.
* @event * @event
*/ */
onDidChangeDecorations(listener: (e: IModelDecorationsChangedEvent) => void): IDisposable; readonly onDidChangeDecorations: IEvent<IModelDecorationsChangedEvent>;
/** /**
* An event emitted when the model options have changed. * An event emitted when the model options have changed.
* @event * @event
*/ */
onDidChangeOptions(listener: (e: IModelOptionsChangedEvent) => void): IDisposable; readonly onDidChangeOptions: IEvent<IModelOptionsChangedEvent>;
/** /**
* An event emitted when the language associated with the model has changed. * An event emitted when the language associated with the model has changed.
* @event * @event
*/ */
onDidChangeLanguage(listener: (e: IModelLanguageChangedEvent) => void): IDisposable; readonly onDidChangeLanguage: IEvent<IModelLanguageChangedEvent>;
/** /**
* An event emitted when the language configuration associated with the model has changed. * An event emitted when the language configuration associated with the model has changed.
* @event * @event
*/ */
onDidChangeLanguageConfiguration(listener: (e: IModelLanguageConfigurationChangedEvent) => void): IDisposable; readonly onDidChangeLanguageConfiguration: IEvent<IModelLanguageConfigurationChangedEvent>;
/** /**
* An event emitted when the model has been attached to the first editor or detached from the last editor. * An event emitted when the model has been attached to the first editor or detached from the last editor.
* @event * @event
*/ */
onDidChangeAttached(listener: () => void): IDisposable; readonly onDidChangeAttached: IEvent<void>;
/** /**
* An event emitted right before disposing the model. * An event emitted right before disposing the model.
* @event * @event
*/ */
onWillDispose(listener: () => void): IDisposable; readonly onWillDispose: IEvent<void>;
/** /**
* Destroy this model. * Destroy this model.
*/ */
@ -3888,10 +3888,12 @@ declare namespace monaco.editor {
invisibleCharacters?: boolean; invisibleCharacters?: boolean;
ambiguousCharacters?: boolean; ambiguousCharacters?: boolean;
includeComments?: boolean | InUntrustedWorkspace; includeComments?: boolean | InUntrustedWorkspace;
includeStrings?: boolean | InUntrustedWorkspace;
/** /**
* A map of allowed characters (true: allowed). * A map of allowed characters (true: allowed).
*/ */
allowedCharacters?: Record<string, true>; allowedCharacters?: Record<string, true>;
allowedLocales?: Record<string | '_os' | '_vscode', true>;
} }
export interface IInlineSuggestOptions { export interface IInlineSuggestOptions {
@ -4772,140 +4774,140 @@ declare namespace monaco.editor {
* An event emitted when the content of the current model has changed. * An event emitted when the content of the current model has changed.
* @event * @event
*/ */
onDidChangeModelContent: IEvent<IModelContentChangedEvent>; readonly onDidChangeModelContent: IEvent<IModelContentChangedEvent>;
/** /**
* An event emitted when the language of the current model has changed. * An event emitted when the language of the current model has changed.
* @event * @event
*/ */
onDidChangeModelLanguage: IEvent<IModelLanguageChangedEvent>; readonly onDidChangeModelLanguage: IEvent<IModelLanguageChangedEvent>;
/** /**
* An event emitted when the language configuration of the current model has changed. * An event emitted when the language configuration of the current model has changed.
* @event * @event
*/ */
onDidChangeModelLanguageConfiguration: IEvent<IModelLanguageConfigurationChangedEvent>; readonly onDidChangeModelLanguageConfiguration: IEvent<IModelLanguageConfigurationChangedEvent>;
/** /**
* An event emitted when the options of the current model has changed. * An event emitted when the options of the current model has changed.
* @event * @event
*/ */
onDidChangeModelOptions: IEvent<IModelOptionsChangedEvent>; readonly onDidChangeModelOptions: IEvent<IModelOptionsChangedEvent>;
/** /**
* An event emitted when the configuration of the editor has changed. (e.g. `editor.updateOptions()`) * An event emitted when the configuration of the editor has changed. (e.g. `editor.updateOptions()`)
* @event * @event
*/ */
onDidChangeConfiguration: IEvent<ConfigurationChangedEvent>; readonly onDidChangeConfiguration: IEvent<ConfigurationChangedEvent>;
/** /**
* An event emitted when the cursor position has changed. * An event emitted when the cursor position has changed.
* @event * @event
*/ */
onDidChangeCursorPosition: IEvent<ICursorPositionChangedEvent>; readonly onDidChangeCursorPosition: IEvent<ICursorPositionChangedEvent>;
/** /**
* An event emitted when the cursor selection has changed. * An event emitted when the cursor selection has changed.
* @event * @event
*/ */
onDidChangeCursorSelection: IEvent<ICursorSelectionChangedEvent>; readonly onDidChangeCursorSelection: IEvent<ICursorSelectionChangedEvent>;
/** /**
* An event emitted when the model of this editor has changed (e.g. `editor.setModel()`). * An event emitted when the model of this editor has changed (e.g. `editor.setModel()`).
* @event * @event
*/ */
onDidChangeModel: IEvent<IModelChangedEvent>; readonly onDidChangeModel: IEvent<IModelChangedEvent>;
/** /**
* An event emitted when the decorations of the current model have changed. * An event emitted when the decorations of the current model have changed.
* @event * @event
*/ */
onDidChangeModelDecorations: IEvent<IModelDecorationsChangedEvent>; readonly onDidChangeModelDecorations: IEvent<IModelDecorationsChangedEvent>;
/** /**
* An event emitted when the text inside this editor gained focus (i.e. cursor starts blinking). * An event emitted when the text inside this editor gained focus (i.e. cursor starts blinking).
* @event * @event
*/ */
onDidFocusEditorText(listener: () => void): IDisposable; readonly onDidFocusEditorText: IEvent<void>;
/** /**
* An event emitted when the text inside this editor lost focus (i.e. cursor stops blinking). * An event emitted when the text inside this editor lost focus (i.e. cursor stops blinking).
* @event * @event
*/ */
onDidBlurEditorText(listener: () => void): IDisposable; readonly onDidBlurEditorText: IEvent<void>;
/** /**
* An event emitted when the text inside this editor or an editor widget gained focus. * An event emitted when the text inside this editor or an editor widget gained focus.
* @event * @event
*/ */
onDidFocusEditorWidget(listener: () => void): IDisposable; readonly onDidFocusEditorWidget: IEvent<void>;
/** /**
* An event emitted when the text inside this editor or an editor widget lost focus. * An event emitted when the text inside this editor or an editor widget lost focus.
* @event * @event
*/ */
onDidBlurEditorWidget(listener: () => void): IDisposable; readonly onDidBlurEditorWidget: IEvent<void>;
/** /**
* An event emitted after composition has started. * An event emitted after composition has started.
*/ */
onDidCompositionStart(listener: () => void): IDisposable; readonly onDidCompositionStart: IEvent<void>;
/** /**
* An event emitted after composition has ended. * An event emitted after composition has ended.
*/ */
onDidCompositionEnd(listener: () => void): IDisposable; readonly onDidCompositionEnd: IEvent<void>;
/** /**
* An event emitted when editing failed because the editor is read-only. * An event emitted when editing failed because the editor is read-only.
* @event * @event
*/ */
onDidAttemptReadOnlyEdit(listener: () => void): IDisposable; readonly onDidAttemptReadOnlyEdit: IEvent<void>;
/** /**
* An event emitted when users paste text in the editor. * An event emitted when users paste text in the editor.
* @event * @event
*/ */
onDidPaste: IEvent<IPasteEvent>; readonly onDidPaste: IEvent<IPasteEvent>;
/** /**
* An event emitted on a "mouseup". * An event emitted on a "mouseup".
* @event * @event
*/ */
onMouseUp: IEvent<IEditorMouseEvent>; readonly onMouseUp: IEvent<IEditorMouseEvent>;
/** /**
* An event emitted on a "mousedown". * An event emitted on a "mousedown".
* @event * @event
*/ */
onMouseDown: IEvent<IEditorMouseEvent>; readonly onMouseDown: IEvent<IEditorMouseEvent>;
/** /**
* An event emitted on a "contextmenu". * An event emitted on a "contextmenu".
* @event * @event
*/ */
onContextMenu: IEvent<IEditorMouseEvent>; readonly onContextMenu: IEvent<IEditorMouseEvent>;
/** /**
* An event emitted on a "mousemove". * An event emitted on a "mousemove".
* @event * @event
*/ */
onMouseMove: IEvent<IEditorMouseEvent>; readonly onMouseMove: IEvent<IEditorMouseEvent>;
/** /**
* An event emitted on a "mouseleave". * An event emitted on a "mouseleave".
* @event * @event
*/ */
onMouseLeave: IEvent<IPartialEditorMouseEvent>; readonly onMouseLeave: IEvent<IPartialEditorMouseEvent>;
/** /**
* An event emitted on a "keyup". * An event emitted on a "keyup".
* @event * @event
*/ */
onKeyUp: IEvent<IKeyboardEvent>; readonly onKeyUp: IEvent<IKeyboardEvent>;
/** /**
* An event emitted on a "keydown". * An event emitted on a "keydown".
* @event * @event
*/ */
onKeyDown: IEvent<IKeyboardEvent>; readonly onKeyDown: IEvent<IKeyboardEvent>;
/** /**
* An event emitted when the layout of the editor has changed. * An event emitted when the layout of the editor has changed.
* @event * @event
*/ */
onDidLayoutChange: IEvent<EditorLayoutInfo>; readonly onDidLayoutChange: IEvent<EditorLayoutInfo>;
/** /**
* An event emitted when the content width or content height in the editor has changed. * An event emitted when the content width or content height in the editor has changed.
* @event * @event
*/ */
onDidContentSizeChange: IEvent<IContentSizeChangedEvent>; readonly onDidContentSizeChange: IEvent<IContentSizeChangedEvent>;
/** /**
* An event emitted when the scroll in the editor has changed. * An event emitted when the scroll in the editor has changed.
* @event * @event
*/ */
onDidScrollChange: IEvent<IScrollEvent>; readonly onDidScrollChange: IEvent<IScrollEvent>;
/** /**
* An event emitted when hidden areas change in the editor (e.g. due to folding). * An event emitted when hidden areas change in the editor (e.g. due to folding).
* @event * @event
*/ */
onDidChangeHiddenAreas: IEvent<void>; readonly onDidChangeHiddenAreas: IEvent<void>;
/** /**
* Saves current view state of the editor in a serializable object. * Saves current view state of the editor in a serializable object.
*/ */
@ -4923,7 +4925,7 @@ declare namespace monaco.editor {
* @id Unique identifier of the contribution. * @id Unique identifier of the contribution.
* @return The contribution or null if contribution not found. * @return The contribution or null if contribution not found.
*/ */
getContribution<T extends IEditorContribution>(id: string): T; getContribution<T extends IEditorContribution>(id: string): T | null;
/** /**
* Type the getModel() of IEditor. * Type the getModel() of IEditor.
*/ */
@ -5154,7 +5156,7 @@ declare namespace monaco.editor {
* An event emitted when the diff information computed by this diff editor has been updated. * An event emitted when the diff information computed by this diff editor has been updated.
* @event * @event
*/ */
onDidUpdateDiff(listener: () => void): IDisposable; readonly onDidUpdateDiff: IEvent<void>;
/** /**
* Saves current view state of the editor in a serializable object. * Saves current view state of the editor in a serializable object.
*/ */
@ -5297,11 +5299,11 @@ declare namespace monaco.languages {
* 3322 2222 2222 1111 1111 1100 0000 0000 * 3322 2222 2222 1111 1111 1100 0000 0000
* 1098 7654 3210 9876 5432 1098 7654 3210 * 1098 7654 3210 9876 5432 1098 7654 3210
* - ------------------------------------------- * - -------------------------------------------
* bbbb bbbb bfff ffff ffFF FTTT LLLL LLLL * bbbb bbbb bfff ffff ffFF FFTT LLLL LLLL
* - ------------------------------------------- * - -------------------------------------------
* - L = EncodedLanguageId (8 bits): Use `getEncodedLanguageId` to get the encoded ID of a language. * - L = EncodedLanguageId (8 bits): Use `getEncodedLanguageId` to get the encoded ID of a language.
* - T = StandardTokenType (3 bits): Other = 0, Comment = 1, String = 2, RegEx = 4. * - T = StandardTokenType (2 bits): Other = 0, Comment = 1, String = 2, RegEx = 3.
* - F = FontStyle (3 bits): None = 0, Italic = 1, Bold = 2, Underline = 4. * - F = FontStyle (4 bits): None = 0, Italic = 1, Bold = 2, Underline = 4, Strikethrough = 8.
* - f = foreground ColorId (9 bits) * - f = foreground ColorId (9 bits)
* - b = background ColorId (9 bits) * - b = background ColorId (9 bits)
* - The color value for each colorId is defined in IStandaloneThemeData.customTokenColors: * - The color value for each colorId is defined in IStandaloneThemeData.customTokenColors:
@ -5316,6 +5318,13 @@ declare namespace monaco.languages {
endState: IState; endState: IState;
} }
/**
* A factory for token providers.
*/
export interface TokensProviderFactory {
create(): ProviderResult<TokensProvider | EncodedTokensProvider | IMonarchLanguage>;
}
/** /**
* A "manual" provider of tokens. * A "manual" provider of tokens.
*/ */
@ -5355,12 +5364,25 @@ declare namespace monaco.languages {
export function setColorMap(colorMap: string[] | null): void; export function setColorMap(colorMap: string[] | null): void;
/** /**
* Set the tokens provider for a language (manual implementation). * Register a tokens provider factory for a language. This tokenizer will be exclusive with a tokenizer
* set using `setTokensProvider` or one created using `setMonarchTokensProvider`, but will work together
* with a tokens provider set using `registerDocumentSemanticTokensProvider` or `registerDocumentRangeSemanticTokensProvider`.
*/
export function registerTokensProviderFactory(languageId: string, factory: TokensProviderFactory): IDisposable;
/**
* Set the tokens provider for a language (manual implementation). This tokenizer will be exclusive
* with a tokenizer created using `setMonarchTokensProvider`, or with `registerTokensProviderFactory`,
* but will work together with a tokens provider set using `registerDocumentSemanticTokensProvider`
* or `registerDocumentRangeSemanticTokensProvider`.
*/ */
export function setTokensProvider(languageId: string, provider: TokensProvider | EncodedTokensProvider | Thenable<TokensProvider | EncodedTokensProvider>): IDisposable; export function setTokensProvider(languageId: string, provider: TokensProvider | EncodedTokensProvider | Thenable<TokensProvider | EncodedTokensProvider>): IDisposable;
/** /**
* Set the tokens provider for a language (monarch implementation). * Set the tokens provider for a language (monarch implementation). This tokenizer will be exclusive
* with a tokenizer set using `setTokensProvider`, or with `registerTokensProviderFactory`, but will
* work together with a tokens provider set using `registerDocumentSemanticTokensProvider` or
* `registerDocumentRangeSemanticTokensProvider`.
*/ */
export function setMonarchTokensProvider(languageId: string, languageDef: IMonarchLanguage | Thenable<IMonarchLanguage>): IDisposable; export function setMonarchTokensProvider(languageId: string, languageDef: IMonarchLanguage | Thenable<IMonarchLanguage>): IDisposable;
@ -5470,12 +5492,20 @@ declare namespace monaco.languages {
export function registerSelectionRangeProvider(languageId: string, provider: SelectionRangeProvider): IDisposable; export function registerSelectionRangeProvider(languageId: string, provider: SelectionRangeProvider): IDisposable;
/** /**
* Register a document semantic tokens provider * Register a document semantic tokens provider. A semantic tokens provider will complement and enhance a
* simple top-down tokenizer. Simple top-down tokenizers can be set either via `setMonarchTokensProvider`
* or `setTokensProvider`.
*
* For the best user experience, register both a semantic tokens provider and a top-down tokenizer.
*/ */
export function registerDocumentSemanticTokensProvider(languageId: string, provider: DocumentSemanticTokensProvider): IDisposable; export function registerDocumentSemanticTokensProvider(languageId: string, provider: DocumentSemanticTokensProvider): IDisposable;
/** /**
* Register a document range semantic tokens provider * Register a document range semantic tokens provider. A semantic tokens provider will complement and enhance a
* simple top-down tokenizer. Simple top-down tokenizers can be set either via `setMonarchTokensProvider`
* or `setTokensProvider`.
*
* For the best user experience, register both a semantic tokens provider and a top-down tokenizer.
*/ */
export function registerDocumentRangeSemanticTokensProvider(languageId: string, provider: DocumentRangeSemanticTokensProvider): IDisposable; export function registerDocumentRangeSemanticTokensProvider(languageId: string, provider: DocumentRangeSemanticTokensProvider): IDisposable;