Merge pull request #19 from Stebalien/steb/comment-fringe

Add fringe icons for comments

Author: blahgeek

pr-review-common.el

@@ -144,6 +144,17 @@
   "Face used for reaction emojis."
   :group 'pr-review)
 
+(defface pr-review-fringe-comment-pending
+  '((t :inherit warning))
+  "Face used for fringe icons for pending comments.")
+
+(defface pr-review-fringe-comment-open
+  '((t :inherit font-lock-constant-face))
+  "Face used for fringe icons for open comments.")
+
+(defface pr-review-fringe-comment-resolved
+  '((t :inherit shadow))
+  "Face used for fringe icons for resolved comments.")
 
 ;; section classes
 (defclass pr-review--review-section (magit-section)

pr-review-render.el

@@ -40,6 +40,11 @@
   :type 'integer
   :group 'pr-review)
 
+(defcustom pr-review-fringe-icons t
+  "Display icons in the fringe indicating PR-review comments."
+  :type 'boolean
+  :group 'pr-review)
+
 (defun pr-review--format-timestamp (str)
   "Convert and format timestamp STR from json."
   (concat
@@ -308,6 +313,30 @@ return t on success."
     (goto-char (prop-match-beginning match))
     t))
 
+
+(define-fringe-bitmap 'pr-review-comment
+  [#b0000000000000000
+   #b0000000000000000
+   #b0000000000000000
+   #b0000000000000000
+   #b0000000000000000
+   #b0111111111111100
+   #b1111111111111110
+   #b1111111111111110
+   #b1110000000011110
+   #b1111111111111110
+   #b1111111111111110
+   #b1110000011111110
+   #b1111111111111110
+   #b1111111111111110
+   #b1111111111111110
+   #b0111111111111100
+   #b0000000011111000
+   #b0000000001111000
+   #b0000000000111000
+   #b0000000000011000]
+  nil 16 'center)
+
 (defun pr-review--insert-in-diff-pending-review-thread (pending-review-thread &optional allow-fallback)
   "Insert a pending review thread inside the diff for PENDING-REVIEW-THREAD.
 If ALLOW-FALLBACK is non-nil, when the line for the thread cannot be found.
@@ -319,12 +348,18 @@ It will be inserted at the beginning."
                   allow-fallback)
           (forward-line)
           (setq beg (point))
-          (insert (propertize (concat "> PENDING comment for "
-                                      (if .startLine
-                                          (format "%s:%s to %s:%s" .startSide .startLine .side .line)
-                                        (format "%s:%s" .side .line))
-                                      "\n")
-                              'face 'pr-review-in-diff-pending-begin-face))
+          (insert (apply #'propertize
+                         (concat "> PENDING comment for "
+                                 (if .startLine
+                                     (format "%s:%s to %s:%s" .startSide .startLine .side .line)
+                                   (format "%s:%s" .side .line))
+                                 "\n")
+                         'face 'pr-review-in-diff-pending-begin-face
+                         (when pr-review-fringe-icons
+                           (list 'line-prefix
+                                 (propertize " " 'display '(left-fringe
+                                                            pr-review-comment
+                                                            pr-review-fringe-comment-pending))))))
           (pr-review--insert-fontified .body 'gfm-mode nil
                                        'pr-review-in-diff-pending-body-face)
           (insert (propertize " \n" 'face 'pr-review-in-diff-pending-end-face))
@@ -345,7 +380,8 @@ It will be inserted at the beginning."
                .path .diffSide .line)
           (forward-line)
           (insert
-           (propertize
+           (apply
+            #'propertize
             (concat (format "> %s comments from " (length .comments.nodes))
                     (string-join
                      (seq-uniq
@@ -358,7 +394,13 @@ It will be inserted at the beginning."
             'face 'pr-review-in-diff-thread-title-face
             'pr-review-eldoc-content (let-alist (car .comments.nodes)
                                        (concat (pr-review--propertize-username .author.login)
-                                               ": " .body))))
+                                               ": " .body))
+            (when pr-review-fringe-icons
+              (list 'line-prefix
+                    (propertize " " 'display `(left-fringe pr-review-comment
+                                                           (if .isResolved
+                                                               pr-review-fringe-comment-resolved
+                                                             pr-review-fringe-comment-open)))))))
           (insert-button
            "Go to thread"
            'face 'pr-review-button-face

pr-review.el

@@ -139,6 +139,9 @@ Which means that all sections are collapsed."
                                         pr-review--commit-section
                                         pr-review--description-section
                                         pr-review--event-section))
+  (when pr-review-fringe-icons
+    (unless (and left-fringe-width (>= left-fringe-width 16))
+      (setq left-fringe-width 16)))
   (add-to-list 'kill-buffer-query-functions 'pr-review--confirm-kill-buffer)
   (add-hook 'eldoc-documentation-functions #'pr-review--eldoc-function nil t)
   (eldoc-mode))