Skip to content

Commit 40856a8

Browse files
committed
Update readme
1 parent 4ef8882 commit 40856a8

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,13 @@ Clojure expression static analysis for Lighttable.
55
Uses a cljs port of ['kibit'](https://github.com/jonase/kibit) to statically analyze the contents of a clojure editor. Produces hints using the lt-lint plugin.
66

77
## Notes
8-
This is a really early concept version of this plugin. If you wish to play around with it, a few things to be aware of:
8+
This is a really early concept version of this plugin.
99

10-
1. It's really really slow - but fortunately not "lock up Lighttable while it runs", slow (all analysis is performed in a background thread). However, I would recommend either turning off automatic linting for clojure editors, or increasing the delay the background thread queue doesn't get overwhelmed with clojure linting to do for every keystroke you peform.
10+
If you wish to play around with it, be aware that it's fairly slow - but fortunately _not_ "lock up Lighttable while it runs" slow (all analysis is performed in a set of background thread pools). However, I would recommend either turning off automatic linting for clojure editors, or increasing the delay the background thread queue doesn't get overwhelmed with clojure linting to do for every keystroke you peform.
1111
You can (and should) increase the delay using the following behaviour:
1212
```
1313
[:clojure-linted :lt.plugins.lt-lint/auto-linting-properties true 5000] ;; set to 5s delay - I found that to be enough
1414
```
15-
2. The clojure reader isn't great - since Lighttable is using an old version of cljs (like, really old), we're stuck with using a very hobbled reader to parse text into sexprs. I updated a version from [rewrite-cljs](https://github.com/rundis/rewrite-cljs/), but there may still be some edge cases that cause issues.
16-
17-
3. The messages aren't pretty printed - working on that.
1815

1916
Please, though, have a play, and pull requests are always welcome.
2017

0 commit comments

Comments
 (0)