Skip to content

Configuration.md

Latest commit

 

History

History
315 lines (255 loc) · 8.58 KB

Configuration.md

File metadata and controls

315 lines (255 loc) · 8.58 KB

Configuration

Client

Start the server from jar or native executable:

java [options] -jar org.eclipse.lemminx.jar
# or
org.eclipse.lemminx [options]

Environment Variables

Environment variables can be used to configure the server. For example:

export HTTP_PROXY_HOST=localhost
java -jar org.eclipse.lemminx.jar
# or
$env:HTTP_PROXY_HOST=localhost
org.eclipse.lemminx.exe -Djdk.xml.maxOccur=20000
  • $HTTP_PROXY_HOST: The hostname of the HTTP proxy server.
  • $HTTP_PROXY_PASSWORD: The password to use for the HTTP proxy.
  • $HTTP_PROXY_PORT: The port number of the HTTP proxy server.
  • $HTTP_PROXY_USER: The user name to use for the HTTP proxy.
  • $LEMMINX_DEBUG: Enable debug logging for Lemminx.

System Properties

System properties are options start with -D. For example:

java -Djdk.xml.maxOccur=20000 -jar org.eclipse.lemminx.jar
# or
org.eclipse.lemminx -Djdk.xml.maxOccur=20000
  • -Dhttp.proxyPassword=<string>: The password to use for the HTTP proxy. Defaults from environment variable HTTP_PROXY_PASSWORD.
  • -Dhttp.proxyUser=<string>: The user name to use for the HTTP proxy. Defaults from environment variable HTTP_PROXY_USER.
  • -Djava.home=<string>: The Java installation directory.
  • -Djava.runtime.name=<string>: The name of the Java Runtime Environment.
  • -Djava.vm.name=<string>: The name of the Java Virtual Machine.
  • -Djava.version=<string>: The version of the Java Runtime Environment.
  • -Djdk.xml.entityExpansionLimit=<integer>: The maximum number of XML entities to expand. Defaults to 64000.
  • -Djdk.xml.maxOccur=<integer>: The maximum number of XML elements to occur. Defaults to 5000.
  • -Dlemminx.workdir=<string>: The working directory for Lemminx. Defaults to {-Duser.home}/.lemminx, {-Duser.dir}/.lemminx or {$PWD}/.lemminx.
  • -Dlog.level=<all|info|warn|error|off>: The logging level. Defaults to info.
  • -Dos.arch=<string>: The operating system architecture.
  • -Dos.name=<string>: The operating system name.
  • -Dos.version=<string>: The operating system version.
  • -Duser.dir=<string>: The user directory.
  • -Duser.home=<string>: The user home directory.
  • -DwatchParentProcess=<boolean>: Whether to watch the parent process for termination. Defaults to true.

Existing Implementations

To see how current implementations of this language server send configurations, refer to VSCode XML.

  1. Go to preferences and set xml.trace.server to verbose
  2. With an XML file open, go to View -> Output -> XML Support (top right drop down menu)
  3. Ctrl + f, and search for 'workspace/didChangeConfiguration'

Settings

Settings for didChangeConfiguration and initializationOptions must follow this JSON format:

"settings": {
  "xml": {
    "trace": {
      "server": "verbose"
    },
    "catalogs": [],
    "logs": {
      "client": true,
      "file": "/home/.../lsp4xml.log"
    },
    "format": {
      "splitAttributes": true,
      "joinCDATALines": false,
      "joinContentLines": false,
      "joinCommentLines": false,
      "spaceBeforeEmptyCloseTag": false,
      "enabled": true
    }
  }
}

Here a sample of JSON request message for "initialize":

{
  "jsonrpc":"2.0",
  "id":"1",
  "method":"initialize",
  "params":{
    "processId":17880,
    "rootPath":"test/",
    "rootUri":"/test/",
    "initializationOptions":{
      "settings":{
        "xml":{
          "trace":{
            "server":"verbose"
          },
          "catalogs":[

          ],
          "logs":{
            "client":true,
            "file":"/home/.../lsp4xml.log"
          },
          "format":{
            "splitAttributes":true,
            "joinCDATALines":false,
            "joinContentLines":false,
            "joinCommentLines":false,
            "spaceBeforeEmptyCloseTag":false,
            "enabled":true
          }
        }
      }
    }
  }
}

