All 31 public APIs exported from the languages module, with declarations, documentation, and source-backed examples.
Generated from typings/index.d.ts @ 555f5ceon
Check if specific provider exists for document.
languages.hasProvider(id: ProviderName, document: TextDocumentMatch): boolean| Parameter | Type |
|---|---|
| id | ProviderName |
| document | TextDocumentMatch |
Create a diagnostics collection.
languages.createDiagnosticCollection(name?: string): DiagnosticCollection| Parameter | Type | Description |
|---|---|---|
| name? | string | The name of the collection. |
A new diagnostic collection.
Register a formatting provider that works on type. The provider is active when the user enables the setting coc.preferences.formatOnType.
Multiple providers can be registered for a language. In that case providers are sorted by their score and the best-matching provider is used. Failure of the selected provider will cause a failure of the whole operation.
languages.registerOnTypeFormattingEditProvider(selector: DocumentSelector, provider: OnTypeFormattingEditProvider, triggerCharacters: string[]): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | OnTypeFormattingEditProvider | An on type formatting edit provider. |
| triggerCharacters | string[] | Trigger character that should trigger format on type. |
A disposable that unregisters this provider when being disposed.
Registers an asynchronous in-memory or external completion source.
languages.registerCompletionItemProvider(name: string, shortcut: string, selector: DocumentSelector | null, provider: CompletionItemProvider, triggerCharacters?: string[], priority?: number, allCommitCharacters?: string[]): Disposableimport { languages, CompletionItem, CompletionItemKind, DocumentSelector } from 'coc.nvim';
export function activate(context) {
const selector: DocumentSelector = [{ scheme: 'file', language: 'typescript' }];
context.subscriptions.push(
languages.registerCompletionItemProvider('customSource', 'MY', selector, {
async provideCompletionItems(doc, position) {
return [
{
label: 'awesomeCustomHelper',
kind: CompletionItemKind.Function,
detail: 'Custom fast utility',
insertText: 'awesomeCustomHelper()'
}
];
}
}, ['.'])
);
}| Parameter | Type | Description |
|---|---|---|
| name | string | Name of completion source. |
| shortcut | string | Shortcut used in completion menu. |
| selector | DocumentSelector | null | Document selector of created completion source. |
| provider | CompletionItemProvider | A completion provider. |
| triggerCharacters? | string[] | Trigger completion when the user types one of the characters. |
| priority? | number | Higher priority would shown first. |
| allCommitCharacters? | string[] | Commit characters of completion source. |
A 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.
languages.registerCodeActionProvider(selector: DocumentSelector, provider: CodeActionProvider, clientId: string | undefined, codeActionKinds?: ReadonlyArray<string>): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | CodeActionProvider | A code action provider. |
| clientId | string | undefined | Optional id of language client. |
| codeActionKinds? | ReadonlyArray<string> | Optional supported code action kinds. |
A 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.
languages.registerHoverProvider(selector: DocumentSelector, provider: HoverProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | HoverProvider | A hover provider. |
A 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.
languages.registerSelectionRangeProvider(selector: DocumentSelector, provider: SelectionRangeProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | SelectionRangeProvider | A selection range provider. |
A 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 score and called sequentially until a provider returns a valid result.
languages.registerSignatureHelpProvider(selector: DocumentSelector, provider: SignatureHelpProvider, triggerCharacters?: string[]): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | SignatureHelpProvider | A signature help provider. |
| triggerCharacters? | string[] | Trigger signature help when the user types one of the characters, like |
A 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 only first provider are asked for result.
languages.registerDocumentSymbolProvider(selector: DocumentSelector, provider: DocumentSymbolProvider, metadata?: DocumentSymbolProviderMetadata): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | DocumentSymbolProvider | A document symbol provider. |
| metadata? | DocumentSymbolProviderMetadata | Optional meta data. |
A 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 only first provider are asked for result.
A failing provider (rejected promise or exception) will not cause a failure of the whole operation.
languages.registerFoldingRangeProvider(selector: DocumentSelector, provider: FoldingRangeProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | FoldingRangeProvider | A folding range provider. |
A 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 score and groups sequentially asked for document highlights.
The process stops when a provider returns a non-falsy or non-failure result.
languages.registerDocumentHighlightProvider(selector: DocumentSelector, provider: DocumentHighlightProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | DocumentHighlightProvider | A document highlight provider. |
A 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.
languages.registerCodeLensProvider(selector: DocumentSelector, provider: CodeLensProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | CodeLensProvider | A code lens provider. |
A 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.
languages.registerDocumentLinkProvider(selector: DocumentSelector, provider: DocumentLinkProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | DocumentLinkProvider | A document link provider. |
A 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.
languages.registerDocumentColorProvider(selector: DocumentSelector, provider: DocumentColorProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | DocumentColorProvider | A color provider. |
A 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.
languages.registerDefinitionProvider(selector: DocumentSelector, provider: DefinitionProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | DefinitionProvider | A definition provider. |
A 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.
languages.registerDeclarationProvider(selector: DocumentSelector, provider: DeclarationProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | DeclarationProvider | A declaration provider. |
A 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.
languages.registerTypeDefinitionProvider(selector: DocumentSelector, provider: TypeDefinitionProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | TypeDefinitionProvider | A type definition provider. |
A 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.
languages.registerImplementationProvider(selector: DocumentSelector, provider: ImplementationProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | ImplementationProvider | An implementation provider. |
A 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.
languages.registerReferencesProvider(selector: DocumentSelector, provider: ReferenceProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | ReferenceProvider | A reference provider. |
A disposable that unregisters this provider when being disposed.
languages.registerRenameProvider(selector: DocumentSelector, provider: RenameProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | RenameProvider | A rename provider. |
A 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.
languages.registerWorkspaceSymbolProvider(provider: WorkspaceSymbolProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| provider | WorkspaceSymbolProvider | A workspace symbol provider. |
A 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 priority. Failure of the selected provider will cause a failure of the whole operation.
languages.registerDocumentFormatProvider(selector: DocumentSelector, provider: DocumentFormattingEditProvider, priority?: number): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | DocumentFormattingEditProvider | A document formatting edit provider. |
| priority? | number | default to 0. |
A disposable that unregisters this provider when being disposed.
Register a formatting provider for a document range.
Note: A document range provider is also a document formatter which means there is no need to register a document formatter when also registering a range provider.
Multiple providers can be registered for a language. In that case provider with highest priority is used. Failure of the selected provider will cause a failure of the whole operation.
languages.registerDocumentRangeFormatProvider(selector: DocumentSelector, provider: DocumentRangeFormattingEditProvider, priority?: number): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | DocumentRangeFormattingEditProvider | A document range formatting edit provider. |
| priority? | number | default to 0. |
A disposable that unregisters this provider when being disposed.
Register a call hierarchy provider.
languages.registerCallHierarchyProvider(selector: DocumentSelector, provider: CallHierarchyProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | CallHierarchyProvider | A call hierarchy provider. |
A 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 score and the best-matching provider is used. Failure of the selected provider will cause a failure of the whole operation.
languages.registerDocumentSemanticTokensProvider(selector: DocumentSelector, provider: DocumentSemanticTokensProvider, legend: SemanticTokensLegend): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | DocumentSemanticTokensProvider | A document semantic tokens provider. |
| legend | SemanticTokensLegend |
A 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 score and the best-matching provider is used. Failure of the selected provider will cause a failure of the whole operation.
languages.registerDocumentRangeSemanticTokensProvider(selector: DocumentSelector, provider: DocumentRangeSemanticTokensProvider, legend: SemanticTokensLegend): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | DocumentRangeSemanticTokensProvider | A document range semantic tokens provider. |
| legend | SemanticTokensLegend |
A 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 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.
languages.registerLinkedEditingRangeProvider(selector: DocumentSelector, provider: LinkedEditingRangeProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | LinkedEditingRangeProvider | A linked editing range provider. |
A 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.
languages.registerInlayHintsProvider(selector: DocumentSelector, provider: InlayHintsProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | InlayHintsProvider | An inlay hints provider. |
A Disposable that unregisters this provider when being disposed.
Register a type hierarchy provider.
languages.registerTypeHierarchyProvider(selector: DocumentSelector, provider: TypeHierarchyProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | TypeHierarchyProvider | A type hierarchy provider. |
A Disposable that unregisters this provider when being disposed.
Register a inline completion item provider.
languages.registerInlineCompletionItemProvider(selector: DocumentSelector, provider: InlineCompletionItemProvider): Disposable| Parameter | Type | Description |
|---|---|---|
| selector | DocumentSelector | A selector that defines the documents this provider is applicable to. |
| provider | InlineCompletionItemProvider | A InlineCompletion provider. |
A Disposable that unregisters this provider when being disposed.
Register a provider of generic, versioned next edits.
languages.registerNextEditProvider(selector: DocumentSelector, provider: NextEditProvider): Disposable| Parameter | Type |
|---|---|
| selector | DocumentSelector |
| provider | NextEditProvider |