Merge branch 'dev'

BetterThanTomorrow · Oct 15, 2019 · b715a79 · b715a79
2 parents df0c05a + ace979f
commit b715a79
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/docs/readthedocs/source/customizing.md b/docs/readthedocs/source/customizing.md
@@ -76,4 +76,11 @@ The change would look like this in your `keybindings.json`:
         "command": "paredit.wrapAroundCurly",
         "when": "editorHasSelection && editorTextFocus && !editorReadOnly && editorLangId =~ /clojure|scheme|lisp/ && paredit:keyMap =~ /original|strict/"
     }
+```
+
+## Autolinting
+
+The extension comes with autolinting disabled. This is because you will need to have [Joker](https://github.com/candid82/joker) installed in order for it to work. You will probably want to have Joker installed regardless so, just do it and then enable autolinting by setting:
+```json
+"calva.lintOnSave": true
 ```
diff --git a/docs/readthedocs/source/quirks.md b/docs/readthedocs/source/quirks.md
@@ -4,6 +4,19 @@ Here's a shocker for ya': Calva isn't perfect. 😄
 
 There are quirks and things that flat out do not work. We'll try to collect info about such things here, providing workarounds when available (or, rather, known to us).
 
+## Strange linting errors?
+
+The Joker way of linting is awesome, but has its limitations. If you think the linting reporting is off, it is probably something you should check with the [Joker project](https://github.com/candid82/joker).
+
+That said, this one might be worth a mention here:
+
+### Unrecognized macros
+One thing to note with this linter is that it doesn't do a full scan of all files and does not recognize macros it doesn't know about. Leading to false complaints about `Unable to resolve symbol x`. You might now and then tell it about macros you use. Create a `.joker` file somewhere in the path from the root of your project to where you are using the macro (the project root might be the best choice), and add:
+```clojure
+{:known-macros [some-ns/some-macro some-other-ns/some-other-macro]}
+```
+Read more about Joker's linter mode here: https://github.com/candid82/joker#linter-mode
+
 ## Test features not available with ClojureScript
 
 Currently [`cider-nrepl` does not provide its test functionality for ClojureScript](https://github.com/clojure-emacs/cider-nrepl/issues/555) code. Please consider contributing to fixing that.