Skip to main content

Inline PR comments as local files

Project description

prfs

Pull Request File System. PR review comments as local files. Browse, filter, and script against GitHub PR review threads using familiar Unix tools.

Installation

uv tool install prfs

How it works

prfs fetch pulls comments from a GitHub PR to {repo}/.prfs/{pr_number}/{thread_id}.md. One markdown file per thread with YAML frontmatter containing the file path and git patch.

Quick start

gh auth login # gh is used under the hood
prfs fetch

Features

  • One file per review thread
  • Works offline after initial fetch
  • Natively integrates with rg, vim, etc.

Format

Each thread file contains:

  • file: path and line number (src/utils.js:42). This format is supported by Vim jumps with gF.
  • patch: the git diff where the comment thread was attached to.
  • Comments in markdown separated with ---.

Example comment file (.prfs/123/456.md):

---
file: src/utils.js:42
patch: |
  diff --git a/src/utils.js b/src/utils.js
  --- a/src/utils.js
  +++ b/src/utils.js
  @@ -40,7 +40,7 @@ function getUser() {
    const db = connect();
  -  return db.query('users');
  +  return await db.query('users');
  }
---

The return type should be `Promise<User>` not `User`.

~@alice

---

Good catch. I'll fix it.

~@bob

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

prfs-0.2.0.tar.gz (24.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

prfs-0.2.0-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file prfs-0.2.0.tar.gz.

File metadata

  • Download URL: prfs-0.2.0.tar.gz
  • Upload date:
  • Size: 24.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for prfs-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9176a6543b960ba9c2a73ba9e66f2afde42e1130ba14fa402a1e2ec9c4482642
MD5 0883f358d7becc88a314dec0dd8b897c
BLAKE2b-256 a5877604f73b6bd8f89d4fd46b04b221eb5b79963e6b5f8323f1264e8a2f763b

See more details on using hashes here.

File details

Details for the file prfs-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: prfs-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for prfs-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9f925ee3b23a7b528a63bc122a71a347a805be71cd4f4ae91a5776c9db7c2f03
MD5 80a3d72d6600430869099d40ed4aa38d
BLAKE2b-256 042709cacf573612918315b1bfe031f074074d05687cd3d0a1e58e77df14c1f4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page