Skip to content
This repository was archived by the owner on Jun 22, 2024. It is now read-only.

Commit 70e36ed

Browse files
vknabelvknabel
committed
Added tables for all configurations and commands to README
1 parent 9119ec3 commit 70e36ed

File tree

3 files changed

+36
-3
lines changed

3 files changed

+36
-3
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
- Allow lang server restart #82 #85 by @clayreinann
66
- Commands for stop, clean and run #82 #85 by @clayreimann
7+
- Added tables for all configurations and commands to README
78

89
## 2.10.1
910

‎README.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,38 @@ If you prefer using an alternative language server, set set `sde.languageServerM
6060

6161
Though in most cases sourcekit-lsp and sourcekite should produce better results and performance.
6262

63+
## Configuration
64+
65+
| Config | Type | Default | Description |
66+
| ---------------------------------- | ---------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
67+
| `sourcekit-lsp.serverPath` | `string` | | The path of the sourcekit-lsp executable\nIn SDE: defaults to the toolchain's sourcekit-lsp. |
68+
| `sourcekit-lsp.toolchainPath` | `string` | | The path of the swift toolchain.\nIn SDE: defaults to Xcode's default toolchain. |
69+
| `swift.languageServerPath` | `string` | `/usr/local/bin/langserver-swift` | [DEPRECATED] The fully qualified path to the Swift Language Server executable. |
70+
| `swift.path.sourcekite` | `string` | | The fully path to the sourcekite(SDE's LS backend). |
71+
| `swift.path.swift_driver_bin` | `string` | `/usr/bin/swift` | The fully path to the swift driver binary. |
72+
| `swift.path.shell` | `string` | `/bin/sh` | The fully path to the shell binary. |
73+
| `sde.sourcekit.compilerOptions` | `string[]` | `[]` | Optional compiler options like the target or search paths. Will only be used as default. `(debug|release).yaml` builds will override these settings. |
74+
| `swift.targets` | `object[]` | `[]` | If SDE cannot reliably detect all targets, you can manually configure them. |
75+
| `sde.enable` | `boolean` | `true` | Enable SDE functionality |
76+
| `sde.languageServerMode` | `string` | `sourcekite` | Decides which language server should be used. `sourcekite` is the default LSP for SDE, `sourcekit-lsp` is Apple's official one and `langserver` is RLovelett's Langserver. |
77+
| `sde.enableTracing.client` | `boolean` | `false` | Enable tracing output for SDE client |
78+
| `sde.enableTracing.LSPServer` | `boolean` | `false` | Enable tracing output for SDE LS server |
79+
| `sde.buildOnSave` | `boolean` | `true` | Indicates wether SDE shall build the project on save. |
80+
| `sde.swiftBuildingParams` | `string[]` | `["build"]` | The params that shall be passed to the swift command. |
81+
| `swift.diagnosis.max_num_problems` | `number` | `100` | Controls the maximum number of problems produced by the server. NOET: Not used now. |
82+
83+
## Commands
84+
85+
| Title | Command |
86+
| ----------------------- | ------------------------------------ |
87+
| Build Package | `sde.commands.build` |
88+
| Restart Language Server | `sde.commands.restartLanguageServer` |
89+
| Run Default Target | `sde.commands.run` |
90+
| Run Target… | `sde.commands.selectRun` |
91+
| Restart Target | `sde.commands.restartRun` |
92+
| Stop Running Target | `sde.commands.stop` |
93+
| Clean Package | `sde.commands.clean` |
94+
6395
## Contributors
6496

6597
- Valentin Knabel, [@vknabel](https://github.com/vknabel), [twitter](https://twitter.com/vknabel), _maintainer_

‎package.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"url": "https://github.com/vknabel"
99
},
1010
"license": "Apache-2.0",
11-
"version": "2.10.1",
11+
"version": "2.11.0-beta.0",
1212
"publisher": "vknabel",
1313
"icon": "icons/icon.png",
1414
"galleryBanner": {
@@ -117,7 +117,7 @@
117117
"swift.languageServerPath": {
118118
"type": "string",
119119
"default": "/usr/local/bin/langserver-swift",
120-
"description": "The fully qualified path to the Swift Language Server executable."
120+
"description": "[DEPRECATED] The fully qualified path to the Swift Language Server executable."
121121
},
122122
"swift.path.sourcekite": {
123123
"type": "string",
@@ -126,7 +126,7 @@
126126
"swift.path.sourcekiteDockerMode": {
127127
"type": "boolean",
128128
"default": false,
129-
"description": "(Experimental)Enable to run dedicated docker shell command. It is the responsibility of user to guarantee that the docker cmd 'docker run --rm -i jinmingjian/docker-sourcekite' works in your system."
129+
"description": "[DEPRECATED] (Experimental)Enable to run dedicated docker shell command. It is the responsibility of user to guarantee that the docker cmd 'docker run --rm -i jinmingjian/docker-sourcekite' works in your system."
130130
},
131131
"swift.path.swift_driver_bin": {
132132
"type": "string",

0 commit comments

Comments
 (0)