Logging

  • Only send 'file' on initialization
{
  ...
  "logs": {
    "client": true,
    "file": "path/to/file"
  }
}
  • client: Should LSP message be sent to the client when logging.
  • file: Path to the file for log messages to be output.

Catalog

{
  "catalogs": [
      "catalog.xml",
      "catalog2.xml"
  ]
}

File Associations

You can associate an XML file pattern with a XML Schema to use. It gives you the capability to benefit with validation and completion based on XML Schema without declaring it in your XML file.

Here a sample which associate the Eclipse file .project file with the XML Schema projectDescription.xsd

{
    "fileAssociations": [{
        "systemId": "C:\\org.eclipse.lsp4xml\\src\\test\\resources\\xsd\\projectDescription.xsd",
        "pattern": ".project"
    }]
}

fileAssociations is an array of association:

  • systemId: file path of the XML Schema, DTD
  • pattern: file name pattern where you can use '*', '?' (it uses Java glob NIO)

With this association, you benefit with validation and completion for file .project

XML File Associations

although it doesn't declare DTD or XMl Schema:

<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
	<name>org.eclipse.lsp4xml</name>
	<comment></comment>
	<projects>
	</projects>
	<buildSpec>
		<buildCommand>
			<name>org.eclipse.jdt.core.javabuilder</name>
			<arguments>
			</arguments>
		</buildCommand>
		<buildCommand>
			<name>org.eclipse.m2e.core.maven2Builder</name>
			<arguments>
			</arguments>
		</buildCommand>
	</buildSpec>
	<natures>
		<nature>org.eclipse.jdt.core.javanature</nature>
		<nature>org.eclipse.m2e.core.maven2Nature</nature>
	</natures>
</projectDescription>

Formatting

Excluded

In the LSP, the following options are given by FormattingOptions so it is not necessary to pass these as configurations

  • insertSpaces: indent using spaces
  • tabSize: amount of spaces to indent by if insertSpaces == true

All Formatting Options

*It is not necessary to include each option, missing options while be set to a default value shown below.

{
  ...
  "format": {
    "enabled": true,
    "splitAttributes": false,
    "joinCDATALines": false,
    "joinCommentLines": false,
    "formatComments": true,
    "joinContentLines": false,
    "spaceBeforeEmptyCloseTag": true
  }
}
  • enabled: is able to format document
  • splitAttributes: each attribute is formatted onto new line
  • joinCDATALines: normalize content inside CDATA
  • joinCommentLines: normalize content inside comments
  • formatComments: keep comment in relative position
  • joinContentLines: normalize content inside elements
  • spaceBeforeEmptyCloseTag: insert whitespace before self closing tag end bracket

Capabilities

If a capability is sent from the client on 'initialize' indicating it
supports 'dynamicRegistration' then the server can support enabling/disabling
of the capability by the following:

  • Note: all dynamicRegistration capabilities are by default, true.
{
  ...
  "capabilities": {
    "formatting": true
  }
}

Supported enabling/disabling:

  • formatting

Completion

  • Note: all completion settings are by default, true.
{
  ...
  "completion": {
    "autoCloseTags": true
  }
}
  • autoCloseTags: When a start tag is typed the closing tag is automatically inserted as well,
    also schema completion will auto close tags if this is enabled.

Caching

Determines if schema's are cached on the system

{
  ...
  "useCache": true
}

Validation

Ability to enable/disable validation.

{
  ...
  "validation": {
    "noGrammar": "hint",
    "enabled": true,
    "schema": true
  }
}
  • noGrammar: The message severity when a document has no associated grammar.
    Values: ["ignore", "hint", "info", "warning", "error"]
  • enabled: True to enable all validation/diagnostics. Else false.
  • schema: True to enable all schema validation/diagnostics. Else false.
⚡