https://github.com/codeface-io/lspservicekit

Talk to LSPService in Swift
https://github.com/codeface-io/lspservicekit

language-server language-server-protocol lsp lspservice swift websocket

Last synced: 3 months ago
JSON representation

Talk to LSPService in Swift

• Host: GitHub
• URL: https://github.com/codeface-io/lspservicekit
• Owner: codeface-io
• License: mit
• Created: 2021-07-18T17:21:15.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-06-28T16:38:52.000Z (over 1 year ago)
• Last Synced: 2024-11-17T17:36:58.412Z (3 months ago)
• Topics: language-server, language-server-protocol, lsp, lspservice, swift, websocket
• Language: Swift
• Homepage:
• Size: 2.83 MB
• Stars: 7
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# LSPServiceKit

[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fcodeface-io%2FLSPServiceKit%2Fbadge%3Ftype%3Dswift-versions&style=flat-square)](https://swiftpackageindex.com/codeface-io/LSPServiceKit)  [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fcodeface-io%2FLSPServiceKit%2Fbadge%3Ftype%3Dplatforms&style=flat-square)](https://swiftpackageindex.com/codeface-io/LSPServiceKit)  [![](https://img.shields.io/badge/Documentation-DocC-blue.svg?style=flat-square)](https://swiftpackageindex.com/codeface-io/LSPServiceKit/documentation)  [![](https://img.shields.io/badge/License-MIT-lightgrey.svg?style=flat-square)](LICENSE)

👩🏻‍🚀 *This project [is still a tad experimental](#development-status). Contributors and pioneers welcome!*

## What?

LSPServiceKit helps Swift apps use [LSPService](https://github.com/codeface-io/LSPService):

![Context](Documentation/Context_Diagram_dark.png#gh-dark-mode-only)

![Context](Documentation/Context_Diagram_light.png#gh-light-mode-only)

## How?

### Get an LSP Server

`LSPService` precisely reflects the LSPService API, so the first call here translates to a websocket connection request on `http://127.0.0.1:8080/lspservice/api/language/Swift/websocket`:

```swift

// Connect to Swift LSP websocket

let webSocketConnection = try LSPService.api.language("Swift").websocket.connectToLSPWebSocket()

// Create "server" with websocket connection

let server = LSP.Server(connection: webSocketConnection, languageName: "Swift")

```

Or quicker:

```swift

let server = try LSPService.connectToLSPServer(forLanguageNamed: "Swift")

```

Now, you'd probably wanna set the server's three handlers:

```swift

await server.handleNotificationFromServer { notification in

    // handle notification

}

            

await server.handleErrorOutputFromServer { errorOutput in

    // handle errorOutput

}

await server.handleConnectionShutdown { error in

    // handle error

}

```

### Initialize an LSP Server

```swift

// Initialize server with codebase folder

_ = try await server.request(.initialize(folder: codebaseFolderURL))

// Notify server that we are initialized

try await server.notify(.initialized)

```

### Use LSP.ServerManager

All the above can be achieved quicker:

```swift

// Locate the codebase

let codebase = LSP.CodebaseLocation(folder: codebaseFolderURL,

                                    languageName: "Swift",

                                    codeFileEndings: ["swift"])

// Create and initialize the LSP server

let server = try await LSP.ServerManager.shared.initializeServer(for: codebase)

```

## Architecture

Here is the internal architecture (composition and essential dependencies) of the code folder:

![](Documentation/architecture.png)

The above image was generated with the [Codeface](https://codeface.io) app.

## Development Status

From version/tag 0.1.0 on, LSPServiceKit adheres to [semantic versioning](https://semver.org). So until it has reached 1.0.0, its API may still break frequently, but this will be expressed in version bumps.

LSPServiceKit is already being used in production, but [Codeface](https://codeface.io) is still its primary client. LSPServiceKit will move to version 1.0.0 as soon as its basic practicality and conceptual soundness have been validated by serving multiple real-world clients.