Revue Companion
Your repository's pull requests from Revue, in
VS Code and the editors built on it (VSCodium, Cursor, Windsurf…): the list,
each one's page, your branch's to open or create, its changes and your pending
comments in the editor, and a review of it with its conversations on their
lines.
It talks to Revue only through the revue command, so it never holds a token:
Revue signs in to GitHub, Bitbucket or Forgejo, Jira and Slack, and answers.

What it does
- Revue: Open or Create Pull Request (the Command Palette, the Source
Control view's title, the status bar item with the branch's pull request's
number and state) opens the branch's pull request in Revue, or Revue's
New pull request page when the branch has none, once you confirm.
- The Pull Requests view (the Revue icon in the activity bar) lists the
repository's open pull requests as Revue sees them, in its sections (To
review, Reviewed before, Mine, Others), favorites first, the
branch's on a card above them. The filter picks yours, review requests or
all, with drafts or not; the search field filters them; more load as you
scroll. A pull request's page has its state, author and branches, Review
in IDE, Open in Revue, open it on its service, copy either link,
Switch to Branch, Create Worktree and its star; then tabs for how it
stands, its files, the conversation, its Slack threads and its stack.
Escape goes back.
- In a file the branch's pull request changes, the gutter marks what it
changes against the file before it: VS Code's own stripes, peek, and next
and previous change. Revue: Show Pull Request Diff, Open File in
Pull Request, Go to Pull Request File… and Add Pending Comment…
are in the editor's context menu and the Command Palette, and your pending
comments are marked on their lines.
- Review in IDE on a pull request's page, or Revue: Review Pull
Request for your branch's, opens its files in VS Code's multi-file diff
editor, before it and at its head (the branch needn't be checked out). The
files' text comes from your clone's Git when it can, else from Revue.
- Its conversations and your drafts are VS Code comment threads on their
lines, with a Pending label on what you haven't sent: reply,
Resolve and Reopen, edit and delete your pending comments, and
react with GitHub's emoji. Click the gutter's + (or drag it over
several lines) to comment: Add Comment keeps a draft in Revue, Add
to Your Pending Review adds it to your pending review on GitHub when you
have one.
@ suggests who can be mentioned. A suggested change shows as
a diff of its lines, with Apply to Your Copy.
- The Revue Review view: how many files and lines it changes, how many
you've viewed and how many conversations are open, Submit Review, and
its files as a tree, each with its status, lines and open conversations
and a Viewed checkbox. A click opens the file's diff, where Mark
Viewed goes on to the next file not viewed. VS Code's Comments panel
lists the conversations, unresolved ones filtered as you like.
- Submit Review opens Finish your review beside the diff: the
summary (Markdown, with Write and Preview and
@ mentions), the
comments that go with it, resolving the conversations you started when
approving, Notify in Slack (the thread, who to tag, each verdict's
reply), and Revue's verdicts (Comment, Request changes, Approve) as
buttons, each saying why when it can't be used.
- Drafts are Revue's own: what you add here shows in Revue at once, and
what you add there shows here within a minute.
- Revue: Account says whether Revue is signed in to your Revue account,
as which computer, and the services it's signed in to. Revue: Sign in to
Revue approves this computer in your browser; while it waits, a
notification offers Open the Browser Again and Cancel. Where Revue
isn't signed in to the repository's service, the view and a notification
offer Sign in to Revue…, Open Revue and Retry.
- Open in editor in Revue opens a pull request's file in the VS Code
window that has its repository (or its folder in a new window).
What VS Code can't do: show a commit in a Git log an extension points at,
and preview Markdown while writing a comment on a line (the comment box is
VS Code's own). The summary in Finish your review has both Write and
Preview.




Requirements
- Revue, installed. The extension asks the
revue command each question
only once its revue --version says it knows it (editor N): the list
and pages from editor 1; answers without the Revue app running from
editor 2; the pull request's diff from editor 3; reviewing from
editor 4 (resolving and Finish your review's options from editor 5,
Viewed from editor 7, reactions and who can be mentioned from
editor 8); your Revue account from editor 6; Open in editor from
editor 9.
- VS Code 1.95 or later, or an editor built on it, with its built-in Git
extension.
Settings
- Revue Companion: Path (
revueCompanion.path): the revue executable.
Empty: found on PATH, then where Revue's installers put it
(~/.local/bin/revue on Linux, /Applications/Revue.app and
~/Applications/Revue.app on macOS, %LOCALAPPDATA%\Programs\Revue\revue.exe
on Windows).
- Revue Companion: When Not Running (
revueCompanion.whenNotRunning):
what to do when the Revue app isn't running. Answer without it (the
default, with editor 2 or later: the revue command answers by itself,
with this computer's sign-ins or your Revue account's), Offer to start
it, or Start it.
Install
From the VS Code Marketplace or Open VSX:
search the Extensions view for Revue Companion. Each release's .vsix is
also attached to its release on Forgejo:
Extensions: Install from VSIX….
Working on it
From the repository's root, with Task, Node and, for
the tests in VS Code, a JDK (they use the JetBrains plugin's fake revue):
task vscode:unit-test # the unit tests, Node only
task vscode:test # those, then the tests in VS Code against the fake revue
task vscode:ui-test # a walk in VS Code, light and dark, pictures in vscode/build/ui-screenshots/
task vscode:sandbox # VS Code with the extension, against the fake revue, to try it by hand
task vscode:package # the .vsix, in vscode/build/
$FAKE_REVUE names a fake revue built already, $VSCODE_EXECUTABLE an
installed VS Code or VSCodium to test in (where the downloaded VS Code can't
run, as on NixOS; a code or codium launcher script is followed to the
editor itself). On Linux with Xvfb installed, the tests run on a virtual
display, nothing on screen; REVUE_TEST_ON_SCREEN=1 shows them. task vscode:sandbox opens the
extension in a development host of $VSCODE_EXECUTABLE, else code or
codium on PATH, on a sample repository on the fake pull request #7's
branch, its revue the fake one; the repository, the fake's state and the
editor's own settings and extensions are in vscode/build/sandbox-data/,
made again (and the review started over) each time. The vscode workflow
runs the tests, the UI walk and the package on every push touching the
extension. Releases go through the
release-vscode workflow: it publishes to Open VSX and attaches the .vsix
to a Forgejo release; the VS Code Marketplace upload is by hand.
License
MIT OR Apache-2.0, like Revue.
| |