workspace API

Type of pattern used by workspace folder.

Current buffer number, could be wrong since vim could not send autocmd as expected.

Returns a Promise that resolves to the active buffer/document instance in Vim/Neovim.

Environments or current (neo)vim.

Float window or popup can work.

Current working directory of vim.

Current workspace root.

Field/Property workspace.rootPath exported by workspace.

Not neovim when true.

Is neovim when true.

All filetypes of loaded documents.

All languageIds of loaded documents.

Root directory of coc.nvim

Exists channel names.

Loaded documents that attached.

Current document array.

Current workspace folders.

Directory paths of workspaceFolders.

Current workspace folder, could be null when vim started from user's home.

Field/Property workspace.onDidCreateFiles exported by workspace.

Field/Property workspace.onDidRenameFiles exported by workspace.

Field/Property workspace.onDidDeleteFiles exported by workspace.

Field/Property workspace.onWillCreateFiles exported by workspace.

Field/Property workspace.onWillRenameFiles exported by workspace.

Field/Property workspace.onWillDeleteFiles exported by workspace.

Event fired on workspace folder change.

Event fired after document create.

Event fired after document unload.

Event fired on document change.

Event fired before document save.

Event fired after document save.

Event fired on configuration change. Configuration change could by many reasons, including:

• Changes detected from coc-settings.json.
• Change to document that using another configuration file.
• Configuration change by call update API of WorkspaceConfiguration.

Fired when vim's runtimepath change detected.

Returns a path that is relative to the workspace folder or folders.

When there are no workspace folders or when the path is not contained in them, the input is returned.

Returns converted unix path when the vim is built with win32unix enabled. Original fullpath is returned when the convert is not necessary. Only needed when the fullpath is passed vim directly.

Opens a document. Will return early if this document is already open. Otherwise the document is loaded and the didOpen-event fires.

The document is denoted by an Uri. Depending on the scheme the following rules apply:

• file-scheme: Open a file on disk (openTextDocument(Uri.file(path))). Will be rejected if the file does not exist or cannot be loaded.
• untitled-scheme: Open a blank untitled file with associated path (openTextDocument(Uri.file(path).with({ scheme: 'untitled' }))). The language will be derived from the file name.
• For all other schemes contributed TextDocumentContentProvider text document content providers and file system providers are consulted.

Note that the lifecycle of the returned document is owned by the editor and not by the extension. That means an onDidClose-event can occur at any time after opening it.

Get display cell count of text on vim. Control character below 0x80 are considered as 1.

Like vim's has(), but for version check only. Check patch on neovim and check nvim on vim would return false.

For example:

• has('nvim-0.6.0')
• has('patch-7.4.248')

Register autocmd on vim.

Note: avoid request autocmd when possible since vim could be blocked forever when request triggered during request.

Watch for vim's global option change.

Watch for vim's global variable change, works on neovim only.

Check if selector match document.

Findup from filename or filenames from current filepath or root.

Get possible watchman binary path.

Retrieve scoped user or workspace settings from coc-settings.json.

Resolve internal json schema, uri should starts with vscode://

Get created document by uri or bufnr.

Applies workspace file edits across open and unopened files using coc.nvim buffer handling.

Convert location to quickfix item.

Convert locations to quickfix list.

Populate locations to UI.

Get content of line by uri and line.

Get WorkspaceFolder of uri

Get content from buffer or file by uri.

Get current document and position.

Get format options of uri or current buffer.

Jump to location.

Create a file in vim and disk

Load uri as document, buffer would be invisible if not loaded.

Load the files that not loaded

Rename file in vim and disk

Delete file from vim and disk.

Open resource by uri

Resolve full path of module from yarn or npm global directory.

Run nodejs command

Expand filepath with ~ and/or environment placeholders

Call a function by use notifications, useful for functions like |input| that could block vim.

Register TextDocumentContentProvider for custom scheme

Register unique global key-mapping with <Plug>(coc-{key}) as lhs. 'noremap' is always used, Throw error when {key} already exists.

Register expr mapping global or local to buffer.

Unlike :map, space in {lhs} is accepted as part of the {lhs}, keycodes are replaced are usual. 'noremap' and map arguments <silent>, <nowait> are always used.

Register a dynamic insert-mode mapping.

The callback runs at the mapping's execution point and returns literal text and special keys to execute in order. Use option.arglist to pass current editor state without making nested editor requests. The callback must not change text, switch windows, or run :normal while the expression mapping is being evaluated.

Vim cannot guarantee ordering for channel-backed expression results during batched :normal or macro input.

Register local keymap with callback.

Unlike :map, space in {lhs} is accepted as part of the {lhs}, keycodes are replaced are usual. 'noremap' and map arguments <nowait> are always used.

Register for buffer sync objects, created sync object should be disposable and provide optional event handlers:

• onChange called on onDidChangeTextDocument event.
• onTextChange called on line change event from vim.
• onVisible called on WindowVisible event.

The document is always attached and not command line buffer.

Create a FuzzyMatch instance using wasm module. The FuzzyMatch does the same match algorithm as vim's :h matchfuzzypos()

Compute word ranges of opened document in specified range.

Create a FileSystemWatcher instance, when watchman doesn't exist, the returned FileSystemWatcher can still be used, but not work at all.

Find files across all workspace folders in the workspace.

Create persistence Mru instance.

Create Task instance that runs in (neo)vim, no shell.

Create DB instance at extension root.