Namespace languages
Type Aliases§
§type Character
type Character
§type Definition = Location | Location[] | LocationLink[]
type Definition = Location | Location[] | LocationLink[]
§type IMonarch
| IShortMonarchLanguageAction
| IExpandedMonarchLanguageAction
| (
| IShortMonarchLanguageAction
| IExpandedMonarchLanguageAction
)[]
type IMonarch
| IShortMonarchLanguageAction
| IExpandedMonarchLanguageAction
| (
| IShortMonarchLanguageAction
| IExpandedMonarchLanguageAction
)[]
§type IMonarch
| IShortMonarchLanguageRule1
| IShortMonarchLanguageRule2
| IExpandedMonarchLanguageRule
type IMonarch
| IShortMonarchLanguageRule1
| IShortMonarchLanguageRule2
| IExpandedMonarchLanguageRule
§type Inline
type Inline
§type Inline
| { kind: Accepted }
| { kind: Rejected }
| {
kind: Ignored;
supersededBy?: TInlineCompletion;
userTypingDisagreed: boolean;
}
type Inline
| { kind: Accepted }
| { kind: Rejected }
| {
kind: Ignored;
supersededBy?: TInlineCompletion;
userTypingDisagreed: boolean;
}
§type Inline
type Inline
§type Inline
type Inline
§type IShort
type IShort
An action is either an array of actions... ... or a case statement with guards... ... or a basic action with a token value.
§type IShort
type IShort
A rule is either a regular expression and an action shorthands: [reg,act] == { regex: reg, action: act} and : [reg,act,nxt] == { regex: reg, action: act{ next: nxt }}
§type IShort
type IShort
§type Language
| string
| LanguageFilter
| ReadonlyArray<string | LanguageFilter>
type Language
| string
| LanguageFilter
| ReadonlyArray<string | LanguageFilter>
§type Lifetime
type Lifetime
§type Provider
type Provider
A provider result represents the values a provider, like the HoverProvider,
may return. For once this is the actual result type T, like Hover, or a thenable that resolves
to that type T. In addition, null and undefined can be returned - either directly or from a
thenable.
Variables§
Functions§
§getEncodedLanguageId(languageId: string): number
getEncodedLanguageId(languageId: string): number
§getLanguages(): ILanguageExtensionPoint[]
getLanguages(): ILanguageExtensionPoint[]
Get the information of all the registered languages.
§register(language: ILanguageExtensionPoint): void
register(language: ILanguageExtensionPoint): void
Register information about a new language.
§registerCodeActionProvider(
languageSelector: LanguageSelector,
provider: CodeActionProvider,
metadata?: CodeActionProviderMetadata,
): IDisposable
registerCodeActionProvider(
languageSelector: LanguageSelector,
provider: CodeActionProvider,
metadata?: CodeActionProviderMetadata,
): IDisposable
Register a code action provider (used by e.g. quick fix).
§registerCodeLensProvider(
languageSelector: LanguageSelector,
provider: CodeLensProvider,
): IDisposable
registerCodeLensProvider(
languageSelector: LanguageSelector,
provider: CodeLensProvider,
): IDisposable
Register a code lens provider (used by e.g. inline code lenses).
§registerColorProvider(
languageSelector: LanguageSelector,
provider: DocumentColorProvider,
): IDisposable
registerColorProvider(
languageSelector: LanguageSelector,
provider: DocumentColorProvider,
): IDisposable
Register a document color provider (used by Color Picker, Color Decorator).
§registerCompletionItemProvider(
languageSelector: LanguageSelector,
provider: CompletionItemProvider,
): IDisposable
registerCompletionItemProvider(
languageSelector: LanguageSelector,
provider: CompletionItemProvider,
): IDisposable
Register a completion item provider (use by e.g. suggestions).
§registerDeclarationProvider(
languageSelector: LanguageSelector,
provider: DeclarationProvider,
): IDisposable
registerDeclarationProvider(
languageSelector: LanguageSelector,
provider: DeclarationProvider,
): IDisposable
Register a declaration provider
§registerDefinitionProvider(
languageSelector: LanguageSelector,
provider: DefinitionProvider,
): IDisposable
registerDefinitionProvider(
languageSelector: LanguageSelector,
provider: DefinitionProvider,
): IDisposable
Register a definition provider (used by e.g. go to definition).
§registerDocumentFormattingEditProvider(
languageSelector: LanguageSelector,
provider: DocumentFormattingEditProvider,
): IDisposable
registerDocumentFormattingEditProvider(
languageSelector: LanguageSelector,
provider: DocumentFormattingEditProvider,
): IDisposable
Register a formatter that can handle only entire models.
§registerDocumentHighlightProvider(
languageSelector: LanguageSelector,
provider: DocumentHighlightProvider,
): IDisposable
registerDocumentHighlightProvider(
languageSelector: LanguageSelector,
provider: DocumentHighlightProvider,
): IDisposable
Register a document highlight provider (used by e.g. highlight occurrences).
§registerDocumentRangeFormattingEditProvider(
languageSelector: LanguageSelector,
provider: DocumentRangeFormattingEditProvider,
): IDisposable
registerDocumentRangeFormattingEditProvider(
languageSelector: LanguageSelector,
provider: DocumentRangeFormattingEditProvider,
): IDisposable
Register a formatter that can handle a range inside a model.
§registerDocumentRangeSemanticTokensProvider(
languageSelector: LanguageSelector,
provider: DocumentRangeSemanticTokensProvider,
): IDisposable
registerDocumentRangeSemanticTokensProvider(
languageSelector: LanguageSelector,
provider: DocumentRangeSemanticTokensProvider,
): IDisposable
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.
§registerDocumentSemanticTokensProvider(
languageSelector: LanguageSelector,
provider: DocumentSemanticTokensProvider,
): IDisposable
registerDocumentSemanticTokensProvider(
languageSelector: LanguageSelector,
provider: DocumentSemanticTokensProvider,
): IDisposable
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.
§registerDocumentSymbolProvider(
languageSelector: LanguageSelector,
provider: DocumentSymbolProvider,
): IDisposable
registerDocumentSymbolProvider(
languageSelector: LanguageSelector,
provider: DocumentSymbolProvider,
): IDisposable
Register a document symbol provider (used by e.g. outline).
§registerFoldingRangeProvider(
languageSelector: LanguageSelector,
provider: FoldingRangeProvider,
): IDisposable
registerFoldingRangeProvider(
languageSelector: LanguageSelector,
provider: FoldingRangeProvider,
): IDisposable
Register a folding range provider
§registerHoverProvider(
languageSelector: LanguageSelector,
provider: HoverProvider,
): IDisposable
registerHoverProvider(
languageSelector: LanguageSelector,
provider: HoverProvider,
): IDisposable
Register a hover provider (used by e.g. editor hover).
§registerImplementationProvider(
languageSelector: LanguageSelector,
provider: ImplementationProvider,
): IDisposable
registerImplementationProvider(
languageSelector: LanguageSelector,
provider: ImplementationProvider,
): IDisposable
Register a implementation provider (used by e.g. go to implementation).
§registerInlayHintsProvider(
languageSelector: LanguageSelector,
provider: InlayHintsProvider,
): IDisposable
registerInlayHintsProvider(
languageSelector: LanguageSelector,
provider: InlayHintsProvider,
): IDisposable
Register an inlay hints provider.
§registerInlineCompletionsProvider(
languageSelector: LanguageSelector,
provider: InlineCompletionsProvider,
): IDisposable
registerInlineCompletionsProvider(
languageSelector: LanguageSelector,
provider: InlineCompletionsProvider,
): IDisposable
Register an inline completions provider.
§registerLinkedEditingRangeProvider(
languageSelector: LanguageSelector,
provider: LinkedEditingRangeProvider,
): IDisposable
registerLinkedEditingRangeProvider(
languageSelector: LanguageSelector,
provider: LinkedEditingRangeProvider,
): IDisposable
Register an linked editing range provider.
§registerLinkProvider(
languageSelector: LanguageSelector,
provider: LinkProvider,
): IDisposable
registerLinkProvider(
languageSelector: LanguageSelector,
provider: LinkProvider,
): IDisposable
Register a link provider that can find links in text.
§registerNewSymbolNameProvider(
languageSelector: LanguageSelector,
provider: NewSymbolNamesProvider,
): IDisposable
registerNewSymbolNameProvider(
languageSelector: LanguageSelector,
provider: NewSymbolNamesProvider,
): IDisposable
Register a new symbol-name provider (e.g., when a symbol is being renamed, show new possible symbol-names)
§registerOnTypeFormattingEditProvider(
languageSelector: LanguageSelector,
provider: OnTypeFormattingEditProvider,
): IDisposable
registerOnTypeFormattingEditProvider(
languageSelector: LanguageSelector,
provider: OnTypeFormattingEditProvider,
): IDisposable
Register a formatter than can do formatting as the user types.
§registerReferenceProvider(
languageSelector: LanguageSelector,
provider: ReferenceProvider,
): IDisposable
registerReferenceProvider(
languageSelector: LanguageSelector,
provider: ReferenceProvider,
): IDisposable
Register a reference provider (used by e.g. reference search).
§registerRenameProvider(
languageSelector: LanguageSelector,
provider: RenameProvider,
): IDisposable
registerRenameProvider(
languageSelector: LanguageSelector,
provider: RenameProvider,
): IDisposable
Register a rename provider (used by e.g. rename symbol).
§registerSelectionRangeProvider(
languageSelector: LanguageSelector,
provider: SelectionRangeProvider,
): IDisposable
registerSelectionRangeProvider(
languageSelector: LanguageSelector,
provider: SelectionRangeProvider,
): IDisposable
Register a selection range provider
§registerSignatureHelpProvider(
languageSelector: LanguageSelector,
provider: SignatureHelpProvider,
): IDisposable
registerSignatureHelpProvider(
languageSelector: LanguageSelector,
provider: SignatureHelpProvider,
): IDisposable
Register a signature help provider (used by e.g. parameter hints).
§registerTokensProviderFactory(
languageId: string,
factory: TokensProviderFactory,
): IDisposable
registerTokensProviderFactory(
languageId: string,
factory: TokensProviderFactory,
): IDisposable
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.
§registerTypeDefinitionProvider(
languageSelector: LanguageSelector,
provider: TypeDefinitionProvider,
): IDisposable
registerTypeDefinitionProvider(
languageSelector: LanguageSelector,
provider: TypeDefinitionProvider,
): IDisposable
Register a type definition provider (used by e.g. go to type definition).
§setColorMap(colorMap: string[]): void
setColorMap(colorMap: string[]): void
Change the color map that is used for token colors. Supported formats (hex): #RRGGBB, $RRGGBBAA, #RGB, #RGBA
§setLanguageConfiguration(
languageId: string,
configuration: LanguageConfiguration,
): IDisposable
setLanguageConfiguration(
languageId: string,
configuration: LanguageConfiguration,
): IDisposable
Set the editing configuration for a language.
§setMonarchTokensProvider(
languageId: string,
languageDef:
| IMonarchLanguage
| Thenable<IMonarchLanguage>,
): IDisposable
setMonarchTokensProvider(
languageId: string,
languageDef:
| IMonarchLanguage
| Thenable<IMonarchLanguage>,
): IDisposable
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.
§setTokensProvider(
languageId: string,
provider:
| TokensProvider
| EncodedTokensProvider
| Thenable<TokensProvider | EncodedTokensProvider>,
): IDisposable
setTokensProvider(
languageId: string,
provider:
| TokensProvider
| EncodedTokensProvider
| Thenable<TokensProvider | EncodedTokensProvider>,
): 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.
Events§
§onLanguage(
languageId: string,
callback: () => void,
): IDisposable
onLanguage(
languageId: string,
callback: () => void,
): IDisposable
An event emitted when a language is associated for the first time with a text model.
§onLanguageEncountered(
languageId: string,
callback: () => void,
): IDisposable
onLanguageEncountered(
languageId: string,
callback: () => void,
): IDisposable
An event emitted when a language is associated for the first time with a text model or when a language is encountered during the tokenization of another language.
Enumerations§
- CodeActionTriggerType
- CompletionItemInsertTextRule
- CompletionItemKind
- CompletionItemTag
- CompletionTriggerKind
How a suggest provider was triggered.
- DocumentHighlightKind
A document highlight kind.
- HoverVerbosityAction
- IndentAction
Describes what to do with the indentation when pressing Enter.
- InlayHintKind
- InlineCompletionEndOfLifeReasonKind
- InlineCompletionHintStyle
- InlineCompletionTriggerKind
How an inline completion provider was triggered.
- NewSymbolNameTag
- NewSymbolNameTriggerKind
- PartialAcceptTriggerKind
How a partial acceptance was triggered.
- SignatureHelpTriggerKind
- SymbolKind
A symbol kind.
- SymbolTag
Classes§
Interfaces§
- CodeAction
- CodeActionContext
Contains additional diagnostic information about the context in which a code action is run.
- CodeActionList
- CodeActionProvider
The code action interface defines the contract between extensions and the light bulb feature.
- CodeActionProviderMetadata
Metadata about the type of code actions that a CodeActionProvider provides.
- CodeLens
- CodeLensList
- CodeLensProvider
- Command
- CommentAuthorInformation
- CommentRule
Describes how comments for a language work.
- CommentThreadRevealOptions
- CompletionContext
Contains additional information about the context in which completion provider is triggered.
- CompletionItem
A completion item represents a text snippet that is proposed to complete text that is being typed.
- CompletionItemLabel
- CompletionItemProvider
The completion item provider interface defines the contract between extensions and the IntelliSense.
- CompletionItemRanges
- CompletionList
- DeclarationProvider
The definition provider interface defines the contract between extensions and the go to definition and peek definition features.
- DefinitionProvider
The definition provider interface defines the contract between extensions and the go to definition and peek definition features.
- DocumentColorProvider
A provider of colors for editor models.
- DocumentFormattingEditProvider
The document formatting provider interface defines the contract between extensions and the formatting-feature.
- DocumentHighlight
A document highlight is a range inside a text document which deserves special attention. Usually a document highlight is visualized by changing the background color of its range.
- DocumentHighlightProvider
The document highlight provider interface defines the contract between extensions and the word-highlight-feature.
- DocumentRangeFormattingEditProvider
The document formatting provider interface defines the contract between extensions and the formatting-feature.
- DocumentRangeSemanticTokensProvider
- DocumentSemanticTokensProvider
- DocumentSymbol
- DocumentSymbolProvider
The document symbol provider interface defines the contract between extensions and the go to symbol-feature.
- EncodedTokensProvider
A "manual" provider of tokens, returning tokens in a binary form.
- EnterAction
Describes what to do when pressing Enter.
- FoldingContext
- FoldingMarkers
Describes language specific folding markers such as '#region' and '#endregion'. The start and end regexes will be tested against the contents of all lines and must be designed efficiently:
- the regex should start with '^'
- regexp flags (i, g) are ignored
- FoldingRange
- FoldingRangeProvider
A provider of folding ranges for editor models.
- FoldingRules
Describes folding rules for a language.
- FormattingOptions
Interface used to format a model
- Hover
A hover represents additional information for a symbol or word. Hovers are rendered in a tooltip-like widget.
- HoverContext
- HoverProvider
The hover provider interface defines the contract between extensions and the hover-feature.
- HoverVerbosityRequest
- IAutoClosingPair
- IAutoClosingPairConditional
- IColor
A color in RGBA format.
- IColorInformation
A color range is a range in a text model which represents a color.
- IColorPresentation
String representations for a color
- ICustomEdit
- IDocComment
Definition of documentation comments (e.g. Javadoc/JSdoc)
- IEncodedLineTokens
The result of a line tokenization.
- IExpandedMonarchLanguageAction
- IExpandedMonarchLanguageRule
- ILanguageExtensionPoint
- ILineTokens
The result of a line tokenization.
- ILink
A link inside the editor.
- ILinksList
- IMonarchLanguage
A Monarch language definition
- IMonarchLanguageBracket
This interface can be shortened as an array, ie. ['{','}','delimiter.curly']
- ImplementationProvider
The implementation provider interface defines the contract between extensions and the go to implementation feature.
- IndentationRule
Describes indentation rules for a language.
- InlayHint
- InlayHintLabelPart
- InlayHintList
- InlayHintsProvider
- InlineCompletion
- InlineCompletionContext
- InlineCompletionHint
- InlineCompletions
- InlineCompletionsProvider
- InlineCompletionWarning
- IRelativePattern
- IState
The state of the tokenizer between two lines. It is useful to store flags such as in multiline comment, etc. The model will clone the previous line's state and pass it in to tokenize the next line.
- IToken
A token.
- IWorkspaceFileEdit
- IWorkspaceTextEdit
- LanguageConfiguration
The language configuration interface defines the contract between extensions and various editor features, like automatic bracket insertion, automatic indentation etc.
- LanguageFilter
- LineCommentConfig
Configuration for line comments.
- LinkedEditingRangeProvider
The linked editing range provider interface defines the contract between extensions and the linked editing feature.
- LinkedEditingRanges
Represents a list of ranges that can be edited together along with a word pattern to describe valid contents.
- LinkProvider
A provider of links.
- Location
Represents a location inside a resource, such as a line inside a text file.
- LocationLink
- MultiDocumentHighlight
Represents a set of document highlights for a specific Uri.
- MultiDocumentHighlightProvider
A provider that can provide document highlights across multiple documents.
- NewSymbolName
- NewSymbolNamesProvider
- OnEnterRule
Describes a rule to be evaluated when pressing Enter.
- OnTypeFormattingEditProvider
The document formatting provider interface defines the contract between extensions and the formatting-feature.
- ParameterInformation
Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.
- PartialAcceptInfo
Info provided on partial acceptance.
- PendingComment
- PendingCommentThread
- QueryCapture
- ReferenceContext
Value-object that contains additional information when requesting references.
- ReferenceProvider
The reference provider interface defines the contract between extensions and the find references-feature.
- Rejection
- RenameLocation
- RenameProvider
- SelectionRange
- SelectionRangeProvider
- SemanticTokens
- SemanticTokensEdit
- SemanticTokensEdits
- SemanticTokensLegend
- SignatureHelp
Signature help represents the signature of something callable. There can be multiple signatures but only one active and only one active parameter.
- SignatureHelpContext
- SignatureHelpProvider
The signature help provider interface defines the contract between extensions and the parameter hints-feature.
- SignatureHelpResult
- SignatureInformation
Represents the signature of something callable. A signature can have a label, like a function-name, a doc-comment, and a set of parameters.
- SyntaxNode
- TextEdit
- TokensProvider
A "manual" provider of tokens.
- TokensProviderFactory
A factory for token providers.
- TypeDefinitionProvider
The type definition provider interface defines the contract between extensions and the go to type definition feature.
- WorkspaceEdit
- WorkspaceEditMetadata
- WorkspaceFileEditOptions
A tuple of two characters, like a pair of opening and closing brackets.