What is PR Latch?

Latch is a tool to help streamline the process of reviewing pull requests. It displays the latest pull requests given a repo and automates the process of starting up environments so you spend less time at the command-line and more time contributing.

Installation

# install globally
npm i -g prlatch

Initialization

First, ensure there is a created personal access token for usage with the Github API.

# prompts for github credentials and generates default .latchrc.json
latch init

Commands

init                         creates .latchrc.json with default values
env-up [project-aliases...]  starts the server for each project alias stipulated
env-down                     stops all project servers
env-new                      prompt to create a new project and updates .latchrc.json
list                         lists all projects in .latchrc.json
review <project-alias>       shows all open PR's on the projects repo

Creating a new environment

The first time env-new is ran, you will be prompted for the main project directory. This is an absolute path to your code folder (Note: projects will not be available for selection if they are not in this directory)

There will be a prompt for an alias, which is a shorthand to start the project's PR review flow or server.

Start command uses the command to start the project. E.g: npm start.

Port is... well, it's the port.

? What is a good alias for this project? example-alias
...
# Example alias usage
latch env-up example-alias
latch review example-alias
...
? Start command: npm [start | run dev | storybook | etc...]
? What port does this project run on? 3030

Running the Project Envs

env-up takes a space-delimited set of projects and runs each project in the background.

latch env-up alias-one alias-two

To kill these background processes running on the given ports:

latch env-down

Review Flow

latch review <project-alias> offers a selection of the current open pull requests in the repo. Selecting an pr will git fetch, checkout, and pull the latest code changes for the given project and pull request. It will then open the default browser to view the PR and proceeds to open the directory with VSCode.

Where are the tests?!?

Meh. Piss off. ;)