Skip to content

Commit

Permalink
fix(doc): doc highlights on neovim 0.10.5
Browse files Browse the repository at this point in the history
  • Loading branch information
chemzqm committed Feb 22, 2025
1 parent 9b7516f commit ed73d1d
Show file tree
Hide file tree
Showing 3 changed files with 147 additions and 149 deletions.
24 changes: 12 additions & 12 deletions doc/coc-api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ folder. With code:
`init` and `complete` are required functions for vim sources, error message
will be shown when not exists.

Source option:~
Source option: ~

The source option object is returned by `coc#source#{name}#init`
function, available properties:
Expand All @@ -68,7 +68,7 @@ Source option:~

All options are optional.

Source configurations:~
Source configurations: ~

Vim sources register |coc-configuration| for allow the user to customize the
source behavior.
Expand All @@ -81,7 +81,7 @@ Source configurations:~
`coc.source.${name}.shortcut` Default to "shortcut" of source option.
`coc.source.${name}.filetypes` Default to "filetypes" of source option.

Complete function:~
Complete function: ~

The complete function is called with complete option as the first argument
and a callback function as the second argument, the callback function should
Expand Down Expand Up @@ -127,7 +127,7 @@ Complete function:~

Only the "word" property is mandatory for complete items.

Optional functions:~
Optional functions: ~

The vim source could provide some optional functions which would be invoked
by coc.nvim:
Expand Down Expand Up @@ -165,7 +165,7 @@ coc.nvim, for example:
When `exports.deactivate` is exported from the JavaScript entry file as a
function, it would be called on extension deactivate.

Limitation of extension context:~
Limitation of extension context: ~

Some methods/properties provided by NodeJS can't be used inside extension
context, including:
Expand Down Expand Up @@ -332,11 +332,11 @@ To manually create an extension, follow these step:
Recommended steps:

