blamer-type for `sideline` or sideline backend

[jcs090218]

Hi,

I really like the blamer show that puts the information on the side of the window, but I would like to use it with other sideline backends. Would you consider providing a sideline backed to support sideline?

Thank you.

[Artawower]

I don't think this would work for displaying commit information in region. However, it may well work for highlighting information about the current line. Something like this:

(defun blamer-async-sideline-backend (command)
  "Async backend provider for COMMAND in the `sideline' package."
  (cl-case command
    (`candidates (cons :async (lambda (callback &rest _)
                                (blamer--get-async-blame-info
                                 (blamer--get-local-name (buffer-file-name))
                                 (line-number-at-pos)
                                 (line-number-at-pos)
                                 (lambda (raw-commit-info)
                                   (blamer--async-parse-line-info
                                    raw-commit-info
                                    (lambda (commit-info)
                                      (funcall callback (blamer--create-popup-text-content commit-info)))
                                    (line-number-at-pos)))))))))

(setq sideline-backends-left '(blamer-async-sideline-backend))

I'm not very familiar with the sideline package, if this is the expected result then I can add it to the package.

[jcs090218]

I've tried this code but getting the error: 🤔

Debugger entered--Lisp error: (void-variable include-avatar-p)
  (and blamer-show-avatar-p include-avatar-p (not uncommitted) (display-graphic-p))
  (if (and blamer-show-avatar-p include-avatar-p (not uncommitted) (display-graphic-p)) (progn (blamer--get-avatar author-email)))
  (let* ((author-email (car info)) (commit-messages (car (cdr info))) (commit-messages commit-messages) (commit-messages (blamer--extract-commit-messages commit-messages)) (commit-message (car commit-messages)) (commit-message (if commit-message (progn (string-trim commit-message)))) (commit-message (if (and blamer-commit-formatter commit-message) (progn (truncate-string-to-width commit-message blamer-max-commit-message-length nil nil "...")))) (commit-description (cdr commit-messages)) (raw-commit-message (nth 1 commit-messages)) (avatar (if (and blamer-show-avatar-p include-avatar-p (not uncommitted) (display-graphic-p)) (progn (blamer--get-avatar author-email))))) (funcall callback (list ':commit-hash commit-hash ':author-email author-email ':commit-author commit-author ':commit-date commit-date ':commit-time commit-time ':commit-avatar avatar ':raw-commit-author raw-commit-author ':commit-message commit-message ':commit-description commit-description ':raw-commit-message raw-commit-message ':line-number line-number)))
...

[Artawower]

That's a bit weired...
Is it the latest version of blamer?
If you call the blamer-show-posframe-commit-info function, does it give the same error?

What if you explicitly pass the avatar?

(defun blamer-async-sideline-backend (command)
  "Async backend provider for COMMAND in the `sideline' package."
  (cl-case command
    (`candidates (cons :async (lambda (callback &rest _)
                                (blamer--get-async-blame-info
                                 (blamer--get-local-name (buffer-file-name))
                                 (line-number-at-pos)
                                 (line-number-at-pos)
                                 (lambda (raw-commit-info)
                                   (blamer--async-parse-line-info
                                    raw-commit-info
                                    (lambda (commit-info)
                                      (funcall callback (blamer--create-popup-text-content commit-info)))
                                    (line-number-at-pos)
                                    nil))))))))

[jcs090218]

Oh, I guess I cannot just evaluate blamer.el. 🤔

It kinda works now.

+(defvar blamer--sideline-callback nil)

(defun blamer-async-sideline-backend (command)
  "Async backend provider for COMMAND in the `sideline' package."
  (cl-case command
    (`candidates (cons :async (lambda (callback &rest _)
+                               (setq blamer--sideline-callback callback)
                                (blamer--get-async-blame-info
                                 (blamer--get-local-name (buffer-file-name))
                                 (line-number-at-pos)
                                 (line-number-at-pos)
                                 (lambda (raw-commit-info)
                                   (blamer--async-parse-line-info
                                    raw-commit-info
                                    (lambda (commit-info)
-                                      (funcall callback (blamer--create-popup-text-content commit-info)))
+                                      (funcall blamer--sideline-callback (blamer--create-popup-text-content commit-info)))
                                    (line-number-at-pos)))))))))

But it doesn't look very nice: (screenshot)

[Artawower]

I wonder why this example works and the one I gave doesn't. 🤔

For the same inline result as in blamer overlay you can use the following code:

(defun blamer-async-sideline-backend (command)
  "Async backend provider for COMMAND in the `sideline' package."
  (cl-case command
    (`candidates (cons :async (lambda (callback &rest _)
                                (blamer--get-async-blame-info
                                 (blamer--get-local-name (buffer-file-name))
                                 (line-number-at-pos)
                                 (line-number-at-pos)
                                 (lambda (raw-commit-info)
                                   (blamer--async-parse-line-info
                                    raw-commit-info
                                    (lambda (commit-info)
                                      (funcall callback (list (blamer--create-popup-msg commit-info))))
                                    (line-number-at-pos)))))))))

[jcs090218]

It looks like it works but not sure why it has so many spaces? 🤔 Adding string-trim can resolve this issue.

There is another issue: when the mouse moves too fast, it produces two sidelines instead of one.

[Artawower]

Can you try this branch? I added the ability to change the indentation for formatted message

You may also need to set (setq blamer-min-offset 0).

I would also like to see if the code will work without setting the callback to an external variable

There is another issue: when the mouse moves too fast, it produces two sidelines instead of one.

I don't think blamer can do anything about it, as I understand the rendering engine is entirely on the sideline side, I can only provide data for it. Correct me if I'm wrong