dls 0.3.1

D Language Server


To use this package, put the following dependency into your project's dependencies section:

dub.json
dub.sdl

This package provides sub packages which can be used individually:

dls:find - D Language Server


D Language Server

LSP compliance: 3.7.0

This is a work in progress...

DLS implements the server side of the Language Server Protocol (LSP) for the D programming language. It does not contain any language feature itself (yet), but uses existing components and provides an interface to work with the LSP. It currently provides:

  • Code completion using DCD
  • Go to definition using DCD
  • Error checking using D-Scanner
  • Formatting using DFMT

Client side configuration

All these keys should be formatted as d.dls.[section].[key] (e.g. d.dls.format.endOfLine).

Section: symbolTypeDefault value
importPathsstring[][]
Section: analysisTypeDefault value
configFilestring"dscanner.ini"
Section: formatTypeDefault value
endOfLine"lf" or "cr" or "crlf""lf"
maxLineLengthnumber120
dfmtAlignSwitchStatementsbooleantrue
dfmtBraceStyle"allman" or "otbs" or "stroustrup""allman"
dfmtOutdentAttributesbooleantrue
dfmtSoftMaxLineLengthnumber80
dfmtSpaceAfterCastbooleantrue
dfmtSpaceAfterKeywordsbooleantrue
dfmtSpaceBeforeFunctionParametersbooleanfalse
dfmtSplitOperatorAtLineEndbooleanfalse
dfmtSelectiveImportSpacebooleantrue
dfmtCompactLabeledStatementsbooleantrue
dfmtTemplateConstraintStyle"conditionalNewlineIndent" or "conditionalNewline" or "alwaysNewline" or "alwaysNewlineIndent""conditionalNewlineIndent"
dfmtSingleTemplateConstraintIndentbooleanfalse

The find subpackage and the update system

In order to simplify the process of updating DLS, an update system is implemented. However, the extension will need to locate a first version of DLS; this is where dls:find comes in. The steps are:

  • dub fetch dls will fetch the latest version of DLS
  • dub run --quiet dls:find will output the directory to its parent DLS package
  • dub build --build=release launched in the just acquired DLS directory will build DLS (notifying the user before and after the build might be a good idea, as it can take several minutes)
  • The dls executable will now be right under the same directory

IMPORTANT: when building DLS on Windows, --arch=x86_mscoff must be added to the arguments for the build to succeed.

After this, the Language Client has to listen to the dls/updatedPath notification. This notification, sent by the server after every update, will be the path to the new DLS executable. Otherwise nothing specific is required on the client's part regarding updates: the server will send notifications to the user when an update is available, and build its next version in parallel to responding to requests.

Caveats

The server may delegate a few operations to the client-side extension depending on the language client's capabilities. The client should watch these files for the server to work properly:

  • dub.selections.json
  • dub.json
  • dub.sdl
  • *.ini

If the client supports dynamic registration of the workspace/didChangeWatchedFiles method, then the server will automatically register file watching. If the client doesn't support dynamic registration however, the client-side extension will need to manually do it. The server needs to know at least when dub.selections.json files change to properly provide completion support. If dub.json and dub.sdl are also watched, dub.selections.json will automatically be regenerated and then it will be used for completion support. Watching *.ini allows DLS to monitor D-Scanner config files, even if the name is changed in the config and isn't precisly dscanner.ini.

As support for messages regarding workspace folders are not yet supported in Visual Studio Code (used for testing the server), dls also lacks support for multiple workspace folders for now.

Example usage

I made a VSCode extension and an atom package using DLS:

  • https://github.com/LaurentTreguier/vscode-dls
  • https://github.com/LaurentTreguier/ide-dlang
Authors:
Laurent Tréguier
Sub packages:
dls:find
Dependencies:
dcd, dub, dfmt, inifiled, dscanner
Versions:
0.3.1 2018-Apr-08
0.3.0 2018-Apr-07
0.2.1 2018-Mar-31
0.2.0 2018-Mar-31
0.1.5 2018-Mar-26
Show all 11 versions
Download Stats:
  • 1 downloads today

  • 8 downloads this week

  • 79 downloads this month

  • 79 downloads total

Score:
1.3