- create-diagnostic-collection
- create-language-status-item
- diagnostics
- languages
- match
- on-did-change-diagnostics
- register-call-hierarchy-provider
- register-code-actions-provider
- register-code-lens-provider
- register-color-provider
- register-completion-item-provider
- register-declaration-provider
- register-definition-provider
- register-document-drop-edit-provider
- register-document-formatting-edit-provider
- register-document-highlight-provider
- register-document-link-provider
- register-document-range-formatting-edit-provider
- register-document-range-semantic-tokens-provider
- register-document-semantic-tokens-provider
- register-document-symbol-provider
- register-evaluatable-expression-provider
- register-folding-range-provider
- register-hover-provider
- register-implementation-provider
- register-inlay-hints-provider
- register-inline-completion-item-provider
- register-inline-values-provider
- register-linked-editing-range-provider
- register-on-type-formatting-edit-provider
- register-reference-provider
- register-rename-provider
- register-selection-range-provider
- register-signature-help-provider
- register-type-definition-provider
- register-type-hierarchy-provider
- register-workspace-symbol-provider
- set-language-configuration
- set-text-document-language
dots.vscode.languages
Namespace for participating in language-specific editor features, like IntelliSense, code actions, diagnostics etc.
Many programming languages exist and there is huge variety in syntaxes, semantics, and paradigms. Despite that, features like automatic word-completion, code navigation, or code checking have become popular across different tools for different programming languages.
The editor provides an API that makes it simple to provide such common features by having all UI and actions already in place and by allowing you to participate by providing data only. For instance, to contribute a hover all you have to do is provide a function that can be called with a {@link TextDocument } and a {@link Position } returning hover info. The rest, like tracking the mouse, positioning the hover, keeping the hover stable etc. is taken care of by the editor.
languages.registerHoverProvider('javascript', {
provideHover(document, position, token) {
return new Hover('I am a hover!');
}
});
Registration is done using a {@link DocumentSelector document selector} which is either a language id, like javascript or
a more complex {@link DocumentFilter filter} like { language: 'typescript', scheme: 'file' }. Matching a document against such
a selector will result in a {@link languages.match score} that is used to determine if and how a provider shall be used. When
scores are equal the provider that came last wins. For features that allow full arity, like {@link languages.registerHoverProvider hover},
the score is only checked to be >0, for other features, like {@link languages.registerCompletionItemProvider IntelliSense} the
score is used for determining the order in which providers are asked to participate.
Namespace for participating in language-specific editor [features](https://code.visualstudio.com/docs/editor/editingevolved),
like IntelliSense, code actions, diagnostics etc.
Many programming languages exist and there is huge variety in syntaxes, semantics, and paradigms. Despite that, features
like automatic word-completion, code navigation, or code checking have become popular across different tools for different
programming languages.
The editor provides an API that makes it simple to provide such common features by having all UI and actions already in place and
by allowing you to participate by providing data only. For instance, to contribute a hover all you have to do is provide a function
that can be called with a {@link TextDocument } and a {@link Position } returning hover info. The rest, like tracking the
mouse, positioning the hover, keeping the hover stable etc. is taken care of by the editor.
```javascript
languages.registerHoverProvider('javascript', {
provideHover(document, position, token) {
return new Hover('I am a hover!');
}
});
```
Registration is done using a {@link DocumentSelector document selector} which is either a language id, like `javascript` or
a more complex {@link DocumentFilter filter} like `{ language: 'typescript', scheme: 'file' }`. Matching a document against such
a selector will result in a {@link languages.match score} that is used to determine if and how a provider shall be used. When
scores are equal the provider that came last wins. For features that allow full arity, like {@link languages.registerHoverProvider hover},
the score is only checked to be `>0`, for other features, like {@link languages.registerCompletionItemProvider IntelliSense} the
score is used for determining the order in which providers are asked to participate.create-diagnostic-collectioncljs
(create-diagnostic-collection)(create-diagnostic-collection name)Create a diagnostics collection.
Parameters:
name:string | undefined- The {@link DiagnosticCollection.name name} of the collection.
Returns: DiagnosticCollection - A new diagnostic collection.
Create a diagnostics collection.
**Parameters:**
- `name`: `string | undefined` - The {@link DiagnosticCollection.name name} of the collection.
**Returns:** `DiagnosticCollection` - A new diagnostic collection.create-language-status-itemcljs
(create-language-status-item id selector)Creates a new {@link LanguageStatusItem language status item}.
Parameters:
id:string- The identifier of the item.selector:DocumentSelector- The document selector that defines for what editors the item shows.
Returns: LanguageStatusItem - A new language status item.
Creates a new {@link LanguageStatusItem language status item}.
**Parameters:**
- `id`: `string` - The identifier of the item.
- `selector`: `DocumentSelector` - The document selector that defines for what editors the item shows.
**Returns:** `LanguageStatusItem` - A new language status item.diagnosticscljs
(diagnostics)(diagnostics resource)Get all diagnostics for a given resource. Get all diagnostics.
Parameters:
resource:Uri- A resource
Returns: [Uri, Diagnostic[]][] - An array of uri-diagnostics tuples or an empty array.
Get all diagnostics for a given resource. Get all diagnostics. **Parameters:** - `resource`: `Uri` - A resource **Returns:** `[Uri, Diagnostic[]][]` - An array of uri-diagnostics tuples or an empty array.
languagescljs
(languages)Return the identifiers of all known languages.
Returns: Thenable<string[]> - Promise resolving to an array of identifier strings.
Return the identifiers of all known languages. **Returns:** `Thenable<string[]>` - Promise resolving to an array of identifier strings.
matchcljs
(match selector document)Compute the match between a document {@link DocumentSelector selector} and a document. Values greater than zero mean the selector matches the document.
A match is computed according to these rules:
- When {@linkcode DocumentSelector } is an array, compute the match for each contained
DocumentFilteror language identifier and take the maximum value. - A string will be desugared to become the
language-part of a {@linkcode DocumentFilter }, so"fooLang"is like{ language: "fooLang" }. - A {@linkcode DocumentFilter } will be matched against the document by comparing its parts with the document. The following rules apply:
- When the
DocumentFilteris empty ({}) the result is0 - When
scheme,language,pattern, ornotebookare defined but one doesn't match, the result is0 - Matching against
*gives a score of5, matching via equality or via a glob-pattern gives a score of10 - The result is the maximum value of each match
- When the
Samples:
// default document from disk (file-scheme)
doc.uri; //'file:///my/file.js'
doc.languageId; // 'javascript'
match('javascript', doc); // 10;
match({ language: 'javascript' }, doc); // 10;
match({ language: 'javascript', scheme: 'file' }, doc); // 10;
match('*', doc); // 5
match('fooLang', doc); // 0
match(['fooLang', '*'], doc); // 5
// virtual document, e.g. from git-index
doc.uri; // 'git:/my/file.js'
doc.languageId; // 'javascript'
match('javascript', doc); // 10;
match({ language: 'javascript', scheme: 'git' }, doc); // 10;
match('*', doc); // 5
// notebook cell document
doc.uri; // `vscode-notebook-cell:///my/notebook.ipynb#gl65s2pmha`;
doc.languageId; // 'python'
match({ notebookType: 'jupyter-notebook' }, doc) // 10
match({ notebookType: 'fooNotebook', language: 'python' }, doc) // 0
match({ language: 'python' }, doc) // 10
match({ notebookType: '*' }, doc) // 5
Parameters:
selector:DocumentSelector- A document selector.document:TextDocument- A text document.
Returns: number - A number >0 when the selector matches and 0 when the selector does not match.
Compute the match between a document {@link DocumentSelector selector} and a document. Values
greater than zero mean the selector matches the document.
A match is computed according to these rules:
1. When {@linkcode DocumentSelector } is an array, compute the match for each contained `DocumentFilter` or language identifier and take the maximum value.
2. A string will be desugared to become the `language`-part of a {@linkcode DocumentFilter }, so `"fooLang"` is like `{ language: "fooLang" }`.
3. A {@linkcode DocumentFilter } will be matched against the document by comparing its parts with the document. The following rules apply:
1. When the `DocumentFilter` is empty (`{}`) the result is `0`
2. When `scheme`, `language`, `pattern`, or `notebook` are defined but one doesn't match, the result is `0`
3. Matching against `*` gives a score of `5`, matching via equality or via a glob-pattern gives a score of `10`
4. The result is the maximum value of each match
Samples:
```js
// default document from disk (file-scheme)
doc.uri; //'file:///my/file.js'
doc.languageId; // 'javascript'
match('javascript', doc); // 10;
match({ language: 'javascript' }, doc); // 10;
match({ language: 'javascript', scheme: 'file' }, doc); // 10;
match('*', doc); // 5
match('fooLang', doc); // 0
match(['fooLang', '*'], doc); // 5
// virtual document, e.g. from git-index
doc.uri; // 'git:/my/file.js'
doc.languageId; // 'javascript'
match('javascript', doc); // 10;
match({ language: 'javascript', scheme: 'git' }, doc); // 10;
match('*', doc); // 5
// notebook cell document
doc.uri; // `vscode-notebook-cell:///my/notebook.ipynb#gl65s2pmha`;
doc.languageId; // 'python'
match({ notebookType: 'jupyter-notebook' }, doc) // 10
match({ notebookType: 'fooNotebook', language: 'python' }, doc) // 0
match({ language: 'python' }, doc) // 10
match({ notebookType: '*' }, doc) // 5
```
**Parameters:**
- `selector`: `DocumentSelector` - A document selector.
- `document`: `TextDocument` - A text document.
**Returns:** `number` - A number `>0` when the selector matches and `0` when the selector does not match.on-did-change-diagnosticscljs
(on-did-change-diagnostics)(on-did-change-diagnostics listener)(on-did-change-diagnostics listener this-args)(on-did-change-diagnostics listener this-args disposables)An {@link Event } which fires when the global set of diagnostics changes. This is newly added and removed diagnostics.
Parameters:
listener:(e: T) => any- The listener function will be called when the event happens.this-args:any- Thethis-argument which will be used when calling the event listener.disposables:Disposable[] | undefined- An array to which a {@link Disposable } will be added.
Returns: Disposable - A disposable which unsubscribes the event listener.
An {@link Event } which fires when the global set of diagnostics changes. This is
newly added and removed diagnostics.
**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.
**Returns:** `Disposable` - A disposable which unsubscribes the event listener.register-call-hierarchy-providercljs
(register-call-hierarchy-provider selector provider)Register a call hierarchy provider.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:CallHierarchyProvider- A call hierarchy provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a call hierarchy provider.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `CallHierarchyProvider` - A call hierarchy provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-code-actions-providercljs
(register-code-actions-provider selector provider)(register-code-actions-provider selector provider metadata)Register a code action provider.
Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:CodeActionProvider<CodeAction>- A code action provider.metadata:CodeActionProviderMetadata | undefined- Metadata about the kind of code actions the provider provides.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a code action provider.
Multiple providers can be registered for a language. In that case providers are asked in
parallel and the results are merged. A failing provider (rejected promise or exception) will
not cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `CodeActionProvider<CodeAction>` - A code action provider.
- `metadata`: `CodeActionProviderMetadata | undefined` - Metadata about the kind of code actions the provider provides.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-code-lens-providercljs
(register-code-lens-provider selector provider)Register a code lens provider.
Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:CodeLensProvider<CodeLens>- A code lens provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a code lens provider.
Multiple providers can be registered for a language. In that case providers are asked in
parallel and the results are merged. A failing provider (rejected promise or exception) will
not cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `CodeLensProvider<CodeLens>` - A code lens provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-color-providercljs
(register-color-provider selector provider)Register a color provider.
Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:DocumentColorProvider- A color provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a color provider.
Multiple providers can be registered for a language. In that case providers are asked in
parallel and the results are merged. A failing provider (rejected promise or exception) will
not cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `DocumentColorProvider` - A color provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-completion-item-providercljs
(register-completion-item-provider selector provider & trigger-characters)Register a completion provider.
Multiple providers can be registered for a language. In that case providers are sorted by their {@link languages.match score} and groups of equal score are sequentially asked for completion items. The process stops when one or many providers of a group return a result. A failing provider (rejected promise or exception) will not fail the whole operation.
A completion item provider can be associated with a set of triggerCharacters. When trigger
characters are being typed, completions are requested but only from providers that registered
the typed character. Because of that trigger characters should be different than {@link LanguageConfiguration.wordPattern word characters},
a common trigger character is . to trigger member completions.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:CompletionItemProvider<CompletionItem>- A completion provider.trigger-characters:string[]- Trigger completion when the user types one of the characters.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a completion provider.
Multiple providers can be registered for a language. In that case providers are sorted
by their {@link languages.match score} and groups of equal score are sequentially asked for
completion items. The process stops when one or many providers of a group return a
result. A failing provider (rejected promise or exception) will not fail the whole
operation.
A completion item provider can be associated with a set of `triggerCharacters`. When trigger
characters are being typed, completions are requested but only from providers that registered
the typed character. Because of that trigger characters should be different than {@link LanguageConfiguration.wordPattern word characters},
a common trigger character is `.` to trigger member completions.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `CompletionItemProvider<CompletionItem>` - A completion provider.
- `trigger-characters`: `string[]` - Trigger completion when the user types one of the characters.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-declaration-providercljs
(register-declaration-provider selector provider)Register a declaration provider.
Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:DeclarationProvider- A declaration provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a declaration provider.
Multiple providers can be registered for a language. In that case providers are asked in
parallel and the results are merged. A failing provider (rejected promise or exception) will
not cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `DeclarationProvider` - A declaration provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-definition-providercljs
(register-definition-provider selector provider)Register a definition provider.
Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:DefinitionProvider- A definition provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a definition provider.
Multiple providers can be registered for a language. In that case providers are asked in
parallel and the results are merged. A failing provider (rejected promise or exception) will
not cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `DefinitionProvider` - A definition provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-document-drop-edit-providercljs
(register-document-drop-edit-provider selector provider)Registers a new {@link DocumentDropEditProvider }.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider applies to.provider:DocumentDropEditProvider- A drop provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when disposed of.
Registers a new {@link DocumentDropEditProvider }.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider applies to.
- `provider`: `DocumentDropEditProvider` - A drop provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when disposed of.register-document-formatting-edit-providercljs
(register-document-formatting-edit-provider selector provider)Register a formatting provider for a document.
Multiple providers can be registered for a language. In that case providers are sorted by their {@link languages.match score} and the best-matching provider is used. Failure of the selected provider will cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:DocumentFormattingEditProvider- A document formatting edit provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a formatting provider for a document.
Multiple providers can be registered for a language. In that case providers are sorted
by their {@link languages.match score} and the best-matching provider is used. Failure
of the selected provider will cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `DocumentFormattingEditProvider` - A document formatting edit provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-document-highlight-providercljs
(register-document-highlight-provider selector provider)Register a document highlight provider.
Multiple providers can be registered for a language. In that case providers are sorted
by their {@link languages.match score} and groups sequentially asked for document highlights.
The process stops when a provider returns a non-falsy or non-failure result.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:DocumentHighlightProvider- A document highlight provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a document highlight provider.
Multiple providers can be registered for a language. In that case providers are sorted
by their {@link languages.match score} and groups sequentially asked for document highlights.
The process stops when a provider returns a `non-falsy` or `non-failure` result.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `DocumentHighlightProvider` - A document highlight provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-document-link-providercljs
(register-document-link-provider selector provider)Register a document link provider.
Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:DocumentLinkProvider<DocumentLink>- A document link provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a document link provider.
Multiple providers can be registered for a language. In that case providers are asked in
parallel and the results are merged. A failing provider (rejected promise or exception) will
not cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `DocumentLinkProvider<DocumentLink>` - A document link provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-document-range-formatting-edit-providercljs
(register-document-range-formatting-edit-provider selector provider)Register a formatting provider for a document range.
Note: A document range provider is also a {@link DocumentFormattingEditProvider document formatter} which means there is no need to {@link languages.registerDocumentFormattingEditProvider register} a document formatter when also registering a range provider.
Multiple providers can be registered for a language. In that case providers are sorted by their {@link languages.match score} and the best-matching provider is used. Failure of the selected provider will cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:DocumentRangeFormattingEditProvider- A document range formatting edit provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a formatting provider for a document range.
*Note:* A document range provider is also a {@link DocumentFormattingEditProvider document formatter}
which means there is no need to {@link languages.registerDocumentFormattingEditProvider register} a document
formatter when also registering a range provider.
Multiple providers can be registered for a language. In that case providers are sorted
by their {@link languages.match score} and the best-matching provider is used. Failure
of the selected provider will cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `DocumentRangeFormattingEditProvider` - A document range formatting edit provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-document-range-semantic-tokens-providercljs
(register-document-range-semantic-tokens-provider selector provider legend)Register a semantic tokens provider for a document range.
Note: If a document has both a DocumentSemanticTokensProvider and a DocumentRangeSemanticTokensProvider,
the range provider will be invoked only initially, for the time in which the full document provider takes
to resolve the first request. Once the full document provider resolves the first request, the semantic tokens
provided via the range provider will be discarded and from that point forward, only the document provider
will be used.
Multiple providers can be registered for a language. In that case providers are sorted by their {@link languages.match score} and the best-matching provider is used. Failure of the selected provider will cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:DocumentRangeSemanticTokensProvider- A document range semantic tokens provider.legend:SemanticTokensLegend
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a semantic tokens provider for a document range.
*Note:* If a document has both a `DocumentSemanticTokensProvider` and a `DocumentRangeSemanticTokensProvider`,
the range provider will be invoked only initially, for the time in which the full document provider takes
to resolve the first request. Once the full document provider resolves the first request, the semantic tokens
provided via the range provider will be discarded and from that point forward, only the document provider
will be used.
Multiple providers can be registered for a language. In that case providers are sorted
by their {@link languages.match score} and the best-matching provider is used. Failure
of the selected provider will cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `DocumentRangeSemanticTokensProvider` - A document range semantic tokens provider.
- `legend`: `SemanticTokensLegend`
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-document-semantic-tokens-providercljs
(register-document-semantic-tokens-provider selector provider legend)Register a semantic tokens provider for a whole document.
Multiple providers can be registered for a language. In that case providers are sorted by their {@link languages.match score} and the best-matching provider is used. Failure of the selected provider will cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:DocumentSemanticTokensProvider- A document semantic tokens provider.legend:SemanticTokensLegend
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a semantic tokens provider for a whole document.
Multiple providers can be registered for a language. In that case providers are sorted
by their {@link languages.match score} and the best-matching provider is used. Failure
of the selected provider will cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `DocumentSemanticTokensProvider` - A document semantic tokens provider.
- `legend`: `SemanticTokensLegend`
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-document-symbol-providercljs
(register-document-symbol-provider selector provider)(register-document-symbol-provider selector provider meta-data)Register a document symbol provider.
Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:DocumentSymbolProvider- A document symbol provider.meta-data:DocumentSymbolProviderMetadata | undefined- metadata about the provider
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a document symbol provider.
Multiple providers can be registered for a language. In that case providers are asked in
parallel and the results are merged. A failing provider (rejected promise or exception) will
not cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `DocumentSymbolProvider` - A document symbol provider.
- `meta-data`: `DocumentSymbolProviderMetadata | undefined` - metadata about the provider
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-evaluatable-expression-providercljs
(register-evaluatable-expression-provider selector provider)Register a provider that locates evaluatable expressions in text documents. The editor will evaluate the expression in the active debug session and will show the result in the debug hover.
If multiple providers are registered for a language an arbitrary provider will be used.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:EvaluatableExpressionProvider- An evaluatable expression provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a provider that locates evaluatable expressions in text documents.
The editor will evaluate the expression in the active debug session and will show the result in the debug hover.
If multiple providers are registered for a language an arbitrary provider will be used.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `EvaluatableExpressionProvider` - An evaluatable expression provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-folding-range-providercljs
(register-folding-range-provider selector provider)Register a folding range provider.
Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. If multiple folding ranges start at the same position, only the range of the first registered provider is used. If a folding range overlaps with an other range that has a smaller position, it is also ignored.
A failing provider (rejected promise or exception) will not cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:FoldingRangeProvider- A folding range provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a folding range provider.
Multiple providers can be registered for a language. In that case providers are asked in
parallel and the results are merged.
If multiple folding ranges start at the same position, only the range of the first registered provider is used.
If a folding range overlaps with an other range that has a smaller position, it is also ignored.
A failing provider (rejected promise or exception) will
not cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `FoldingRangeProvider` - A folding range provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-hover-providercljs
(register-hover-provider selector provider)Register a hover provider.
Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:HoverProvider- A hover provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a hover provider.
Multiple providers can be registered for a language. In that case providers are asked in
parallel and the results are merged. A failing provider (rejected promise or exception) will
not cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `HoverProvider` - A hover provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-implementation-providercljs
(register-implementation-provider selector provider)Register an implementation provider.
Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:ImplementationProvider- An implementation provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register an implementation provider.
Multiple providers can be registered for a language. In that case providers are asked in
parallel and the results are merged. A failing provider (rejected promise or exception) will
not cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `ImplementationProvider` - An implementation provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-inlay-hints-providercljs
(register-inlay-hints-provider selector provider)Register a inlay hints provider.
Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:InlayHintsProvider<InlayHint>- An inlay hints provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a inlay hints provider.
Multiple providers can be registered for a language. In that case providers are asked in
parallel and the results are merged. A failing provider (rejected promise or exception) will
not cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `InlayHintsProvider<InlayHint>` - An inlay hints provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-inline-completion-item-providercljs
(register-inline-completion-item-provider selector provider)Registers an inline completion provider.
Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:InlineCompletionItemProvider- An inline completion provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Registers an inline completion provider.
Multiple providers can be registered for a language. In that case providers are asked in
parallel and the results are merged. A failing provider (rejected promise or exception) will
not cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `InlineCompletionItemProvider` - An inline completion provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-inline-values-providercljs
(register-inline-values-provider selector provider)Register a provider that returns data for the debugger's 'inline value' feature. Whenever the generic debugger has stopped in a source file, providers registered for the language of the file are called to return textual data that will be shown in the editor at the end of lines.
Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:InlineValuesProvider- An inline values provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a provider that returns data for the debugger's 'inline value' feature.
Whenever the generic debugger has stopped in a source file, providers registered for the language of the file
are called to return textual data that will be shown in the editor at the end of lines.
Multiple providers can be registered for a language. In that case providers are asked in
parallel and the results are merged. A failing provider (rejected promise or exception) will
not cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `InlineValuesProvider` - An inline values provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-linked-editing-range-providercljs
(register-linked-editing-range-provider selector provider)Register a linked editing range provider.
Multiple providers can be registered for a language. In that case providers are sorted by their {@link languages.match score} and the best-matching provider that has a result is used. Failure of the selected provider will cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:LinkedEditingRangeProvider- A linked editing range provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a linked editing range provider.
Multiple providers can be registered for a language. In that case providers are sorted
by their {@link languages.match score} and the best-matching provider that has a result is used. Failure
of the selected provider will cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `LinkedEditingRangeProvider` - A linked editing range provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-on-type-formatting-edit-providercljs
(register-on-type-formatting-edit-provider selector
provider
first-trigger-character
&
more-trigger-character)Register a formatting provider that works on type. The provider is active when the user enables the setting editor.formatOnType.
Multiple providers can be registered for a language. In that case providers are sorted by their {@link languages.match score} and the best-matching provider is used. Failure of the selected provider will cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:OnTypeFormattingEditProvider- An on type formatting edit provider.first-trigger-character:string- A character on which formatting should be triggered, like}.more-trigger-character:string[]- More trigger characters.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a formatting provider that works on type. The provider is active when the user enables the setting `editor.formatOnType`.
Multiple providers can be registered for a language. In that case providers are sorted
by their {@link languages.match score} and the best-matching provider is used. Failure
of the selected provider will cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `OnTypeFormattingEditProvider` - An on type formatting edit provider.
- `first-trigger-character`: `string` - A character on which formatting should be triggered, like `}`.
- `more-trigger-character`: `string[]` - More trigger characters.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-reference-providercljs
(register-reference-provider selector provider)Register a reference provider.
Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:ReferenceProvider- A reference provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a reference provider.
Multiple providers can be registered for a language. In that case providers are asked in
parallel and the results are merged. A failing provider (rejected promise or exception) will
not cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `ReferenceProvider` - A reference provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-rename-providercljs
(register-rename-provider selector provider)Register a rename provider.
Multiple providers can be registered for a language. In that case providers are sorted by their {@link languages.match score} and asked in sequence. The first provider producing a result defines the result of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:RenameProvider- A rename provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a rename provider.
Multiple providers can be registered for a language. In that case providers are sorted
by their {@link languages.match score} and asked in sequence. The first provider producing a result
defines the result of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `RenameProvider` - A rename provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-selection-range-providercljs
(register-selection-range-provider selector provider)Register a selection range provider.
Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:SelectionRangeProvider- A selection range provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a selection range provider.
Multiple providers can be registered for a language. In that case providers are asked in
parallel and the results are merged. A failing provider (rejected promise or exception) will
not cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `SelectionRangeProvider` - A selection range provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-signature-help-providercljs
(register-signature-help-provider selector provider metadata)(register-signature-help-provider selector provider & trigger-characters)Register a signature help provider.
Multiple providers can be registered for a language. In that case providers are sorted by their {@link languages.match score} and called sequentially until a provider returns a valid result.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:SignatureHelpProvider- A signature help provider.metadata:SignatureHelpProviderMetadata- Information about the provider.trigger-characters:string[]- Trigger signature help when the user types one of the characters, like,or(.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a signature help provider.
Multiple providers can be registered for a language. In that case providers are sorted
by their {@link languages.match score} and called sequentially until a provider returns a
valid result.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `SignatureHelpProvider` - A signature help provider.
- `metadata`: `SignatureHelpProviderMetadata` - Information about the provider.
- `trigger-characters`: `string[]` - Trigger signature help when the user types one of the characters, like `,` or `(`.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-type-definition-providercljs
(register-type-definition-provider selector provider)Register a type definition provider.
Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:TypeDefinitionProvider- A type definition provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a type definition provider.
Multiple providers can be registered for a language. In that case providers are asked in
parallel and the results are merged. A failing provider (rejected promise or exception) will
not cause a failure of the whole operation.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `TypeDefinitionProvider` - A type definition provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-type-hierarchy-providercljs
(register-type-hierarchy-provider selector provider)Register a type hierarchy provider.
Parameters:
selector:DocumentSelector- A selector that defines the documents this provider is applicable to.provider:TypeHierarchyProvider- A type hierarchy provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a type hierarchy provider.
**Parameters:**
- `selector`: `DocumentSelector` - A selector that defines the documents this provider is applicable to.
- `provider`: `TypeHierarchyProvider` - A type hierarchy provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.register-workspace-symbol-providercljs
(register-workspace-symbol-provider provider)Register a workspace symbol provider.
Multiple providers can be registered. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.
Parameters:
provider:WorkspaceSymbolProvider<SymbolInformation>- A workspace symbol provider.
Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.
Register a workspace symbol provider.
Multiple providers can be registered. In that case providers are asked in parallel and
the results are merged. A failing provider (rejected promise or exception) will not cause
a failure of the whole operation.
**Parameters:**
- `provider`: `WorkspaceSymbolProvider<SymbolInformation>` - A workspace symbol provider.
**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.set-language-configurationcljs
(set-language-configuration language configuration)Set a {@link LanguageConfiguration language configuration} for a language.
Parameters:
language:string- A language identifier liketypescript.configuration:LanguageConfiguration- Language configuration.
Returns: Disposable - A {@link Disposable} that unsets this configuration.
Set a {@link LanguageConfiguration language configuration} for a language.
**Parameters:**
- `language`: `string` - A language identifier like `typescript`.
- `configuration`: `LanguageConfiguration` - Language configuration.
**Returns:** `Disposable` - A {@link Disposable} that unsets this configuration.set-text-document-languagecljs
(set-text-document-language document language-id)Set (and change) the {@link TextDocument.languageId language} that is associated with the given document.
Note that calling this function will trigger the {@linkcode workspace.onDidCloseTextDocument onDidCloseTextDocument} event followed by the {@linkcode workspace.onDidOpenTextDocument onDidOpenTextDocument} event.
Parameters:
document:TextDocument- The document which language is to be changedlanguage-id:string- The new language identifier.
Returns: Thenable<TextDocument> - A thenable that resolves with the updated document.
Set (and change) the {@link TextDocument.languageId language} that is associated
with the given document.
*Note* that calling this function will trigger the {@linkcode workspace.onDidCloseTextDocument onDidCloseTextDocument} event
followed by the {@linkcode workspace.onDidOpenTextDocument onDidOpenTextDocument} event.
**Parameters:**
- `document`: `TextDocument` - The document which language is to be changed
- `language-id`: `string` - The new language identifier.
**Returns:** `Thenable<TextDocument>` - A thenable that resolves with the updated document.cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close