https://github.com/klaaspieter/coc-sourcekit

Swift language server extension using sourcekit-lsp for coc.nvim.
https://github.com/klaaspieter/coc-sourcekit

coc neovim sourcekit sourcekit-lsp swift vim

Last synced: about 1 month ago
JSON representation

Swift language server extension using sourcekit-lsp for coc.nvim.

• Host: GitHub
• URL: https://github.com/klaaspieter/coc-sourcekit
• Owner: klaaspieter
• License: mit
• Archived: true
• Created: 2020-01-09T13:47:03.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-09T11:39:16.000Z (almost 2 years ago)
• Last Synced: 2024-09-18T00:05:05.728Z (about 2 months ago)
• Topics: coc, neovim, sourcekit, sourcekit-lsp, swift, vim
• Language: JavaScript
• Homepage:
• Size: 63.5 KB
• Stars: 73
• Watchers: 4
• Forks: 9
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
⚠️ I no longer use coc and therefore stopped maintaining coc-sourcekit.

# coc-sourcekit

Sourcekit language server extension for [coc].

[coc]: https://github.com/neoclide/coc.nvim

## Install

In vim or neovim, run command:

```sh

:CocInstall coc-sourcekit

```

## Features

See [sourcekit-lsp].

[sourcekit-lsp]: https://github.com/apple/sourcekit-lsp

## Configuration options

|Key|Description|Default|

|----|------------|-----|

|`sourcekit.enable`|Enable sourcekit extension|true|

|`sourcekit.commandPath`|Path to sourcekit-lsp binary|Output of `which sourcekit-lsp`|

|`sourcekit.trace.server`|Trace the communication between coc and the sourcekit language server|

|`sourcekit.sdkPath`|The path to the desired SDK|Nothing|

|`sourcekit.sdk`|The name to the desired SDK to be fetched|Nothing|

|`sourcekit.targetArch`| The name of the target (e.g x86_64-apple-ios13.2-simulator) to generate code |

|`sourcekit.args`|Extra arguments to pass to the lsp|[]|

|`sourcekit.env`|Environment variables to pass to the lsp.|{}|

### Environment Variables

You can configure SourceKit's [logging](https://github.com/apple/sourcekit-lsp/blob/main/Documentation/Development.md#print-sourcekit-logs) and [toolchain path](https://github.com/apple/sourcekit-lsp/blob/main/Documentation/Development.md#selecting-the-toolchain) through `sourcekit.env`:

```json

"sourcekit.env": {

	"SOURCEKIT_TOOLCHAIN_PATH": "/home/USER/swift-DEVELOPMENT-SNAPSHOT-2021-07-30-a-ubuntu20.04/",

	"SOURCEKIT_LOGGING": "3" // verbose logging

}

```

## Development

1. Run `yarn build` or `yarn build:watch`

2. Run `yarn run link:add` to link extension

3. Open a Swift file in vim

To see that it worked use [`:CocOpenLog`].

Alternatively a [`.env`](.env) is provided which allows for tailing the logs outside of vim:

```sh

# In the split/tab you will open vim

source .env

# In another split/tab

tail -f coc.log

```

Or source it [automatically](https://github.com/klaaspieter/dotfiles/blob/5c2c1a6fa1a6f9ccc9031c3dc8de2ea9a3c4fdb0/zshrc#L327-L334).

[`:CocOpenLog`]: https://github.com/neoclide/coc.nvim/blob/db5ffd2ff0d766c2cfbd711898e8a3f5736e038c/doc/coc.txt#L1659

## Acknowledgements

- [josa42] for [coc-go] and [coc-sh]. This repo started out as a copy of [coc-go] and I used [coc-sh] as a reference implementation.

[josa42]: https://github.com/josa42

[coc-go]: https://github.com/josa42/coc-go

[coc-sh]: https://github.com/josa42/coc-sh