Add cider-history command, based on browse-kill-ring #1916

johnv02139 · 2017-01-10T21:45:02Z

Add "cider-history", based on functionality provided by the emacs "browse-kill-ring" package.

Lots of documentation is available within the commit, specifically in miscellaneous_features.md.

bbatsov · 2017-01-11T02:47:06Z

Apart from my small remarks, the PR looks pretty good.

bbatsov · 2017-01-11T02:34:43Z

CHANGELOG.md

@@ -8,6 +8,7 @@
 * Add an option `cider-inspector-fill-frame` to control whether the cider inspector window fills its frame.
 * [#1893](https://github.com/clojure-emacs/cider/issues/1893): Add negative prefix argument to `cider-refresh` to inhibit invoking of cider-refresh-functions
 * [#1776](https://github.com/clojure-emacs/cider/issues/1776): Add new customization variable `cider-test-defining-forms` allowing new test defining forms to be recognized.
+* [#1860](https://github.com/clojure-emacs/cider/issues/1860): Add a command `history` to browse the REPL command history and insert elements from it into the REPL buffer.


cider-repl-history

So, the actual buffer-local-var is called cider-repl-input-history. Do you want me to refer to that, specifically?

I meant that actual command is going to be named cider-repl-history in the end. Or were you referring here to the REPL shortcut command?

Ah, yes, when I wrote that, I was thinking of the REPL shortcut command -- the thing you access by hitting comma. I guess it makes more sense to refer to the emacs function. I'll change it.

bbatsov · 2017-01-11T02:35:34Z

cider-history.el

+
+;; This file is not part of GNU Emacs.
+
+;; Based heavily on browse-kill-ring:


This attribution line is enough. Drop the copyright snippet that follows it.

bbatsov · 2017-01-11T02:36:06Z

cider-history.el

@@ -0,0 +1,749 @@
+;;; cider-history.el --- REPL input history browser


Let's name the file and the command cider-repl-history.

What about the prefix?? You want all the functions named cider-repl-history-foo?

Yeah, the prefix should be changed as well. cider-history is simply too generic.

bbatsov · 2017-01-11T02:37:54Z

cider-history.el

+        (overlay-put cider-history-preview-overlay
+                     'invisible t)))))
+
+;; UNUSED


Let's just remove it if it's unused.

bbatsov · 2017-01-11T02:38:19Z

cider-history.el

+
+(defun cider-history-highlight-inserted (start end)
+  "Insert the text between START and END."
+  ;; (when cider-history-highlight-inserted-item (cider-history-adjust-insert))


Why is this commented out?

It's a reference to the function above, which as I said is now unnecessary. I left it there in case anyone had a weird setup or wanted to try with an old emacs, so it would be as easy as possible for them to reinstate this, instead of re-writing it from scratch. But I can yank it all.

Drop it. We don't care at all about supporting old Emacsen.

bbatsov · 2017-01-11T02:40:07Z

cider-history.el

+  "Display items in the CIDER command history in another buffer."
+  (interactive)
+  (when (eq major-mode 'cider-history-mode)
+    (error "Already viewing the CIDER command history"))


error -> user-error

bbatsov · 2017-01-11T02:41:31Z

doc/miscellaneous_features.md

+
+When "highlight-inserted" is turned on, you can customize the face of the
+inserted text with the variable `cider-history-inserted-item-face`.
+


Kill this extra blank line.

bbatsov · 2017-01-11T02:42:24Z

doc/using_the_repl.md

@@ -233,3 +233,6 @@ section of your Leiningen project's configuration.

 Note that the history is written to the file when you kill the REPL
 buffer (which includes invoking `cider-quit`) or you quit Emacs.
+
+There is a facility to browse the REPL history; see `REPL input history browser`


You can directly link to this section using page#section-name.

Sorry, I guess these are extremely general questions, but I don't find any answers by Googling, so:
(1) what's the mapping from the text of the headline ("REPL history browser") and the section name? I tried "#repl-history-browser" but it didn't seem to work quite right. Is there a way to give an explicit name?
(2) how can I test this, not just the linking, but any markdown I create? Do I have to push it to github and load it from there?

See http://cider.readthedocs.io/en/latest/about/contributing/#working-on-the-manual

bbatsov · 2017-01-11T02:48:24Z

doc/miscellaneous_features.md

+and when you find the history item you were looking for, you can insert it from
+the history buffer into your REPL buffer.
+
+![History Browser](images/history_browser.png)


I think you forgot to add this image file.

bbatsov · 2017-01-11T09:42:25Z

Great work! 👍

expez · 2017-01-16T06:34:28Z

Incredibly hot stuff @johnv02139!

bbatsov reviewed Jan 11, 2017

View reviewed changes

johnv02139 force-pushed the repl-history branch 3 times, most recently from e5181fe to 5831938 Compare January 11, 2017 08:46

Add cider-history command, based on browse-kill-ring

cf73608

johnv02139 force-pushed the repl-history branch from 5831938 to cf73608 Compare January 11, 2017 08:53

bbatsov merged commit 3a1bc62 into clojure-emacs:master Jan 11, 2017

johnv02139 deleted the repl-history branch January 11, 2017 17:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add cider-history command, based on browse-kill-ring #1916

Add cider-history command, based on browse-kill-ring #1916

johnv02139 commented Jan 10, 2017

bbatsov commented Jan 11, 2017

bbatsov Jan 11, 2017

johnv02139 Jan 11, 2017

bbatsov Jan 11, 2017

johnv02139 Jan 11, 2017

bbatsov Jan 11, 2017

bbatsov Jan 11, 2017

johnv02139 Jan 11, 2017 •

edited

Loading

bbatsov Jan 11, 2017

bbatsov Jan 11, 2017

bbatsov Jan 11, 2017

johnv02139 Jan 11, 2017

bbatsov Jan 11, 2017

bbatsov Jan 11, 2017

bbatsov Jan 11, 2017

bbatsov Jan 11, 2017

johnv02139 Jan 11, 2017

bbatsov Jan 11, 2017

bbatsov Jan 11, 2017

bbatsov commented Jan 11, 2017

expez commented Jan 16, 2017


		;; This file is not part of GNU Emacs.

		;; Based heavily on browse-kill-ring:

		@@ -0,0 +1,749 @@
		;;; cider-history.el --- REPL input history browser


		When "highlight-inserted" is turned on, you can customize the face of the
		inserted text with the variable `cider-history-inserted-item-face`.

Add cider-history command, based on browse-kill-ring #1916

Add cider-history command, based on browse-kill-ring #1916

Conversation

johnv02139 commented Jan 10, 2017

bbatsov commented Jan 11, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

johnv02139 Jan 11, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bbatsov commented Jan 11, 2017

expez commented Jan 16, 2017

johnv02139 Jan 11, 2017 •

edited

Loading