diff --git a/CHANGELOG.md b/CHANGELOG.md index 3afd462..3583b5a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ ### Bugs Fixed * [#77](https://github.com/clojure-emacs/inf-clojure/pull/77): Fix request "Eval expression:" if arglists return is `nil`. +* [#79](https://github.com/clojure-emacs/inf-clojure/pull/82): Eldoc error when running boot repl. * [#83](https://github.com/clojure-emacs/inf-clojure/pull/85): No such namespace: complete.core in lumo REPL. ## 2.0.0 (2017-05-01) diff --git a/README.md b/README.md index 8d2bab1..bb60fdc 100644 --- a/README.md +++ b/README.md @@ -99,6 +99,26 @@ point. You can, however, change this behaviour by invoking such commands with a prefix argument. For instance: `C-u C-c C-v` will ask for the symbol you want to show the docstring for. +#### Caveats + +Note that if you decide _NOT_ to use the socket repl, it is highly recommended +you disable output coloring and/or readline facilities: `inf-clojure` does not +filter out ASCII escape characters at the moment and will not behave correctly. + +You can disable coloring the following way for `boot`: + +```el +((nil . ((inf-clojure-boot-cmd . "boot repl -C")))) +``` + +For leiningen, there are no command line switches and you need to add a custom [`project.clj` option](https://github.com/technomancy/leiningen/blob/master/sample.project.clj): + +```clojure +... + :repl-options {:color false} +... +``` + ## Configuration options In the time-honoured Emacs tradition `inf-clojure`'s behaviour is extremely diff --git a/inf-clojure.el b/inf-clojure.el index 1bb92e5..f72825f 100644 --- a/inf-clojure.el +++ b/inf-clojure.el @@ -191,7 +191,7 @@ often connecting to a remote REPL process." (define-obsolete-variable-alias 'inf-clojure-program 'inf-clojure-lein-cmd "2.0.0") -(defcustom inf-clojure-boot-cmd "boot repl" +(defcustom inf-clojure-boot-cmd "boot repl -C" "The command used to start a Clojure REPL for Boot projects. Alternatively you can specify a TCP connection cons pair, instead