From 32e8f7fa739c922ad420cbcea8097cddb2df10c3 Mon Sep 17 00:00:00 2001 From: Baptiste Strazzulla Date: Thu, 9 Nov 2023 17:18:33 +0100 Subject: [PATCH 1/5] New value `per-project` for `cider-repl-history-file` To save the history on a per-project basis. --- CHANGELOG.md | 4 ++ cider-repl-history.el | 1 - cider-repl.el | 55 +++++++++++++------ .../ROOT/pages/repl/configuration.adoc | 15 ++++- 4 files changed, 53 insertions(+), 22 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6417918f1..4faa571e0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ ## master (unreleased) +### Changes + +- [#3574](https://github.com/clojure-emacs/cider/issues/3574): New value `per-project` for `cider-repl-history-file` to save the history on a per-project basis. + ### Bugs fixed - [#3763](https://github.com/clojure-emacs/cider/issues/3763): Fix `cider-docview-render` completion popup error when symbol being completed does not have a docstring. diff --git a/cider-repl-history.el b/cider-repl-history.el index ec19298ad..e64c773af 100644 --- a/cider-repl-history.el +++ b/cider-repl-history.el @@ -220,7 +220,6 @@ call `cider-repl-history' again.") (defvar cider-repl-history-previous-overlay nil "Previous overlay within *cider-repl-history* buffer.") - (defun cider-repl-history-get-history () "Function to retrieve history from the REPL buffer." (if cider-repl-history-repl-buffer diff --git a/cider-repl.el b/cider-repl.el index 9fd17c4f6..7d967da29 100644 --- a/cider-repl.el +++ b/cider-repl.el @@ -194,9 +194,6 @@ CIDER 1.7." This property value must be unique to avoid having adjacent inputs be joined together.") -(defvar-local cider-repl-input-history '() - "History list of strings read from the REPL buffer.") - (defvar-local cider-repl-input-history-items-added 0 "Variable counting the items added in the current session.") @@ -1468,6 +1465,9 @@ WIN, BUFFER and POS are the window, buffer and point under mouse position." (defvar cider-repl-history-pattern nil "The regexp most recently used for finding input history.") +(defvar cider-repl-input-history '() + "History list of strings read from the REPL buffer.") + (defun cider-repl--add-to-input-history (string) "Add STRING to the input history. Empty strings and duplicates are ignored." @@ -1593,9 +1593,11 @@ If USE-CURRENT-INPUT is non-nil, use the current input." :safe #'integerp) (defcustom cider-repl-history-file nil - "File to save the persistent REPL history to." - :type 'string - :safe #'stringp) + "File to save the persistent REPL history to. +If this is set to a path the history will be global to all projects. If this is +set to `per-project', the history will be stored in a file (.cider-history) at +the root of each project." + :type '(choice string symbol)) (defun cider-repl--history-read-filename () "Ask the user which file to use, defaulting `cider-repl-history-file'." @@ -1619,11 +1621,27 @@ defined filenames can be used to read special history files. The value of `cider-repl-input-history' is set by this function." (interactive (list (cider-repl--history-read-filename))) - (let ((f (or filename cider-repl-history-file))) - ;; TODO: probably need to set cider-repl-input-history-position as well. - ;; in a fresh connection the newest item in the list is currently - ;; not available. After sending one input, everything seems to work. - (setq cider-repl-input-history (cider-repl--history-read f)))) + (cond + (filename (setq cider-repl-history-file filename)) + ((equal 'per-project cider-repl-history-file) + (make-local-variable 'cider-repl-input-history) + (when-let ((dir (clojure-project-dir))) + (setq-local + cider-repl-history-file (expand-file-name ".cider-history" dir))))) + (when cider-repl-history-file + (condition-case nil + ;; TODO: probably need to set cider-repl-input-history-position as + ;; well. In a fresh connection the newest item in the list is + ;; currently not available. After sending one input, everything + ;; seems to work. + (setq + cider-repl-input-history + (cider-repl--history-read cider-repl-history-file)) + (error + (message + "Malformed cider-repl-history-file: %s" cider-repl-history-file))) + (add-hook 'kill-buffer-hook #'cider-repl-history-just-save t t) + (add-hook 'kill-emacs-hook #'cider-repl-history-save-all))) (defun cider-repl--history-write (filename) "Write history to FILENAME. @@ -1658,6 +1676,13 @@ This function is meant to be used in hooks to avoid lambda constructs." (cider-repl-history-save cider-repl-history-file)) +(defun cider-repl-history-save-all () + "Save all histories." + (dolist (buffer (buffer-list)) + (with-current-buffer buffer + (when (equal major-mode 'cider-repl-mode) + (cider-repl-history-just-save))))) + ;; SLIME has different semantics and will not save any duplicates. ;; we keep track of how many items were added to the history in the ;; current session in `cider-repl--add-to-input-history' and merge only the @@ -2051,13 +2076,7 @@ in an unexpected place." (setq-local prettify-symbols-alist clojure--prettify-symbols-alist) ;; apply dir-local variables to REPL buffers (hack-dir-local-variables-non-file-buffer) - (when cider-repl-history-file - (condition-case nil - (cider-repl-history-load cider-repl-history-file) - (error - (message "Malformed cider-repl-history-file: %s" cider-repl-history-file))) - (add-hook 'kill-buffer-hook #'cider-repl-history-just-save t t) - (add-hook 'kill-emacs-hook #'cider-repl-history-just-save)) + (cider-repl-history-load) (add-hook 'completion-at-point-functions #'cider-complete-at-point nil t) (add-hook 'paredit-mode-hook (lambda () (clojure-paredit-setup cider-repl-mode-map))) (cider-repl-setup-paredit)) diff --git a/doc/modules/ROOT/pages/repl/configuration.adoc b/doc/modules/ROOT/pages/repl/configuration.adoc index 774abc889..39458d474 100644 --- a/doc/modules/ROOT/pages/repl/configuration.adoc +++ b/doc/modules/ROOT/pages/repl/configuration.adoc @@ -340,12 +340,21 @@ reset automatically by the `track-state` middleware. (setq cider-repl-history-size 1000) ; the default is 500 ---- -* To store the REPL history in a file: +* To store the REPL history of all projects in a single file: [source,lisp] ---- (setq cider-repl-history-file "path/to/file") ---- -Note that CIDER writes the history to the file when you kill the REPL -buffer, which includes invoking `cider-quit`, or when you quit Emacs. +* To store the REPL history per project (by creating a + `.cider-history` file at the root of each): + +[source,lisp] +---- +(setq cider-repl-history-file 'per-project) +---- + +Note that CIDER writes the history to the file(s) when you kill the +REPL buffer, which includes invoking `cider-quit`, or when you quit +Emacs. From 73050f1d16db3977a42d358cc6f703dbfde30bec Mon Sep 17 00:00:00 2001 From: Baptiste Strazzulla Date: Wed, 8 Nov 2023 00:53:41 +0100 Subject: [PATCH 2/5] Stop merging the input history with `cider-repl-history-file' Because input history cannot be changed by another REPL anymore --- cider-repl.el | 22 +++------------------- 1 file changed, 3 insertions(+), 19 deletions(-) diff --git a/cider-repl.el b/cider-repl.el index 7d967da29..c8155beeb 100644 --- a/cider-repl.el +++ b/cider-repl.el @@ -194,9 +194,6 @@ CIDER 1.7." This property value must be unique to avoid having adjacent inputs be joined together.") -(defvar-local cider-repl-input-history-items-added 0 - "Variable counting the items added in the current session.") - (defvar-local cider-repl-output-start nil "Marker for the start of output. Currently its only purpose is to facilitate `cider-repl-clear-buffer'.") @@ -1473,8 +1470,7 @@ WIN, BUFFER and POS are the window, buffer and point under mouse position." Empty strings and duplicates are ignored." (unless (or (equal string "") (equal string (car cider-repl-input-history))) - (push string cider-repl-input-history) - (cl-incf cider-repl-input-history-items-added))) + (push string cider-repl-input-history))) (defun cider-repl-delete-current-input () "Delete all text after the prompt." @@ -1647,11 +1643,9 @@ The value of `cider-repl-input-history' is set by this function." "Write history to FILENAME. Currently coding system for writing the contents is hardwired to utf-8-unix." - (let* ((mhist (cider-repl--histories-merge cider-repl-input-history - cider-repl-input-history-items-added - (cider-repl--history-read filename))) + (let* ((end (min (length cider-repl-input-history) cider-repl-history-size)) ;; newest items are at the beginning of the list, thus 0 - (hist (cl-subseq mhist 0 (min (length mhist) cider-repl-history-size)))) + (hist (cl-subseq cider-repl-input-history 0 end))) (unless (file-writable-p filename) (error (format "History file not writable: %s" filename))) (let ((print-length nil) (print-level nil)) @@ -1683,16 +1677,6 @@ constructs." (when (equal major-mode 'cider-repl-mode) (cider-repl-history-just-save))))) -;; SLIME has different semantics and will not save any duplicates. -;; we keep track of how many items were added to the history in the -;; current session in `cider-repl--add-to-input-history' and merge only the -;; new items with the current history found in the file, which may -;; have been changed in the meantime by another session. -(defun cider-repl--histories-merge (session-hist n-added-items file-hist) - "Merge histories from SESSION-HIST adding N-ADDED-ITEMS into FILE-HIST." - (append (cl-subseq session-hist 0 n-added-items) - file-hist)) - ;;; REPL shortcuts (defcustom cider-repl-shortcut-dispatch-char ?\, From 493e77183261fc96819a4e8d29850aafc604fe9c Mon Sep 17 00:00:00 2001 From: Baptiste Strazzulla Date: Fri, 10 Nov 2023 13:11:22 +0100 Subject: [PATCH 3/5] Find a suitable directory to store the project's history more robustly --- cider-repl.el | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/cider-repl.el b/cider-repl.el index c8155beeb..6c89426fb 100644 --- a/cider-repl.el +++ b/cider-repl.el @@ -1610,6 +1610,12 @@ It does not yet set the input history." (read (current-buffer)))) '())) +(defun cider-repl--find-dir-for-history () + "Find the first suitable directory to store the project's history." + (seq-find + (lambda (dir) (and (not (null dir)) (not (tramp-tramp-file-p dir)))) + (list nrepl-project-dir (clojure-project-dir) default-directory))) + (defun cider-repl-history-load (&optional filename) "Load history from FILENAME into current session. FILENAME defaults to the value of `cider-repl-history-file' but user @@ -1621,7 +1627,7 @@ The value of `cider-repl-input-history' is set by this function." (filename (setq cider-repl-history-file filename)) ((equal 'per-project cider-repl-history-file) (make-local-variable 'cider-repl-input-history) - (when-let ((dir (clojure-project-dir))) + (when-let ((dir (cider-repl--find-dir-for-history))) (setq-local cider-repl-history-file (expand-file-name ".cider-history" dir))))) (when cider-repl-history-file From 0ca5b6a9a1c46f77ca974ff615de8823107729e1 Mon Sep 17 00:00:00 2001 From: Baptiste Strazzulla Date: Tue, 7 Nov 2023 23:38:16 +0100 Subject: [PATCH 4/5] Calculate the length of the history only once --- cider-repl-history.el | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/cider-repl-history.el b/cider-repl-history.el index e64c773af..e7b08cd35 100644 --- a/cider-repl-history.el +++ b/cider-repl-history.el @@ -636,16 +636,17 @@ HISTORY-BUF is the history, and optional arg REGEXP is a filter." #'cider-repl-history-update-highlighted-entry nil t)) (message - (let ((entry (if (= 1 (length cider-command-history)) - "entry" - "entries"))) + (let* ((history-length (length cider-command-history)) + (entry (if (= 1 history-length) + "entry" + "entries"))) (concat (if (and (not regexp) cider-repl-history-display-duplicates) (format "%s %s in the command history." - (length cider-command-history) entry) + history-length entry) (format "%s (of %s) %s in the command history shown." - (length items) (length cider-command-history) entry)) + (length items) history-length entry)) (substitute-command-keys (concat " Type \\[cider-repl-history-quit] to quit. " "\\[describe-mode] for help."))))) From 590945536829193ffb64ac0506bd40b3b30a7ea7 Mon Sep 17 00:00:00 2001 From: Baptiste Strazzulla Date: Wed, 8 Nov 2023 00:53:23 +0100 Subject: [PATCH 5/5] Add a command to delete history item at point --- CHANGELOG.md | 3 +++ cider-repl-history.el | 11 +++++++++++ doc/modules/ROOT/pages/repl/history.adoc | 3 +++ 3 files changed, 17 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4faa571e0..6838c3737 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,9 @@ ## master (unreleased) +### New features +- CIDER [History](https://docs.cider.mx/cider/repl/history.html): Add a command to delete history item at point. + ### Changes - [#3574](https://github.com/clojure-emacs/cider/issues/3574): New value `per-project` for `cider-repl-history-file` to save the history on a per-project basis. diff --git a/cider-repl-history.el b/cider-repl-history.el index e7b08cd35..c205b6502 100644 --- a/cider-repl-history.el +++ b/cider-repl-history.el @@ -575,6 +575,16 @@ text from the *cider-repl-history* buffer." (with-current-buffer cider-repl-history-repl-buffer (undo))) +(defun cider-repl-history-delete-entry-at-point () + "Delete history entry (at point)." + (interactive) + (let* ((orig (point)) + (str (cider-repl-history-current-string orig))) + (with-current-buffer cider-repl-history-repl-buffer + (delete str cider-repl-input-history)) + (cider-repl-history-update) + (goto-char orig))) + (defun cider-repl-history-setup (repl-win repl-buf history-buf &optional regexp) "Setup. REPL-WIN and REPL-BUF are where to insert commands; @@ -693,6 +703,7 @@ HISTORY-BUF is the history, and optional arg REGEXP is a filter." (define-key map (kbd "g") #'cider-repl-history-update) (define-key map (kbd "q") #'cider-repl-history-quit) (define-key map (kbd "U") #'cider-repl-history-undo-other-window) + (define-key map (kbd "D") #'cider-repl-history-delete-entry-at-point) (define-key map (kbd "?") #'describe-mode) (define-key map (kbd "h") #'describe-mode) map)) diff --git a/doc/modules/ROOT/pages/repl/history.adoc b/doc/modules/ROOT/pages/repl/history.adoc index 7e095ee43..88a34a1a2 100644 --- a/doc/modules/ROOT/pages/repl/history.adoc +++ b/doc/modules/ROOT/pages/repl/history.adoc @@ -175,4 +175,7 @@ There are a number of important keybindings in history buffers. | kbd:[U] | Undo in the REPL buffer. + +| kbd:[D] +| Delete history item (at point). |===