• Install types of NodeJS and coc.nvim by terminal command
`npm install @types/node@16.18 coc.nvim` in extension folder.
`npm install @types/node@latest coc.nvim` in extension folder.
• Bundle the javascript files when using multiple node dependencies by
esbuild to save the time of installation. A typical build script looks
like:
>
like: >
async function start() {
await require('esbuild').build({
entryPoints: ['src/index.ts'],
Expand All @@ -358,7 +358,7 @@ Recommended steps:
------------------------------------------------------------------------------
DEBUG EXTENSIONS *coc-api-debug*

Uncaught errors:~
Uncaught errors: ~

When an uncaught error raised on the NodeJS process, the error message would
be send to vim through stderr, and echoed by vim (unless
Expand All @@ -371,7 +371,7 @@ When error happens on the vim side, the promise would be rejected when sending
request to vim, for notifications, vim would send `nvim_error_event` to the
NodeJS process, and the node-client would create error log for it.

Use the log file:~
Use the log file: ~

• Configure `NVIM_COC_LOG_LEVEL` to `trace` in vimrc:
`let $NVIM_COC_LOG_LEVEL='trace'`
Expand All @@ -382,7 +382,7 @@ Use the log file:~
code and compile the extension when needed.
• Tail the log file by `tail` command and make the issue happen.

Add source map support:~
Add source map support: ~

When the javascript code is bundled by esbuild, it would be useful to have
correct source map support for the error stack.
Expand All @@ -396,7 +396,7 @@ correct source map support for the error stack.

Note: the source-map-support module slows down the coc.nvim initialization.

Debug javascript code in chrome:~
Debug javascript code with chrome: ~

• Add `let g:coc_node_args = ['--nolazy', '--inspect-brk=5858']`
• Open vim and you will get the error message indicate that the debugger is
Expand Down
68 changes: 34 additions & 34 deletions doc/coc-config.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ CORE FEATURES
Configurations of builtin features.

------------------------------------------------------------------------------
Workspace~
WORKSPACE
*coc-config-workspace*
"workspace.rootPatterns" *coc-config-workspace-rootPatterns*

Expand Down Expand Up @@ -104,7 +104,7 @@ Workspace~
Scope: `application`, default: `true`

------------------------------------------------------------------------------
Extensions~
EXTENSIONS
*coc-config-extensions*
"extensions.updateCheck" *coc-config-extensions-updateCheck*

Expand All @@ -126,7 +126,7 @@ Extensions~
Scope: `application`, default: `false`

------------------------------------------------------------------------------
Preferences~
PREFERENCES
*coc-config-preferences*
"coc.preferences.bracketEnterImprove" *coc-preferences-bracketEnterImprove*

Expand Down Expand Up @@ -276,7 +276,7 @@ Preferences~
Scope: `application`, default: `0`

------------------------------------------------------------------------------
FloatFactory~
FLOATfACTORY
*coc-config-floatFactory*
"floatFactory.floatConfig" *coc-config-floatFactory-floatConfig*

Expand All @@ -288,7 +288,7 @@ FloatFactory~


------------------------------------------------------------------------------
Float configuration~
FLOAT CONFIGURATION
*coc-config-float*

Used by `floatFactory.floatConfig`, `suggest.floatConfig`,
Expand Down Expand Up @@ -327,7 +327,7 @@ following properties are supported:
Takes precedence over `left` if both are set."

------------------------------------------------------------------------------
Tree~
TREE
*coc-config-tree*

Configurations for tree view.
Expand Down Expand Up @@ -400,7 +400,7 @@ Configurations for tree view.
Scope: `application`, default: `"<space>"`

------------------------------------------------------------------------------
Dialog~
DIALOG
*coc-config-dialog*
Configurations for dialog windows.

Expand Down Expand Up @@ -464,7 +464,7 @@ Configurations for dialog windows.
Scope: `application`, default: `"MoreMsg"`

------------------------------------------------------------------------------
Http proxy~
HTTP PROXY
*coc-config-http*

Configurations for http requests, used by coc.nvim and some coc extensions.
Expand Down Expand Up @@ -497,7 +497,7 @@ Configurations for http requests, used by coc.nvim and some coc extensions.
Scope: `application`, default: `true`

------------------------------------------------------------------------------
Npm~
NPM
*coc-config-npm*
"npm.binPath" *coc-config-npm-binPath*

Expand All @@ -507,7 +507,7 @@ Npm~
Scope: `application`, default: `"npm"`

------------------------------------------------------------------------------
Languageserver~
LANGUAGESERVER
*coc-config-languageserver*

Dictionary of Language Servers, key is the ID of corresponding server,
Expand Down Expand Up @@ -561,8 +561,8 @@ Languageserver~
this languageserver.

- "disabledFeatures": Disable features for this languageserver,
valid keys:
>
valid keys: >
["completion", "configuration", "workspaceFolders", "diagnostics",
"willSave", "willSaveUntil", "didSaveTextDocument",
"fileSystemWatcher", "hover", "signatureHelp", "definition",
Expand All @@ -583,7 +583,7 @@ Languageserver~
- "progressOnInitialization": Enable progress report on languageserver
initialize.

Language server start with command:~
Language server start with command: ~

Additional fields can be used for a command languageserver:

Expand All @@ -596,7 +596,7 @@ Language server start with command:~

- "shell": Use shell for server process, default: `false`

Language server start with module:~
Language server start with module: ~

Additional fields can be used for a languageserver started by node
module:
Expand All @@ -616,7 +616,7 @@ Language server start with module:~

- "transportPort": Port number used when transport is 'socket'.

Language server use initialized socket server:~
Language server use initialized socket server: ~

- "port": Port number of socket server.

Expand All @@ -631,7 +631,7 @@ Configurations for features provided by language server.

------------------------------------------------------------------------------

CallHierarchy~
CALLHIERARCHY
*coc-config-callHierarchy*
"callHierarchy.enableTooltip" *coc-config-callHierarchy-enableTooltip*

Expand All @@ -652,7 +652,7 @@ CallHierarchy~
Scope: `application`, default: `"botright 30vs"`

------------------------------------------------------------------------------
CodeLens~
CODELENS
*coc-config-codeLens*
"codeLens.enable" *coc-config-codeLens-enable*

Expand Down Expand Up @@ -685,7 +685,7 @@ CodeLens~
Scope: `resource`, default: `" | "`

------------------------------------------------------------------------------
Colors~
COLORS
*coc-config-colors*
"colors.enable" *coc-config-colors-enable*

Expand All @@ -701,7 +701,7 @@ Colors~
Scope: `application`, default: `1000`

------------------------------------------------------------------------------
Cursors~
CURSORS
*coc-config-cursors*
"cursors.cancelKey" *coc-config-cursors-cancelKey*

Expand All @@ -728,7 +728,7 @@ Cursors~
Scope: `application`, default: `true`

------------------------------------------------------------------------------
Diagnostic~
DIAGNOSTIC
*coc-config-diagnostic*
"diagnostic.autoRefresh" *coc-config-diagnostic-autoRefresh*

Expand Down Expand Up @@ -972,7 +972,7 @@ Diagnostic~
Scope: `language-overridable`, default: `true`

------------------------------------------------------------------------------
DocumentHighlight~
DOCUMENTHIGHLIGHT
*coc-config-documentHighlight*
"documentHighlight.priority" *coc-config-documentHighlight-priority*

Expand All @@ -994,7 +994,7 @@ DocumentHighlight~
Scope: `resource`, default: `300`

------------------------------------------------------------------------------
Hover~
HOVER
*coc-config-hover*
"hover.autoHide" *coc-config-hover-autoHide*

Expand Down Expand Up @@ -1023,7 +1023,7 @@ Hover~
Scope: `resource`, default: `float`

------------------------------------------------------------------------------
InlayHint~
INLAYHINT
*coc-config-inlayHint*
"inlayHint.enable" *coc-config-inlayHint-enable*

Expand Down Expand Up @@ -1056,7 +1056,7 @@ InlayHint~
Scope: `language-overridable`, default: `inline`

------------------------------------------------------------------------------
Links~
LINK
*coc-config-links*
"links.enable" *coc-config-links-enable*

Expand All @@ -1077,7 +1077,7 @@ Links~
Scope: `application`, default: `false`

------------------------------------------------------------------------------
List~
LIST
*coc-config-list*
"list.alignColumns" *coc-config-list-alignColumns*

Expand Down Expand Up @@ -1233,7 +1233,7 @@ List~
Scope: `application`.

------------------------------------------------------------------------------
Notification~
NOTIFICATION
*coc-config-notification*
"notification.border" *coc-config-notification-border*

Expand Down Expand Up @@ -1302,7 +1302,7 @@ Notification~
Scope: `application`, default: `30`

------------------------------------------------------------------------------
Outline~
OUTLINE
*coc-config-outline*
"outline.autoPreview" *coc-config-outline-autoPreview*

Expand Down Expand Up @@ -1429,7 +1429,7 @@ Outline~
Scope: `application`, default: `"p"`

------------------------------------------------------------------------------
PullDiagnostic~
PULLDIAGNOSTIC
*coc-config-pullDiagnostic*
"pullDiagnostic.ignored" *coc-config-pullDiagnostic-ignored*

Expand Down Expand Up @@ -1457,7 +1457,7 @@ PullDiagnostic~
Scope: `application`, default: `true`

------------------------------------------------------------------------------
Refactor~
REFACTOR
*coc-config-refactor*
"refactor.afterContext" *coc-config-refactor-afterContext*

Expand Down Expand Up @@ -1491,7 +1491,7 @@ Refactor~
Scope: `application`, default: `"<Tab>"`

------------------------------------------------------------------------------
SemanticTokens~
SEMANTICTOKENS
*coc-config-semanticTokens*
"semanticTokens.combinedModifiers" *coc-config-semanticTokens-combinedModifiers*

Expand Down Expand Up @@ -1520,7 +1520,7 @@ SemanticTokens~
Scope: `language-overridable`, default: `["variable","string","parameter"]`

------------------------------------------------------------------------------
Signature~
SIGNATURE
*coc-config-signature*
"signature.enable" *coc-config-signature-enable*

Expand Down Expand Up @@ -1561,7 +1561,7 @@ Signature~
Scope: `language-overridable`, default: `500`

------------------------------------------------------------------------------
Snippet~
SNIPPET
*coc-config-snippet*
"snippet.highlight" *coc-config-snippet-highlight*

Expand All @@ -1584,7 +1584,7 @@ Snippet~
Scope: `application`, default: `"SNIP"`

------------------------------------------------------------------------------
Suggest~
SUGGEST
*coc-config-suggest*
"suggest.acceptSuggestionOnCommitCharacter" *coc-config-suggest-acceptSuggestionOnCommitCharacter*

Expand Down Expand Up @@ -1872,7 +1872,7 @@ Suggest~
Scope: `application`, default: `false`

------------------------------------------------------------------------------
TypeHierarchy~
TYPEHIERARCHY
*coc-config-typeHierarchy*
"typeHierarchy.enableTooltip" *coc-config-typeHierarchy-enableTooltip*

Expand Down
Loading

0 comments on commit ed73d1d

Please sign in to comment.