Skip to content

Commit e1d381e

Browse files
committed
Add "Troubleshooting" section to README and document new settings
1 parent 1b2c3fa commit e1d381e

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ The method from the [Quickstart section](#Quickstart) utilizes the so-called emb
6060
option in your VSCode settings globally or per-project and connect manually to whichever REPL instance you want by "Clojure: Connect to a running nREPL" command. Note, that in order to make the autocompletion, go to definition, and formatting functionality work you have to write necessary dependencies in your `profiles.clj`. Put the following content to your `~/.lein/profiles.clj` for macOS and Linux:
6161

6262
```clojure
63-
{:user {:plugins [[cider/cider-nrepl "0.22.1"]]
64-
:dependencies [[cljfmt "0.5.7"]]}}
63+
{:user {:plugins [[cider/cider-nrepl "0.24.0"]]
64+
:dependencies [[cljfmt "0.6.7"]]}}
6565
```
6666

6767
Alternatively, you can put the code above to your project `project.clj` file.
@@ -70,12 +70,14 @@ Alternatively, you can put the code above to your project `project.clj` file.
7070

7171
The extension contributes the configuration parameters listed in the table below.
7272

73-
| Parameter | Description |
74-
|--------------------------------|-------------|
75-
|`clojureVSCode.autoStartNRepl` | Whether to start an nREPL when opening a file or project. |
76-
|`clojureVSCode.formatOnSave` | Format files with [cljfmt](https://github.com/weavejester/cljfmt) on save. |
77-
|`clojureVSCode.cljfmtParameters`| Formatting parameters passed to `cljfmt` each time it runs, e.g. `:indentation? true :remove-surrounding-whitespace? false` |
78-
|`clojureVSCode.showResultInline` | Show evaluation result inline. |
73+
| Parameter | Description |
74+
|---------------------------------|-------------|
75+
|`clojureVSCode.autoStartNRepl` | Whether to start an nREPL when opening a file or project. |
76+
|`clojureVSCode.formatOnSave` | Format files with [cljfmt](https://github.com/weavejester/cljfmt) on save. |
77+
|`clojureVSCode.cljfmtParameters` | Formatting parameters passed to `cljfmt` each time it runs, e.g. `:indentation? true :remove-surrounding-whitespace? false` |
78+
|`clojureVSCode.showResultInline` | Show evaluation result inline. |
79+
|`clojureVSCode.ciderNReplVersion`| Version of [CIDER nREPL](https://github.com/clojure-emacs/cider-nrepl) to use for the embedded nREPL. |
80+
|`clojureVSCode.cljfmtVersion` | Version of `cljfmt` to use for formatting Clojure files. |
7981

8082
## ClojureScript Project Setup
8183

@@ -90,6 +92,14 @@ The embedded nREPL **does not** support ClojureScript, consider to use the "cloj
9092

9193
After that you can connect to the nREPL using the "Clojure: Connect to a running nREPL" command. Now you can evaluate you ClojureScript code and use the other extension facilities.
9294

95+
## Troubleshooting
96+
97+
### All kinds of errors on nREPL start
98+
99+
Please check that you're using the latest version of [CIDER nREPL](https://github.com/clojure-emacs/cider-nrepl). The version the extension uses by default updates periodically, but there still can be a mismatch. In order to redefined the `CIDER nREPL` version you can either:
100+
101+
1. Define it in the `~/.lein/profiles.clj` (see the "Manual Configuration" section above).
102+
2. Redefine it with the `clojureVSCode.cljfmtVersion` extension setting.
93103

94104
## How to Contribute
95105

0 commit comments

Comments
 (0)