Merge branch 'clojure-emacs:master' into fix-remote-enrich-classpath-init

caadr · web-flow · commit 9808235e2de7 · 2024-12-19T17:18:07.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,14 +2,20 @@
 
 ## master (unreleased)
 
+## 1.16.1 (2024-12-03)
+
 ### Changes
 
+- Bump the injected `cider-nrepl` to [0.50.3](https://github.com/clojure-emacs/cider-nrepl/blob/master/CHANGELOG.md#0503-2024-12-02).
+- [#3753](https://github.com/clojure-emacs/cider/pull/3753): Add `cider-log-show-frameworks` command to show available log frameworks in a buffer.
 - [#3746](https://github.com/clojure-emacs/cider/issues/3746): Bring back `cider` completion style for activating backend-driven completion.
 
 ### Bugs fixed
 
-- [#3742](https://github.com/clojure-emacs/cider/issues/3742): Restore syntax highlighting in result minibuffer.
-- [#3747](https://github.com/clojure-emacs/cider/issues/3747): Fix errors when docstring is nil.
+- [#3742](https://github.com/clojure-emacs/cider/issues/3742): Restore syntax highlighting of result in the minibuffer.
+- [#3747](https://github.com/clojure-emacs/cider/issues/3747): Fix errors when docstring is `nil`.
+- [#3757](https://github.com/clojure-emacs/cider/issues/3757): Fix inspector's `def-current-value` selecting wrong REPL when multiple are connected.
+- [#3754](https://github.com/clojure-emacs/cider/issues/3754): Fix regex in `cider-ns-from-p`.
 
 ## 1.16.0 (2024-09-24)
 
diff --git a/cider-client.el b/cider-client.el
@@ -108,7 +108,7 @@ EVAL-BUFFER is the buffer where the spinner was started."
 ;;; Evaluation helpers
 (defun cider-ns-form-p (form)
   "Check if FORM is an ns form."
-  (string-match-p "^[[:space:]]*\(ns\\([[:space:]]*$\\|[[:space:]]+\\)" form))
+  (string-match-p "\\`[[:space:]]*\(ns\\([[:space:]]*$\\|[[:space:]]+\\)" form))
 
 (defun cider-ns-from-form (ns-form)
   "Get ns substring from NS-FORM."
diff --git a/cider-inspector.el b/cider-inspector.el
@@ -388,7 +388,6 @@ current-namespace."
   (interactive (let ((ns (cider-current-ns)))
                  (list (cider-inspector--read-var-name-from-user ns)
                        ns)))
-  (setq cider-inspector--current-repl (cider-current-repl))
   (when-let* ((result (cider-sync-request:inspect-def-current-val ns var-name 'v2)))
     (cider-inspector--render-value result 'v2)
     (message "Defined current inspector value as #'%s/%s" ns var-name)))
diff --git a/cider-log.el b/cider-log.el
@@ -48,6 +48,20 @@ Example values: \"Logback\", \"Timbre\"."
   :safe #'stringp
   :type 'string)
 
+(defcustom cider-log-frameworks-buffer "*cider-log-frameworks*"
+  "The name of the log frameworks popup buffer."
+  :group 'cider
+  :package-version '(cider . "1.17")
+  :safe #'stringp
+  :type 'string)
+
+(defcustom cider-log-auto-select-frameworks-buffer t
+  "Whether to auto-select the log frameworks popup buffer."
+  :group 'cider
+  :package-version '(cider . "1.17")
+  :safe #'booleanp
+  :type 'boolean)
+
 (defcustom cider-log-appender-id "cider-log"
   "The name of the default log appender."
   :group 'cider
@@ -1032,6 +1046,26 @@ the CIDER Inspector and the CIDER stacktrace mode.
 
 ;; Framework actions
 
+(transient-define-suffix cider-log-show-frameworks ()
+  "Show the available log frameworks in a buffer."
+  :description "Show frameworks in a buffer"
+  (interactive)
+  (let ((frameworks (cider-sync-request:log-frameworks)))
+    (with-current-buffer (cider-popup-buffer cider-log-frameworks-buffer
+                                             cider-log-auto-select-frameworks-buffer)
+      (read-only-mode -1)
+      (insert (with-temp-buffer
+                (insert (propertize (cider-propertize "Cider Log Frameworks" 'ns) 'ns t) "\n\n")
+                (dolist (framework frameworks)
+                  (insert (propertize (cider-propertize (cider-log-framework-name framework) 'ns) 'ns t) "\n\n")
+                  (insert (format "  Website ......... %s\n" (cider-log-framework-website-url framework)))
+                  (insert (format "  Javadocs ........ %s\n" (cider-log-framework-javadoc-url framework)))
+                  (insert (format "  Levels .......... %s\n" (string-join (cider-log-framework-level-names framework) ", ")))
+                  (newline))
+                (buffer-string)))
+      (read-only-mode 1)
+      (goto-char (point-min)))))
+
 (transient-define-suffix cider-log-browse-javadocs (framework)
   "Browse the Javadoc of the log FRAMEWORK."
   :description "Browse Java documentation"
@@ -1220,6 +1254,7 @@ the CIDER Inspector and the CIDER stacktrace mode.
 (transient-define-prefix cider-log-framework (framework)
   "Show the Cider log framework menu."
   [["Cider Log Framework\n\nActions:"
+    ("a" cider-log-show-frameworks)
     ("b" cider-log-set-buffer)
     ("j" cider-log-browse-javadocs)
     ("s" cider-log-set-framework)
@@ -1441,6 +1476,7 @@ based on `transient-mode'."
 (transient-define-prefix cider-log (framework appender)
   "Show the Cider log menu."
   [["Framework Actions"
+    ("fa" cider-log-show-frameworks)
     ("fs" cider-log-set-framework)
     ("fb" cider-log-set-buffer)
     ("fj" cider-log-browse-javadocs)
diff --git a/cider.el b/cider.el
@@ -11,7 +11,7 @@
 ;;         Steve Purcell <steve@sanityinc.com>
 ;; Maintainer: Bozhidar Batsov <bozhidar@batsov.dev>
 ;; URL: https://www.github.com/clojure-emacs/cider
-;; Version: 1.16.0
+;; Version: 1.16.1
 ;; Package-Requires: ((emacs "26") (clojure-mode "5.19") (parseedn "1.2.1") (queue "0.2") (spinner "1.7") (seq "2.22") (sesman "0.3.2") (transient "0.4.1"))
 ;; Keywords: languages, clojure, cider
 
@@ -93,7 +93,7 @@
 (require 'sesman)
 (require 'package)
 
-(defconst cider-version "1.16.0"
+(defconst cider-version "1.16.1"
   "The current version of CIDER.")
 
 (defconst cider-codename "Kherson"
@@ -591,7 +591,7 @@ the artifact.")
 
 Used when `cider-jack-in-auto-inject-clojure' is set to `latest'.")
 
-(defconst cider-required-middleware-version "0.50.2"
+(defconst cider-required-middleware-version "0.50.3"
   "The CIDER nREPL version that's known to work properly with CIDER.")
 
 (defcustom cider-injected-middleware-version cider-required-middleware-version
diff --git a/dev/docker-sample-project/project.clj b/dev/docker-sample-project/project.clj
@@ -2,4 +2,4 @@
   :dependencies [[org.clojure/clojure "1.11.1"]
                  [clj-http "3.12.3"]]
   :source-paths ["src"]
-  :plugins [[cider/cider-nrepl "0.50.2"]])
+  :plugins [[cider/cider-nrepl "0.50.3"]])
diff --git a/dev/tramp-sample-project/project.clj b/dev/tramp-sample-project/project.clj
@@ -2,5 +2,5 @@
   :dependencies [[org.clojure/clojure "1.11.1"]
                  [clj-http "3.12.3"]]
   :source-paths ["src"]
-  :plugins [[cider/cider-nrepl "0.50.2"]
+  :plugins [[cider/cider-nrepl "0.50.3"]
             [refactor-nrepl "3.9.0"]])
diff --git a/doc/modules/ROOT/pages/basics/middleware_setup.adoc b/doc/modules/ROOT/pages/basics/middleware_setup.adoc
@@ -32,14 +32,14 @@ Use the convenient plugin for defaults, either in your project's
 
 [source,clojure]
 ----
-:plugins [[cider/cider-nrepl "0.50.2"]]
+:plugins [[cider/cider-nrepl "0.50.3"]]
 ----
 
 A minimal `profiles.clj` for CIDER would be:
 
 [source,clojure]
 ----
-{:repl {:plugins [[cider/cider-nrepl "0.50.2"]]}}
+{:repl {:plugins [[cider/cider-nrepl "0.50.3"]]}}
 ----
 
 WARNING: Be careful not to place this in the `:user` profile, as this way CIDER's
@@ -59,7 +59,7 @@ all of their projects using a `~/.boot/profile.boot` file like so:
 (require 'boot.repl)
 
 (swap! boot.repl/*default-dependencies*
-       concat '[[cider/cider-nrepl "0.50.2"]])
+       concat '[[cider/cider-nrepl "0.50.3"]])
 
 (swap! boot.repl/*default-middleware*
        conj 'cider.nrepl/cider-middleware)
@@ -76,11 +76,11 @@ run `cider-connect` or `cider-connect-cljs`.
 
 [source,clojure]
 ----
-  :cider-clj {:extra-deps {cider/cider-nrepl {:mvn/version "0.50.2"}}
+  :cider-clj {:extra-deps {cider/cider-nrepl {:mvn/version "0.50.3"}}
               :main-opts ["-m" "nrepl.cmdline" "--middleware" "[cider.nrepl/cider-middleware]"]}
 
   :cider-cljs {:extra-deps {org.clojure/clojurescript {:mvn/version "1.10.339"}
-                            cider/cider-nrepl {:mvn/version "0.50.2"}
+                            cider/cider-nrepl {:mvn/version "0.50.3"}
                             cider/piggieback {:mvn/version "0.5.3"}}
                :main-opts ["-m" "nrepl.cmdline" "--middleware"
                            "[cider.nrepl/cider-middleware,cider.piggieback/wrap-cljs-repl]"]}
@@ -99,7 +99,7 @@ NOTE: Make sure you're using https://github.com/clojurephant/clojurephant[Clojur
 ----
 dependencies {
   devImplementation 'nrepl:nrepl:0.9.0'
-  devImplementation 'cider:cider-nrepl:0.50.2'
+  devImplementation 'cider:cider-nrepl:0.50.3'
 }
 
 tasks.named('clojureRepl') {
diff --git a/doc/modules/ROOT/pages/basics/up_and_running.adoc b/doc/modules/ROOT/pages/basics/up_and_running.adoc
@@ -73,7 +73,7 @@ simple - CIDER simply passes the extra dependencies and nREPL configuration to
 your build tool in the command it runs to start the nREPL server. Here's how
 this looks for `tools.deps`:
 
-  $ clojure -Sdeps '{:deps {nrepl {:mvn/version "1.3.0"} cider/cider-nrepl {:mvn/version "0.50.2"}}}' -m nrepl.cmdline --middleware '["cider.nrepl/cider-middleware"]'
+  $ clojure -Sdeps '{:deps {nrepl {:mvn/version "1.3.0"} cider/cider-nrepl {:mvn/version "0.50.3"}}}' -m nrepl.cmdline --middleware '["cider.nrepl/cider-middleware"]'
 
 TIP: If you don't want `cider-jack-in` to inject dependencies automatically, set
 `cider-inject-dependencies-at-jack-in` to `nil`. Note that you'll have to setup
@@ -350,7 +350,7 @@ It is also possible for plain `clj`, although the command is somewhat longer:
 
 [source,sh]
 ----
-$ clj -Sdeps '{:deps {cider/cider-nrepl {:mvn/version "0.50.2"}}}' -m nrepl.cmdline --middleware "[cider.nrepl/cider-middleware]"
+$ clj -Sdeps '{:deps {cider/cider-nrepl {:mvn/version "0.50.3"}}}' -m nrepl.cmdline --middleware "[cider.nrepl/cider-middleware]"
 ----
 
 Alternatively, you can start nREPL either manually or using the facilities
diff --git a/doc/modules/ROOT/pages/cljs/shadow-cljs.adoc b/doc/modules/ROOT/pages/cljs/shadow-cljs.adoc
@@ -62,7 +62,7 @@ And connect to it with `cider-connect`.
 ...For that to work, `shadow-cljs.edn` contents like the following are assumed:
 
 ```clj
- :dependencies [[cider/cider-nrepl "0.50.2"] ;; mandatory (unless it's inherited from deps.edn or otherwise present in the classpath of shadow-cljs's JVM process)
+ :dependencies [[cider/cider-nrepl "0.50.3"] ;; mandatory (unless it's inherited from deps.edn or otherwise present in the classpath of shadow-cljs's JVM process)
                 [refactor-nrepl/refactor-nrepl "3.9.0"]] ;; refactor-nrepl is optional
 
  :nrepl {:middleware [cider.nrepl/cider-middleware ;; it's advisable to explicitly add this middleware. It's automatically added by shadow-cljs (if available in the classpath), unless `:nrepl {:cider false}`
diff --git a/doc/modules/ROOT/pages/cljs/up_and_running.adoc b/doc/modules/ROOT/pages/cljs/up_and_running.adoc
@@ -61,7 +61,7 @@ or in `build.gradle`:
 ----
 dependencies {
   devImplementation 'nrepl:nrepl:1.3.0'
-  devImplementation 'cider:cider-nrepl:0.50.2'
+  devImplementation 'cider:cider-nrepl:0.50.3'
   devImplementation 'cider:cider-piggieback:0.5.3'
 }
 
diff --git a/doc/modules/ROOT/pages/debugging/logging.adoc b/doc/modules/ROOT/pages/debugging/logging.adoc
@@ -49,6 +49,7 @@ Its usage is mostly self-describing, since each command has its keybinding attac
 
 To use CIDER Log Mode, there two main ways to get started:
 
+* `M-x cider-log-show-frameworks`, to see the available logging frameworks. If your logging framework is supported but not shown, see the troubleshooting section.
 * `M-x cider-log-event`, which uses transient-mode and will not immediately show the logs (you should use transient-mode to show the `+*cider-log*+` buffer)
 * `M-x cider-log-show` is a newer function that intends to be an "all-in-one" command, intended for a streamlined experience, which can be useful to get started, or for casual usage.
 ** It doesn't use transient-mode - it aims to do everything in one step
@@ -178,6 +179,10 @@ or Clojure CLI aliases.
 |===
 | Command | Keyboard shortcut | Description
 
+| `cider-log-show-frameworks`
+| kbd:[C-c M-l f a]
+| Show all available log frameworks in a buffer.
+
 | `cider-log-set-framework`
 | kbd:[C-c M-l f s]
 | Select the log framework to use.
@@ -351,3 +356,9 @@ using logical AND condition. The following filters are available:
 | kbd:[-t]
 | Only include log events that were emitted by a thread in the list of `threads`.
 |===
+
+== Troubleshooting
+
+- Make sure the logging library is actually supported by CIDER Log Mode and that it is on your classpath.
+- Try requiring the https://github.com/clojure-emacs/logjam/tree/master/src/logjam/framework[Logjam] namespace of the logging library, e.g. `(require 'logjam.framework.<jul|logback|timbre|> :reload)` and make sure it can be loaded without errors.
+- Timbre and Encore often have to be upgraded in concert, they use "break versioning". It's often useful to have Timbre + Encore at the latest stable version.
diff --git a/test/cider-client-tests.el b/test/cider-client-tests.el
@@ -132,6 +132,17 @@
     (expect (cider-ensure-op-supported "foo")
             :to-throw 'user-error)))
 
+(describe "cider-ns-form-p"
+  (it "doesn't match ns in a string"
+      (let ((ns-in-string "\"\n(ns bar)\n\""))
+        (expect (cider-ns-form-p ns-in-string) :to-equal nil)))
+  (it "matches ns"
+      (let ((ns "(ns bar)\n"))
+        (expect (cider-ns-form-p ns) :to-equal 0)))
+  (it "matches ns with leading spaces"
+      (let ((ns "  (ns bar)\n"))
+        (expect (cider-ns-form-p ns) :to-equal 0))))
+
 (describe "cider-expected-ns"
   (before-each
     (spy-on 'cider-connected-p :and-return-value t)
diff --git a/test/cider-tests.el b/test/cider-tests.el
