Commit 45d9849d authored by Mark Nauwelaerts's avatar Mark Nauwelaerts
Browse files

doc: extend lspclient documentation

parent 132763e0
......@@ -2285,6 +2285,17 @@ Format the current document or current selection.</para>
</listitem>
</varlistentry>
<varlistentry id="lspclient-quick-fix">
<term><menuchoice>
<guimenu>LSP Client</guimenu>
<guisubmenu>Quick Fix</guisubmenu>
</menuchoice></term>
<listitem>
<para>[textDocument/codeAction, workspace/executeCommand]
Computes and applies a quick fix for a diagnostic on current position (or line).</para>
</listitem>
</varlistentry>
<varlistentry id="lspclient-completion-documentation">
<term><menuchoice>
<guimenu>LSP Client</guimenu>
......@@ -2295,6 +2306,16 @@ Format the current document or current selection.</para>
</listitem>
</varlistentry>
<varlistentry id="lspclient-signature-help">
<term><menuchoice>
<guimenu>LSP Client</guimenu>
<guisubmenu>Enable signature help with auto completion</guisubmenu>
</menuchoice></term>
<listitem>
<para>Also show signature help in the completion list.</para>
</listitem>
</varlistentry>
<varlistentry id="lspclient-declaration-references">
<term><menuchoice>
<guimenu>LSP Client</guimenu>
......@@ -2305,6 +2326,16 @@ Format the current document or current selection.</para>
</listitem>
</varlistentry>
<varlistentry id="lspclient-completion-parens">
<term><menuchoice>
<guimenu>LSP Client</guimenu>
<guisubmenu>Add parentheses upon function completion</guisubmenu>
</menuchoice></term>
<listitem>
<para>Automatically add a pair of parentheses after completion of a function.</para>
</listitem>
</varlistentry>
<varlistentry id="lspclient-show-hover">
<term><menuchoice>
<guimenu>LSP Client</guimenu>
......@@ -2341,6 +2372,16 @@ and so it may not be advisable to have both enabled at the same time.
</listitem>
</varlistentry>
<varlistentry id="lspclient-highlight-goto">
<term><menuchoice>
<guimenu>LSP Client</guimenu>
<guisubmenu>Highlight goto location</guisubmenu>
</menuchoice></term>
<listitem>
<para>Provide a transient visual cue after performing a goto to a location (of definition, declaration, etc).</para>
</listitem>
</varlistentry>
<varlistentry id="lspclient-diagnostics">
<term><menuchoice>
<guimenu>LSP Client</guimenu>
......@@ -2424,9 +2465,9 @@ The plugin's configuration page mostly allows for persistent configuration of
some of the above menu items. However, there is one additional entry
to specify the Server Configuration file. This is a &JSON; file that
can be used to specify the LSP server to start (and then to communicate
with over stdin/stdout). For convenience, the following default configuration
is included (though alternative server implementation are equally valid
and possible):
with over stdin/stdout). For convenience, some default configuration
is included, which can be inspected in the plugin's configuration page.
To aid in the explanation below, an excerpt of that configuration is given here:
</para>
<screen>
......@@ -2457,6 +2498,13 @@ and possible):
"url": "https://github.com/hansec/fortran-language-server",
"highlightingModeRegex": "^Fortran.*$"
},
"javascript": {
"command": ["typescript-language-server", "--stdio"],
"rootIndicationFileNames": ["package.json", "package-lock.json"],
"url": "https://github.com/theia-ide/typescript-language-server",
"highlightingModeRegex": "^JavaScript.*$",
"documentLanguageId": false
},
"latex": {
"command": ["texlab"],
"url": "https://texlab.netlify.com/",
......@@ -2526,15 +2574,16 @@ Various stages of override/merge are applied;
</itemizedlist>
</para>
<para> One server instance is used per (root, servertype) combination. If
"root" is specified as an absolute path, then it used as-is, otherwise it is
relative to the <quote>projectBase</quote> (as determined by the <link
linkend="kate-application-plugin-projects">Project plugin</link>). If not
specified and "rootIndicationFileNames" is an array as filenames, then a parent
directory of current document containing such a file is selected. As a last
fallback, the home directory is selected as "root". For any document, the
resulting "root" then determines whether or not a separate instance is needed.
If so, the "root" is passed as rootUri/rootPath. </para>
<para> One server instance is used per (root, servertype) combination. If "root"
is specified as an absolute path, then it used as-is, otherwise it is relative
to the <quote>projectBase</quote> (as determined by the <link
linkend="kate-application-plugin-projects">Project plugin</link>) if applicable,
or otherwise relative to the document's directory. If not specified and
"rootIndicationFileNames" is an array as filenames, then a parent directory of
current document containing such a file is selected. As a last fallback, the
home directory is selected as "root". For any document, the resulting "root"
then determines whether or not a separate instance is needed. If so, the "root"
is passed as rootUri/rootPath. </para>
<para>
In general, it is recommended to leave root unspecified, as it is not that
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment