Swiftpack.co - Package - ChimeHQ/SwiftLSPClient

Github CI Carthage compatible CocoaPods

SwiftLSPClient

This is a Swift library for interacting with Language Server Protocol implementations.

An LSP server provides rich information about source code. An LSP client consumes this information. This library is all about the client side.

Example

import SwiftLSPClient

let executablePath = "path/to/your/lsp-server-executable"
let host = LanguageServerProcessHost(path: executablePath, arguments: [],
    environemnt: [/* the environment your lsp server requires e.g. PATH */])

host.start { (server) in
    guard let server = server else {
        Swift.print("unable to launch server")
        return
    }

    let processId = Int(ProcessInfo.processInfo.processIdentifier)
    let capabilities = ClientCapabilities(workspace: nil, textDocument: nil, experimental: nil)

    let params = InitializeParams(processId: processId,
                                  rootPath: nil,
                                  rootURI: nil,
                                  initializationOptions: nil,
                                  capabilities: capabilities,
                                  trace: Tracing.off,
                                  workspaceFolders: nil)

    server.initialize(params: params, block: { (result) in
        switch result {
        case .failure(let error):
            Swift.print("unable to initialize \(error)")
        case .success(let value):
            Swift.print("initialized \(value)")
        }
    })
}

Supported Features

The LSP specification is large, and this library currently does not implement it all. The intention is to support the 3.x specification, but be as backwards-compatible as possible with pre-3.0 servers.

| Feature | Supported | | -------------------|:---------:| | window/showMessage | ✅ | | window/showMessageRequest | ✅ | | window/logMessage | ✅ | | telemetry/event | - | | client/registerCapability | - | | client/unregisterCapability | - | | workspace/workspaceFolders | - | | workspace/didChangeWorkspaceFolders | - | | workspace/didChangeConfiguration | - | | workspace/configuration | - | | workspace/didChangeWatchedFiles | - | | workspace/symbol | - | | workspace/executeCommand | - | | workspace/applyEdit | - | | textDocument/didOpen | ✅ | | textDocument/didChange | ✅ | | textDocument/willSave | ✅ | | textDocument/willSaveWaitUntil | ✅ | | textDocument/didSave | ✅ | | textDocument/didClose | ✅ | | textDocument/publishDiagnostics | ✅ | | textDocument/completion | ✅ | | completionItem/resolve | - | | textDocument/hover | ✅ | | textDocument/signatureHelp | ✅ | | textDocument/declaration | ✅ | | textDocument/definition | ✅ | | textDocument/typeDefinition | ✅ | | textDocument/implementation | ✅ | | textDocument/references | ✅ | | textDocument/documentHighlight | - | | textDocument/documentSymbol | ✅ | | textDocument/codeAction | - | | textDocument/codeLens | - | | codeLens/resolve | - | | textDocument/documentLink | - | | documentLink/resolve | - | | textDocument/documentColor | - | | textDocument/colorPresentation | - | | textDocument/formatting | ✅ | | textDocument/rangeFormatting | ✅ | | textDocument/onTypeFormatting | ✅ | | textDocument/rename | - | | textDocument/prepareRename | - | | textDocument/foldingRange | ✅ |

Integration

Swift Package Manager

dependencies: [
    .package(url: "https://github.com/ChimeHQ/SwiftLSPClient.git")
]

Carthage

github "ChimeHQ/SwiftLSPClient"

CocoaPods

pod 'SwiftLSPClient'

Suggestions or Feedback

We'd love to hear from you! Get in touch via twitter, an issue, or a pull request.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Github

link
Stars: 44
Help us keep the lights on

Dependencies

Used By

Total: 1

Releases

0.8.2 - Nov 3, 2019

  • expanded LanguageIdentifier.fileExtensions
  • support for foldingRange

0.8.1 - Oct 31, 2019

  • Includes support for textDocument/references
  • Adds some convenience methods for a few parameter types
  • Resolves a serious thread safety issue with ProtocolTransport

Huge thanks to @johnno1962 for all the work getting these things done!

0.8.0 - Sep 10, 2019

  • Support for the various "go to" source navigation features
  • Improved diagnostic capabilities with LanguageServerError

0.7.1 - Sep 3, 2019

Support for showMessageRequest

0.7.0 - Aug 22, 2019

Support for SwiftPM and Swift 5.0