prreviewbuddy 0.30.0 → 0.34.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,114 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.34.0
4
+
5
+ **The Guide shows one theme at a time.** The workspace Guide used to stack every theme in one
6
+ column, so reading the second one meant scrolling past the whole of the first. The rail already
7
+ lists the themes, so it now drives the page: choosing one shows that theme on its own, and the
8
+ rail says how long each is likely to take. The theme tag on an issue or question opens its theme,
9
+ which it always named and never did. In a window too narrow for the rail, the same themes appear
10
+ above the theme itself.
11
+
12
+ A theme now reads in the order the work happens: why it matters, then what to check, then the files
13
+ it touches. That order is better on both surfaces, so the browser extension's Guide gets it too, and
14
+ is unchanged otherwise. Its parts stand apart rather than running together, and the theme itself is
15
+ no longer drawn as a card: with one theme on the page, the outline had nothing on the other side of
16
+ it. Nothing folds a theme away any more either, since there is now nothing behind it to reveal.
17
+
18
+ **The rail says what is left, in words.** A theme row gives the time it takes and, when something is
19
+ still open on it, how much: "~22 min, 1 of 2 issues left". That count used to be a bare digit whose
20
+ meaning only a screen reader was told. The file count has gone from the rail, which is what leaves
21
+ room to spell the rest out. Clicking the words "Review path" folds the list, not just the caret.
22
+
23
+ **The Overview's numbers read as numbers.** Each stat card leads with the figure and sets the label
24
+ beside it, so the four cards line up whether or not one of them carries a second line.
25
+
26
+ Two things that were wrong wherever you looked. The document pane was painted a slightly different
27
+ grey from the page behind it, leaving a seam down every view. And in a window too narrow for the
28
+ rail, the review was squeezed into the width the rail had vacated, with half the window empty beside
29
+ it.
30
+
31
+ The progress line no longer counts what it cannot change: completing a theme is part of guided
32
+ review, which the workspace does not have, so the Guide states the size of the job rather than
33
+ reporting nothing done.
34
+
35
+ ## 0.33.0
36
+
37
+ **A type scale, a palette for the review, and fewer boxes.** Text in the workspace now comes from
38
+ seven named sizes rather than fifteen ad-hoc ones, so a heading, a sentence, a piece of metadata and
39
+ a status chip differ by size instead of by weight, and ordinary text is ordinary weight again. The
40
+ review itself now has its own light palette: three greys where one grey had been written several
41
+ ways, a single hairline where six different border shades were drawing the same line, and one purple
42
+ where there were five. Seven panels that were a box drawn inside another box have lost their
43
+ outline and sit on the page as white cards against a slightly deeper background. Purple now marks
44
+ what you have selected, what has keyboard focus, and the main action on a page, so hovering a row no
45
+ longer shouts as loudly as choosing one. The browser extension is unchanged.
46
+
47
+ ## 0.32.1
48
+
49
+ **The rail on every workspace page.** The reviews list, Notifications and Settings now carry the
50
+ same rail a review does, so Reviews, Notifications and Settings are always one click away without
51
+ opening a review first. A review's rail keeps everything it had, with the workspace places beneath
52
+ it. The unread count sits beside Notifications wherever the rail is. In a window too narrow for the
53
+ rail, the same places appear in the header instead.
54
+
55
+ ## 0.32.0
56
+
57
+ **Notifications.** When a review, reanalysis, update or KISS analysis finishes or fails, PR Review
58
+ Buddy now records it on a new Notifications page in the workspace, so you can start a review, or a
59
+ batch of them, get on with something else, and see what finished when you come back. The reviews
60
+ list shows how many are unread, and every review's rail links to the page. Opening a notification
61
+ takes you to its review and marks it read, and Mark all read clears the rest; visiting the review
62
+ some other way leaves it unread. A review you stop with Ctrl-C is not recorded as a failure.
63
+ Notifications are kept for thirty days, on this machine only, and nothing about them is sent
64
+ anywhere.
65
+
66
+ **Toasts in the workspace.** While any workspace page is open, a notification also appears for a
67
+ few seconds in the bottom-right corner, with Open beside it. It stays while your pointer is on it,
68
+ and no more than three show at once: when a batch finishes together, the last one says how many more
69
+ there are, with View all. Letting a toast go or dismissing it leaves the notification unread on the
70
+ Notifications page.
71
+
72
+ **Closing the terminal no longer strands a review.** The CLI used to say a review continues if its
73
+ terminal closes. It did not: the review stopped with the terminal, and running the command again
74
+ said it was still being made for the next half hour. The message now asks you to keep the terminal
75
+ open, and running the same command again picks the review up at once from the step it reached.
76
+
77
+ Also fixed: a review picked up part way through its analysis showed that step as finished while it
78
+ was still running.
79
+
80
+ ## 0.31.0
81
+
82
+ **Review a single commit.** `prreviewbuddy review --commit <commit>` reviews the change one commit
83
+ made, compared against the commit before it. Name the commit however git lets you: a sha, `HEAD~2`
84
+ or a tag. A merge commit is compared against its first parent, and the review says so; the very
85
+ first commit in a repository is compared against nothing, so every file in it is new.
86
+
87
+ A commit never changes, so its review does not go out of date. The review page says "Freshness:
88
+ Fixed" instead of offering to update it, and `--update` is refused with a pointer to `--reanalyse`,
89
+ which analyses the same commit again and keeps the earlier analysis beside the new one. If the commit
90
+ later disappears from your repository, after a force-push for example, the review still opens in
91
+ full and says the commit is gone. `--commit` cannot be combined with `--base`, because the commit
92
+ before it is the base; to compare a branch against a base of your choosing, use `--branch` with
93
+ `--base` as before.
94
+
95
+ Reviews of the same commit share one card on the reviews list, named `commit` and its short sha, and
96
+ searching the list for the sha finds it. A review of a commit and a review of the branch that
97
+ contains it stay separate.
98
+
99
+ **A detached checkout points at `--commit HEAD`.** Running `prreviewbuddy review` on a detached HEAD
100
+ is still refused, because there is no branch to file the review under, and the message now offers
101
+ `prreviewbuddy review --commit HEAD` to review the commit you are on.
102
+
103
+ **A calmer Files tab.** Each file's issue and question counts are now small icons with a number, in
104
+ a column of their own on the right, instead of labels that squeezed long filenames onto several
105
+ lines. The label naming a second theme that also mentions a file is gone: the file is already listed
106
+ under its own theme, and its counts still include every finding. Added, modified, removed and renamed
107
+ files now each have their own colour, and the labels are all one width so the paths line up.
108
+
109
+ **The review header stays on one line.** On a narrow window the branch, commit and controls at the
110
+ top of a review no longer wrap onto a second line.
111
+
3
112
  ## 0.30.0
4
113
 
5
114
  **Usage telemetry is now on by default.** Non-identifying usage telemetry is now enabled by default