Skip to content

[inspect] Add support for :table view-mode #928

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 5, 2025
Merged

[inspect] Add support for :table view-mode #928

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

## master (unreleased)

* Bump `orchard` to [0.32.0](https://github.com/clojure-emacs/orchard/blob/master/CHANGELOG.md#0320-2025-04-05).
* Bump `orchard` to [0.32.1](https://github.com/clojure-emacs/orchard/blob/master/CHANGELOG.md#0320-2025-04-05).
* [#925](https://github.com/clojure-emacs/cider-nrepl/pull/9250): Stop vendoring Puget dependency.
* [#917](https://github.com/clojure-emacs/cider-nrepl/pull/917): Sort printed maps in test output.
* [#927](https://github.com/clojure-emacs/cider-nrepl/pull/927): Add `inspect-display-analytics` op.
* [#928](https://github.com/clojure-emacs/cider-nrepl/pull/922): Add support for `:table` view-mode in inspector.

## 0.53.2 (2025-03-26)

Expand Down
2 changes: 1 addition & 1 deletion doc/modules/ROOT/pages/nrepl-api/ops.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -763,7 +763,7 @@ Returns::

=== `inspect-toggle-view-mode`

Toggles the viewing mode of the inspector. This influences the way how inspector is rendering the current value. ``:normal`` is the default. When view mode is ``:object``, any value will be rendered as a Java object (fields shown as is). View mode is automatically reset back to normal when navigating to child values.
Toggles the viewing mode of the inspector. This influences the way how inspector is rendering the current value. ``:normal`` is the default. When view mode is ``:table``, the value will be rendered as a table (only supported for sequences of maps or tuples). When view mode is ``:object``, any value will be rendered as a Java object (fields shown as is). View mode is automatically reset back to normal when navigating to child values.

Required parameters::
* `:session` The current session
Expand Down
2 changes: 1 addition & 1 deletion src/cider/nrepl.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ if applicable, and re-render the updated value."
"view-mode" "Mode of viewing the value - either `:normal` or `:object`"}
:returns inspector-returns}
"inspect-toggle-view-mode"
{:doc "Toggles the viewing mode of the inspector. This influences the way how inspector is rendering the current value. `:normal` is the default. When view mode is `:object`, any value will be rendered as a Java object (fields shown as is). View mode is automatically reset back to normal when navigating to child values."
{:doc "Toggles the viewing mode of the inspector. This influences the way how inspector is rendering the current value. `:normal` is the default. When view mode is `:table`, the value will be rendered as a table (only supported for sequences of maps or tuples). When view mode is `:object`, any value will be rendered as a Java object (fields shown as is). View mode is automatically reset back to normal when navigating to child values."
:requires {"session" "The current session"}
:returns inspector-returns}
"inspect-display-analytics"
Expand Down
5 changes: 4 additions & 1 deletion src/cider/nrepl/middleware/inspect.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,10 @@
(inspector-response msg (swap-inspector! msg #(inspect/refresh % overrides)))))

(defn- toggle-view-mode [{:keys [view-mode] :as inspector}]
(let [toggle-order {:normal :object, :object :normal}
;; The order in which view modes are cycled depends on the inspected object.
(let [toggle-order (if (inspect/supports-table-view-mode? inspector)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd add a note here that depends on the underlying data, as I'm not sure it will be obvious from the name of the function alone.

{:normal :table, :table :object, :object :normal}
{:normal :object, :object :normal})
next-view-mode (toggle-order view-mode :normal)]
(inspect/set-view-mode inspector next-view-mode)))

Expand Down
18 changes: 18 additions & 0 deletions test/clj/cider/nrepl/middleware/inspect_test.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -630,6 +630,15 @@
" " [:value "_rest" number?] " = " [:value "(2 3)" number?]
[:newline]])

(def table-mode-prefix
["--- Contents:" [:newline]
[:newline]
" | " [:value "#" pos?] " | " [:value ":a" pos?] " | " [:newline]
" |----+----|" [:newline]
" | " [:value "0" pos?] " | " [:value "1" pos?] " | " [:newline]
" | " [:value "1" pos?] " | " [:value "1" pos?] " | " [:newline]
" | " [:value "2" pos?] " | " [:value "1" pos?] " | " [:newline]])

(deftest object-view-mode-integration-test
(testing "view-mode can be toggled with inspect-toggle-view-mode op"
(session/message {:op "inspect-clear"})
Expand Down Expand Up @@ -673,6 +682,15 @@
:code "(range 100)"
:display-analytics-hint "true"})))))

(deftest table-view-mode-integration-test
(testing "table view-mode is supported for lists of maps"
(session/message {:op "inspect-clear"})
(session/message {:op "eval"
:inspect "true"
:code "(repeat 20 {:a 1})"})
(is+ (matchers/prefix table-mode-prefix)
(value-skip-header (session/message {:op "inspect-toggle-view-mode"})))))

(deftest print-length-independence-test
(testing "*print-length* doesn't break rendering of long collections"
(is (re-find #"showing page: \d+ of \d+"
Expand Down