Feature request: simpler api for customizing transient states

[sooheon]

For example, paste transient state is defined:

(spacemacs|define-transient-state paste
        :title "Pasting Transient State"
        :doc "\n[%s(length kill-ring-yank-pointer)/%s(length kill-ring)] \
[_C-j_/_C-k_] cycles through yanked text, [_p_/_P_] pastes the same text above or \
below. Anything else exits."
        :bindings
        ("C-j" evil-paste-pop)
        ("C-k" evil-paste-pop-next)
        ("p" evil-paste-after)
        ("P" evil-paste-before)
        ("0" spacemacs//transient-state-0))

Is there a way for me to have in my config:

(spacemacs|customize-transient-state paste 
  :bindings ("C-j" nil) 
            ("C-k" nil) 
            ("M-n" evil-paste-pop) 
            ("M-p" evil-paste-pop-next))

I suppose I could duplicate the code and redefine it at the end of config load, but I'm hoping for a better approach.

[nixmaniack]

I think you're looking for this if it's just related to customizing bindings.

spacemacs/layers/+completion/spacemacs-ivy/packages.el

Lines 322 to 328 in 895455d

	(defun spacemacs-ivy/post-init-auto-highlight-symbol ()
	(setq spacemacs-symbol-highlight-transient-state-remove-bindings
	'("/" "b" "f"))
	(setq spacemacs-symbol-highlight-transient-state-add-bindings
	'(("/" spacemacs/search-project-auto-region-or-symbol :exit t)
	("b" spacemacs/swiper-all-region-or-symbol :exit t)
	("f" spacemacs/search-auto-region-or-symbol :exit t))))

[sooheon]

@nixmaniack great, that looks like exactly what I was looking for. Do you know if there's anything to also fix the docstring, then?

[nixmaniack]

As per my understanding, I don't think there's a way at this moment to customize docstring. You might want to create a feature request for it.

[sooheon]

Ideally, if the customization macro could be in the form I suggested above, one could arbitrarily adjust any part of the transient state transparently, rather than having to create separate functions to touch each piece. Can @justbur comment on the feasibility of this?

[TheBB]

You change the docstring by tweaking the variable (in this case) spacemacs/paste-transient-state/hint.

It's a form that is evaled.

[justbur]

@TheBB is right. Be aware that if you want the coloring you either need to do it manually or use hydra--format

[syl20bnr]

There is a macro now to apply hydra formatting to a string, I'm on mobile and cannot paste the name here for now.

[sooheon]

So to switch C-k/C-j bindings to C-n/C-p, I need:

(defun sooheon/post-init-evil ()
  (setq spacemacs-paste-transient-state-remove-bindings
        '("C-j" "C-k"))
  (setq spacemacs-paste-transient-state-add-bindings
        '(("C-n" evil-paste-pop)
          ("C-p" evil-paste-pop-next)))
  (setq spacemacs/paste-transient-state/hint
        '(concat
          #("Pasting Transient State\n"
            0 23 (face
                  spacemacs-transient-state-title-face))
          (concat
           (format
            "[%s/%s] [%s/%s] cycles through yanked text, [%s/%s] pastes the same text above or below. Anything else exits."
            (length kill-ring-yank-pointer)
            (length kill-ring)
            #("C-n"
              0 3 (face hydra-face-red))
            #("C-p"
              0 3 (face hydra-face-red))
            #("p" 0 1 (face hydra-face-red))
            #("P" 0 1 (face hydra-face-red)))
           "")
          nil
          nil)))

I can confirm that this does work, but isn't it a bit much? Or am I missing a more elegant way to do it?

[justbur]

You're adjusting the docstring and most of the bindings, so why not just redefine the transient state?

[sooheon]

That seems like the cleaner way. It's not really clear how to do that, though (as in where to add the redefinition). So far, I've tried it in dotspacemacs-user-config, inside a post-config-evil function in private layer, and inside pre-init-evil, dotspacemacs|use-package-add-hook evil :post-config as well. None have worked so far. Where should it go to take effect?

[justbur]

try this which should work anywhere in user-config (no hooks)

