JetBrains WebStorm IDE

How to Trigger Local Code Review Using git-lrc in WebStorm IDE

Here are the instructions on how to trigger a local code review using git-lrc in your WebStorm IDE environment.

Prerequisites

1. The instructions below only work if you have installed and set up git-lrc on your local machine.

Method 1: Using WebStorm's Built-in Terminal

Once your code changes are ready for commit, follow these commands from the WebStorm built-in terminal:

1. Stage your changes:

   git add .

2. Commit with a message:

   git commit -m "commit message"

3. Review automatically starts:
   git-lrc will automatically spin up a local server, and you can review the code comments from there.

4. Complete the review:
   Once reviewed, you can either continue with the commit or abort it—either from the review UI running on localhost or from the terminal itself.

Method 2: Using WebStorm's Git Tool

WebStorm has Git tools integrated into the platform. If you're committing your changes using this option, here's the flow:

1. Start the review from terminal:

   lrc review --staged

(You can also use --skip or --vouch flags)

2. Review in browser:
   git-lrc starts, and you can see the review/comments in the localhost web UI.

3. Commit from WebStorm:
   Once reviewed, add a commit message in the Git tools commit box and click Commit or Commit & Push.