prq-cli 0.1.2
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/LICENSE +21 -0
- package/README.md +82 -0
- package/dist/bin/prq.js +10508 -0
- package/package.json +53 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Caio Pizzol
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# prq
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/prq)
|
|
4
|
+
|
|
5
|
+
PR Queue — see what code reviews need your attention.
|
|
6
|
+
|
|
7
|
+
A CLI tool that queries GitHub and shows you a categorized view of PRs that need action. No more missing review requests because someone forgot to re-request, no more stale PRs sitting idle.
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
bun install -g prq
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Requires [GitHub CLI](https://cli.github.com/) (`gh`) to be authenticated.
|
|
16
|
+
|
|
17
|
+
## Quick Start
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
# Set up config for the current project
|
|
21
|
+
prq init
|
|
22
|
+
|
|
23
|
+
# See your review queue
|
|
24
|
+
prq
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Commands
|
|
28
|
+
|
|
29
|
+
### `prq status` (default)
|
|
30
|
+
|
|
31
|
+
Shows PRs needing your attention, grouped into four categories:
|
|
32
|
+
|
|
33
|
+
- **Needs Re-review** — you left a review, but new commits were pushed after
|
|
34
|
+
- **Requested Reviews** — you're a requested reviewer and haven't reviewed yet
|
|
35
|
+
- **Stale** — PRs you're involved in with no activity for N days
|
|
36
|
+
- **Your PRs Waiting** — PRs you authored that are waiting on someone else
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
prq # all repos you have access to
|
|
40
|
+
prq status --repos org/repo1 org/repo2 # specific repos
|
|
41
|
+
prq status --stale-days 7 # custom stale threshold
|
|
42
|
+
prq status --json # machine-readable output
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### `prq init`
|
|
46
|
+
|
|
47
|
+
Creates a `.prqrc.json` config file in the current directory.
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
prq init
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Configuration
|
|
54
|
+
|
|
55
|
+
Config is loaded in this order (later overrides earlier):
|
|
56
|
+
|
|
57
|
+
1. `~/.config/prq/config.json` — global defaults
|
|
58
|
+
2. `.prqrc.json` — per-project config
|
|
59
|
+
3. CLI flags
|
|
60
|
+
|
|
61
|
+
Example `.prqrc.json`:
|
|
62
|
+
|
|
63
|
+
```json
|
|
64
|
+
{
|
|
65
|
+
"repos": ["org/repo1", "org/repo2"],
|
|
66
|
+
"staleDays": 5
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Development
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
bun install
|
|
74
|
+
bun run dev # run the CLI
|
|
75
|
+
bun test # run tests
|
|
76
|
+
bun run lint # check lint + formatting
|
|
77
|
+
bun run typecheck # type check
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## License
|
|
81
|
+
|
|
82
|
+
MIT
|