(spacemacs|define-transient-state my-paste
        :title "Pasting Transient State"
        :doc "\n[%s(length kill-ring-yank-pointer)/%s(length kill-ring)] \
[_M-n_/_M-p_] cycles through yanked text, [_p_/_P_] pastes the same text above or \
below. Anything else exits."
        :bindings
        ("M-n" evil-paste-pop)
        ("M-p" evil-paste-pop-next)
        ("p" evil-paste-after)
        ("P" evil-paste-before)
        ("0" spacemacs//transient-state-0))
(define-key evil-normal-state-map "p" 'spacemacs/my-paste-transient-state/evil-paste-after)
(define-key evil-normal-state-map "P" 'spacemacs/my-paste-transient-state/evil-paste-before)

[justbur]

The issue is that the transient-states are all loaded at once at the end of the initialization, so that your definition is probably getting overwritten. This was to allow people to change the key bindings ironically.

[sooheon]

@justbur thanks, my mistake was defining the same paste transient state, which I thought would be fine if "I am the one who overrides".

While my question is essentially answered, I do wonder what kind of impact all of these patches on patches on patches of elisp has for startup time...

[sooheon]

With the unspoken consensus that for now these two methods answer the issue, I'll close.

I do think that as we deal with editing styles molding to user preferences, having transient states be so rigid is a problem in the long term. It'd be amazing if transient state bindings could be as easily editable as evil-define-key for a given state.

[sooheon]

On second thought, no harm in keeping this around as context, and an open ended call for those with the elisp-foo to mull over this api. If we think of transient states as really first class states or "modes", it makes sense that customizing them should be as accessible as something like evil-define-key.

[braham-snyder]

here's an open PR taking a step in the right direction, from @madand – it adds a function that automatically sets or appends to spacemacs-%s-transient-state-add-bindings variables, depending on whether the variable already exists: #8155

EDIT: I think this may be another good example of a transient state customization that would benefit greatly from something like spacemacs|customize-transient-state (as suggested in the OP): I'd simply like to remove the :on-exit property of the time-machine transient state (so that I can exit the hydra without quitting git-timemachine and its buffer).

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Please let us know if this issue is still valid!

[madand]

This issue is still valid and transient state machinery would certainly
benefit from improved macrology around it.

Regarding @braham-snyder's issue with not being able to override :on-exit hook
of time-machine transient state . I believe I figured out a simple way to
solve it. We just need to convert every lisp form, that is used with :on-entry
and :on-exit hook, into a defun. This way users will be able to redefine or
advice them at will, no changes to define-transient-state required.

I will make PR with the mentioned change later this week.

--

Another issue I can think of is abuse of :dynamic-hint for implementing
switching between (static) minimal and full hints. Note the same boilerplate
code again and again:

spacemacs/layers/+lang/html/funcs.el

Lines 78 to 91 in 09a9273

	(defun spacemacs//web-ts-toggle-hint ()
	"Toggle the full hint docstring for the web transient state."
	(interactive)
	(setq spacemacs--web-ts-full-hint-toggle
	(not spacemacs--web-ts-full-hint-toggle)))
	(defun spacemacs//web-ts-hint ()
	"Return a condensed/full hint for the web transient state"
	(concat
	" "
	(if spacemacs--web-ts-full-hint-toggle
	spacemacs--web-ts-full-hint
	(concat "[" (propertize "?" 'face 'hydra-face-red) "] help"
	spacemacs--web-ts-minified-hint))))

spacemacs/layers/+frameworks/vue/funcs.el

Lines 126 to 139 in 09a9273

	(defun spacemacs//vue-ts-toggle-hint ()
	"Toggle the full hint docstring for the vue transient state."
	(interactive)
	(setq spacemacs--vue-ts-full-hint-toggle
	(not spacemacs--vue-ts-full-hint-toggle)))
	(defun spacemacs//vue-ts-hint ()
	"Return a condensed/full hint for the vue transient state"
	(concat
	" "
	(if spacemacs--vue-ts-full-hint-toggle
	spacemacs--vue-ts-full-hint
	(concat "[" (propertize "?" 'face 'hydra-face-red) "] help"
	spacemacs--vue-ts-minified-hint))))

spacemacs/layers/+distributions/spacemacs-bootstrap/funcs.el

Lines 202 to 214 in 09a9273

	(defun spacemacs//scroll-ts-toggle-hint ()
	"Toggle the full hint docstring for the scroll transient state."
	(interactive)
	(setq spacemacs--scroll-ts-full-hint-toggle
	(not spacemacs--scroll-ts-full-hint-toggle)))
	(defun spacemacs//scroll-ts-hint ()
	"Return a condensed/full hint for the scroll transient state"
	(concat
	" "
	(if spacemacs--scroll-ts-full-hint-toggle
	spacemacs--scroll-ts-full-hint
	(concat "[" (propertize "?" 'face 'hydra-face-red) "] toggle help"))))

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Please let us know if this issue is still valid!

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Please let us know if this issue is still valid!