branch: externals/pulsar
commit 1af423199df67b36d989bab1ba26ff67715f1b3b
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Update to version 1.0.0
---
CHANGELOG.org | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
README.org | 8 +++-----
pulsar.el | 2 +-
3 files changed, 57 insertions(+), 6 deletions(-)
diff --git a/CHANGELOG.org b/CHANGELOG.org
index 37912f876e..84f249167e 100644
--- a/CHANGELOG.org
+++ b/CHANGELOG.org
@@ -6,6 +6,59 @@
The newest release is at the top. For further details, please consult
the manual: <https://protesilaos.com/emacs/pulsar>.
+* Version 1.0.0 on 2023-08-12
+:PROPERTIES:
+:CUSTOM_ID: h:0d09da86-29be-461e-8ef6-1e93a07b756b
+:END:
+
+- The ~next-buffer~ and ~previous-buffer~ commands are added to the
+ default value of the user option ~pulsar-pulse-functions~. They
+ will now trigger a pulse effect after they are called (if
+ ~pulsar-mode~ is enabled in the current buffer or
+ ~pulsar-global-mode~ is in use).
+
+- The command ~pulsar-recenter-middle~ is now an alias for
+ ~pulsar-recenter-center~, instead of being the original name. Users
+ do not need to change anything on their end: this is just an
+ internal arrangement to use a name that corresponds to the one of
+ the underlying "recenter" mechanism.
+
+- The Lisp macro that was used to derive the Pulsar "recenter"
+ commands has been removed. The commands are ~pulsar-recenter-top~
+ and ~pulsar-recenter-center~. I originally thought the macro would
+ be useful in more places, but I ended up relying on it only twice.
+
+ Thanks to Ryan Kaskel for pointing out an intermediate typo/error I
+ made while redefining the macro and before I decided to remove it
+ altogether. This was done as a comment on the GitHub mirror:
+
<https://github.com/protesilaos/pulsar/commit/c5086de779a0226d72eca4d5cba8c7689bc278b2#r123397272>.
+
+- The Lisp macro ~pulsar-pulse-with-face~ is renamed to
+ ~pulsar-define-pulse-with-face~. Its definition is updated to
+ simplify how a Pulsar function is defined with a given face.
+ Examples of such functions are ~pulsar-pulse-line-red~,
+ ~pulsar-pulse-line-blue~.
+
+- Pulsar now retrieves the absolute beginning of the minibuffer
+ prompt. This means that a pulse in the minibuffer will cover the
+ text of the prompt, as opposed to only affecting the input area. As
+ such, the pulse is visible even if the minibuffer is empty
+ (e.g. what happens with the default completion setup when calling
+ =M-x=).
+
+- The manual provides instructions on how to set up Pulsar to produce
+ a pulse when the minibuffer is activated. It cannot be done with
+ the ~pulsar-pulse-functions~, though the setup is not too involved.
+ In short:
+
+ #+begin_src emacs-lisp
+ (add-hook 'minibuffer-setup-hook #'pulsar-pulse-line)
+
+ ;; OR something like this, replacing "blue" with one among red,
+ ;; green, yellow, magenta, cyan:
+ (add-hook 'minibuffer-setup-hook #'pulsar-pulse-line-blue)
+ #+end_src
+
* Version 0.5.0 on 2022-08-19
:PROPERTIES:
:CUSTOM_ID: h:20bf677d-bcef-4606-8cc2-ebd49bfc057b
diff --git a/README.org b/README.org
index 79c0ba5e50..2028ac72a1 100644
--- a/README.org
+++ b/README.org
@@ -4,9 +4,9 @@
#+language: en
#+options: ':t toc:nil author:t email:t num:t
#+startup: content
-#+macro: stable-version 0.5.0
-#+macro: release-date 2022-08-19
-#+macro: development-version 1.0.0-dev
+#+macro: stable-version 1.0.0
+#+macro: release-date 2023-08-12
+#+macro: development-version 1.1.0-dev
#+export_file_name: pulsar.texi
#+texinfo_filename: pulsar.info
#+texinfo_dir_category: Emacs misc features
@@ -265,8 +265,6 @@ Pulsar-level solution that "just works":
:CUSTOM_ID: h:8b942448-6ed3-4cb7-8e31-796a8c5011a6
:END:
-[ This works as intended with changes that are part of
{{{development-version}}}. ]
-
Due to how the minibuffer works, the user cannot rely on the user
option ~pulse-pulse-functions~ to automatically pulse in that context.
Instead, the user must add a function to the ~minibuffer-setup-hook~:
diff --git a/pulsar.el b/pulsar.el
index acde93fb62..06beea12fb 100644
--- a/pulsar.el
+++ b/pulsar.el
@@ -6,7 +6,7 @@
;; Maintainer: Pulsar Development <~protesilaos/pul...@lists.sr.ht>
;; URL: https://git.sr.ht/~protesilaos/pulsar
;; Mailing-List: https://lists.sr.ht/~protesilaos/pulsar
-;; Version: 0.5.0
+;; Version: 1.0.0
;; Package-Requires: ((emacs "27.1"))
;; Keywords: convenience, pulse, highlight
