Skip to content

Commit 9f9fef9

Browse files
authored
(docs) more precise settings docs (#467)
- details on ls-path - make it clear you normally don't set this #463
1 parent 6f49c72 commit 9f9fef9

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

packages/svelte-vscode/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ Provides syntax highlighting and rich intellisense for Svelte components in VS C
77
If you added `"files.associations": {"*.svelte": "html" }` to your VSCode settings, remove it.
88

99
If you have previously installed the old "Svelte" extension by James Birtles, uninstall it:
10-
- Through the UI: You can find it when searching for `@installed` in the extensions window (searching `Svelte` won't work).
11-
- Command line: `code --uninstall-extension JamesBirtles.svelte-vscode`
10+
11+
- Through the UI: You can find it when searching for `@installed` in the extensions window (searching `Svelte` won't work).
12+
- Command line: `code --uninstall-extension JamesBirtles.svelte-vscode`
1213

1314
Do you want to use TypeScript/SCSS/Less/..? [See the docs](/docs/README.md#language-specific-setup).
1415

@@ -50,16 +51,15 @@ More docs and troubleshooting: [See here](/docs/README.md).
5051

5152
Path to the node executable you would like to use to run the language server.
5253
This is useful when you depend on native modules such as node-sass as without
53-
this they will run in the context of vscode, meaning v8 version mismatch is likely.
54+
this they will run in the context of vscode, meaning node version mismatch is likely.
5455

5556
##### `svelte.language-server.ls-path`
5657

57-
Path to the langauge server file (either a relative path from the workspace root or an absolute path).
58-
Can be used to use a custom variant of the language server.
58+
You normally don't set this. Path to the language server executable. If you installed the \"svelte-language-server\" npm package, it's within there at \"bin/server.js\". Path can be either relative to your workspace root or absolute. Set this only if you want to use a custom version of the language server.
5959

6060
##### `svelte.language-server.port`
6161

62-
At which port to spawn the language server.
62+
You normally don't set this. At which port to spawn the language server.
6363
Can be used for attaching to the process for debugging / profiling.
6464
If you experience crashes due to "port already in use", try setting the port.
6565
-1 = default port is used.

packages/svelte-vscode/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,17 @@
4949
"svelte.language-server.runtime": {
5050
"type": "string",
5151
"title": "Language Server Runtime",
52-
"description": "Path to the node executable to use to spawn the language server"
52+
"description": "- You normally don't need this - Path to the node executable to use to spawn the language server. This is useful when you depend on native modules such as node-sass as without this they will run in the context of vscode, meaning node version mismatch is likely."
5353
},
5454
"svelte.language-server.ls-path": {
5555
"type": "string",
5656
"title": "Language Server Path",
57-
"description": "Path to the langauge server file (either a relative path from the workspace root or an absolute path). Can be used to use a custom variant of the language server."
57+
"description": "- You normally don't set this - Path to the language server executable. If you installed the \"svelte-language-server\" npm package, it's within there at \"bin/server.js\". Path can be either relative to your workspace root or absolute. Set this only if you want to use a custom version of the language server."
5858
},
5959
"svelte.language-server.port": {
6060
"type": "number",
6161
"title": "Language Server Port",
62-
"description": "At which port to spawn the language server. Can be used for attaching to the process for debugging / profiling. If you experience crashes due to \"port already in use\", try setting the port. -1 = default port is used.",
62+
"description": "- You normally don't set this - At which port to spawn the language server. Can be used for attaching to the process for debugging / profiling. If you experience crashes due to \"port already in use\", try setting the port. -1 = default port is used.",
6363
"default": -1
6464
},
6565
"svelte.plugin.typescript.enable": {

0 commit comments

Comments
 (0)