pi-pair-programmer 0.1.3 → 0.1.4
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/README.md +82 -24
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,65 +1,111 @@
|
|
|
1
|
-
|
|
1
|
+
<a id="top"></a>
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<div align="center">
|
|
4
|
+
|
|
5
|
+
# 🧑💻 Pi Pair Programmer
|
|
6
|
+
|
|
7
|
+
**Background code review for [Pi](https://pi.dev/docs/extensions) and [OMP](https://omp.sh/docs/extension-authoring).**
|
|
8
|
+
|
|
9
|
+
[](https://github.com/T-moz/pi-pair-programmer/actions/workflows/ci.yml)
|
|
10
|
+
[](vitest.config.ts)
|
|
11
|
+
[](https://www.npmjs.com/package/pi-pair-programmer)
|
|
12
|
+
[](https://www.npmjs.com/package/pi-pair-programmer)
|
|
13
|
+
[](package.json)
|
|
14
|
+
[](tsconfig.json)
|
|
15
|
+
[](LICENSE)
|
|
16
|
+
|
|
17
|
+
[**Why**](#-why) · [**Install**](#-install) · [**Use**](#-use) · [**How it works**](#-how-it-works)
|
|
18
|
+
|
|
19
|
+
<br />
|
|
4
20
|
|
|
5
21
|
|
|
6
22
|
|
|
7
|
-
|
|
23
|
+
</div>
|
|
8
24
|
|
|
9
|
-
|
|
10
|
-
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## 🤔 Why
|
|
28
|
+
|
|
29
|
+
> **Coding with AI adds entropy to a codebase.**
|
|
30
|
+
> Agents optimize for local correctness instead of thinking about the global system. They repeat code and reinvent the wheel.
|
|
11
31
|
|
|
12
32
|
Turn-by-turn static analysis is necessary but not sufficient.
|
|
13
33
|
Code review happens too late in the code production pipeline.
|
|
14
34
|
|
|
15
|
-
|
|
35
|
+
<p align="center">
|
|
36
|
+
<img src="assets/cost-to-fix.svg" alt="Cost to fix rises from standards and static analysis to PR checks, AI PR review, and human PR review; Pi Pair Programmer reviews right after each write" />
|
|
37
|
+
</p>
|
|
16
38
|
|
|
17
|
-
This extension lets you run multiple highly specialized reviewers, each focused on a specific concern, to catch issues static analysis cannot detect as soon as code is generated. Without bloating the context window, thanks to a Jev-based filter that removes inherited and duplicate findings.
|
|
39
|
+
This extension lets you run multiple highly specialized reviewers, each focused on a specific concern, to catch issues static analysis cannot detect, as soon as code is generated. Without bloating the context window, thanks to a Jev-based filter that removes inherited and duplicate findings.
|
|
18
40
|
|
|
19
|
-
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## 📦 Install
|
|
20
44
|
|
|
21
45
|
Install the published [npm package](https://www.npmjs.com/package/pi-pair-programmer).
|
|
22
46
|
|
|
23
|
-
|
|
47
|
+
<table>
|
|
48
|
+
<tr>
|
|
49
|
+
<th>With Pi</th>
|
|
50
|
+
<th>With OMP</th>
|
|
51
|
+
</tr>
|
|
52
|
+
<tr>
|
|
53
|
+
<td>
|
|
24
54
|
|
|
25
55
|
```sh
|
|
26
56
|
pi install npm:pi-pair-programmer
|
|
27
57
|
```
|
|
28
58
|
|
|
29
|
-
|
|
59
|
+
</td>
|
|
60
|
+
<td>
|
|
30
61
|
|
|
31
62
|
```sh
|
|
32
63
|
omp install pi-pair-programmer
|
|
33
64
|
```
|
|
34
65
|
|
|
66
|
+
</td>
|
|
67
|
+
</tr>
|
|
68
|
+
</table>
|
|
69
|
+
|
|
35
70
|
Restart Pi or OMP after installation to load the extension.
|
|
36
71
|
|
|
37
|
-
For the Jev filter, set your TypeSafe API key before starting Pi or OMP:
|
|
72
|
+
🔑 For the Jev filter, set your TypeSafe API key before starting Pi or OMP:
|
|
38
73
|
|
|
39
74
|
```sh
|
|
40
75
|
export TYPESAFE_API_KEY="your-api-key"
|
|
41
76
|
```
|
|
42
77
|
|
|
43
|
-
|
|
78
|
+
> [!NOTE]
|
|
79
|
+
> Without it, reviews still run, but only exact duplicate findings are filtered.
|
|
44
80
|
|
|
45
|
-
|
|
81
|
+
---
|
|
46
82
|
|
|
47
|
-
|
|
83
|
+
## 🧭 Use
|
|
48
84
|
|
|
49
|
-
|
|
85
|
+
Reviews are on by default. After each successful `write` or `edit`, reviewers run in the background. The coding agent must accept or reject each finding with a reason before continuing with other tools. Only accepted findings appear in your transcript.
|
|
50
86
|
|
|
51
|
-
|
|
87
|
+
| Command | Action |
|
|
88
|
+
| ------------------ | --------------------------------------------------------------------------------------------------- |
|
|
89
|
+
| `/pair-programmer` | Toggle reviews. |
|
|
90
|
+
| `/pair-clear` | Cancel reviews and clear all findings. |
|
|
91
|
+
| `/pair-stats` | View review activity, findings, tokens, and estimated costs on demand; missing usage stays unknown. |
|
|
52
92
|
|
|
53
|
-
The default reviewer uses your current model and asks: “Does it add entropy?” To change the prompt, model, or files reviewed, create `pair-programmer.reviewers.json` in your working directory:
|
|
93
|
+
The default reviewer uses your current model and asks: _“Does it add entropy?”_ To change the prompt, model, or files reviewed, create `pair-programmer.reviewers.json` in your working directory:
|
|
54
94
|
|
|
55
95
|
```json
|
|
56
96
|
{
|
|
57
97
|
"reviewers": [
|
|
58
98
|
{
|
|
59
99
|
"model": "current",
|
|
60
|
-
"prompt": "Does
|
|
61
|
-
"include": ["
|
|
62
|
-
"exclude": ["**/*.
|
|
100
|
+
"prompt": "Does this code add entropy?",
|
|
101
|
+
"include": ["**/*.dart"],
|
|
102
|
+
"exclude": ["**/*.g.dart", "**/*_test.dart"]
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"model": "current",
|
|
106
|
+
"prompt": "Does this code reinvent the wheel instead of reusing code or a library?",
|
|
107
|
+
"include": ["**/*.dart"],
|
|
108
|
+
"exclude": ["**/*.g.dart", "**/*_test.dart"]
|
|
63
109
|
}
|
|
64
110
|
]
|
|
65
111
|
}
|
|
@@ -67,9 +113,21 @@ The default reviewer uses your current model and asks: “Does it add entropy?
|
|
|
67
113
|
|
|
68
114
|
Use `current` or a `provider/model` identifier. File patterns are relative to your working directory; exclusions take precedence. Add entries for more reviewers.
|
|
69
115
|
|
|
70
|
-
|
|
71
|
-
|
|
116
|
+
> [!TIP]
|
|
117
|
+
> Diagnostics stay in files, never the terminal: OMP uses its native logs; Pi uses `~/.pi/agent/logs/pair-programmer/` (or `$PI_CODING_AGENT_DIR/logs/pair-programmer/`).
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## 🔍 How it works
|
|
122
|
+
|
|
123
|
+
<p align="center">
|
|
124
|
+
<img src="assets/pair-programmer-workflow.svg" alt="Review workflow: background reviewers, Jev filters, and the accept/reject gate" />
|
|
125
|
+
</p>
|
|
126
|
+
|
|
127
|
+
<div align="center">
|
|
128
|
+
|
|
129
|
+
<sub>Released under the [MIT License](LICENSE) · [Contributing](CONTRIBUTING.md) · [Security](SECURITY.md)</sub>
|
|
72
130
|
|
|
73
|
-
|
|
131
|
+
<a href="#top">⬆ Back to top</a>
|
|
74
132
|
|
|
75
|
-
|
|
133
|
+
</div>
|