pi-do-always 0.7.0 → 0.8.0
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
CHANGED
|
@@ -12,21 +12,22 @@ type to filter, scroll or click, or navigate with arrows + Enter → the task's
|
|
|
12
12
|
do-always — pick a task
|
|
13
13
|
|
|
14
14
|
PLAN
|
|
15
|
-
▸ 1. ⚡ Review
|
|
16
|
-
2. ⚡
|
|
17
|
-
3. ⚡
|
|
18
|
-
4. ⚡
|
|
19
|
-
5. ⚡
|
|
15
|
+
▸ 1. ⚡ Review changes Review the current code changes (Plan)
|
|
16
|
+
2. ⚡ Review code Review the whole project's code quality (Plan)
|
|
17
|
+
3. ⚡ Cleanup Clean up dead code and duplicates (Plan)
|
|
18
|
+
4. ⚡ Security Security audit (Plan)
|
|
19
|
+
5. ⚡ Performance Performance review (Plan)
|
|
20
|
+
6. ⚡ Propose features Propose new features (Plan)
|
|
20
21
|
DO
|
|
21
|
-
|
|
22
|
-
|
|
22
|
+
7. Build Test build is ok and fix issues
|
|
23
|
+
8. Tests Run tests and fix failures
|
|
23
24
|
DOCS
|
|
24
|
-
|
|
25
|
+
9. Readme Update the README.md
|
|
25
26
|
OPS
|
|
26
|
-
|
|
27
|
-
|
|
27
|
+
10. Release Prepare a release (version, changelog, tag)
|
|
28
|
+
11. Commit Prepare a clean commit
|
|
28
29
|
|
|
29
|
-
Review — prompt:
|
|
30
|
+
Review changes — prompt:
|
|
30
31
|
Review the changes on branch fix/login-null (3 changed files: auth.ts, login.ts,
|
|
31
32
|
test/auth.test.ts). Last commit: Fix null check in login. Check `git status` and
|
|
32
33
|
`git diff` to see what changed, then double-check the changes for bugs, edge …
|
|
@@ -42,7 +43,7 @@ type to filter, scroll or click, or navigate with arrows + Enter → the task's
|
|
|
42
43
|
|---|---|
|
|
43
44
|
|`/do-always` or the shortcut key (default `F4`)|Show the numbered task selector|
|
|
44
45
|
|`/do-always 2`|Fill the prompt for task #2 directly|
|
|
45
|
-
|`/do-always review`|Fill the prompt for the task named `review` (task names autocomplete after `/do-always`)|
|
|
46
|
+
|`/do-always review changes`|Fill the prompt for the task named `review changes` (task names autocomplete after `/do-always`)|
|
|
46
47
|
|`/do-always list`|Print the task list|
|
|
47
48
|
|`/do-always list-details`|Show the full rendered prompt text each task will inject|
|
|
48
49
|
|
|
@@ -87,7 +88,7 @@ Tasks are read from JSON files (an array of tasks, or the object form `{"tasks":
|
|
|
87
88
|
|`~/.pi/agent/do-always.json`|Global (all projects)|
|
|
88
89
|
|`<project>/.pi/do-always.json`|Project-local; overrides global tasks with the same `name`|
|
|
89
90
|
|
|
90
|
-
If neither file exists, the built-in defaults (Review, Cleanup, Security, Performance, Propose features, Build, Tests, Readme, Release, Commit) are used.
|
|
91
|
+
If neither file exists, the built-in defaults (Review changes, Review code, Cleanup, Security, Performance, Propose features, Build, Tests, Readme, Release, Commit) are used.
|
|
91
92
|
This repo ships a sample in [`do-always.json`](./extensions/pi-do-always/do-always.json) — copy it to one of the
|
|
92
93
|
locations above to make it your own:
|
|
93
94
|
|
|
@@ -133,7 +134,7 @@ Reload Pi (or start a new session) after editing a config file.
|
|
|
133
134
|
## Prompt placeholders
|
|
134
135
|
|
|
135
136
|
Task prompts support `{{placeholders}}` that are filled in from the current
|
|
136
|
-
directory when a task is selected — so `/do-always review` on a hotfix branch
|
|
137
|
+
directory when a task is selected — so `/do-always review changes` on a hotfix branch
|
|
137
138
|
injects “Review the changes on branch `fix/login-null` (3 changed files:
|
|
138
139
|
`auth.ts`, `login.ts`, `test/auth.test.ts`) …” instead of a generic nudge.
|
|
139
140
|
|
|
@@ -2,11 +2,18 @@
|
|
|
2
2
|
"shortcut": "f4",
|
|
3
3
|
"tasks": [
|
|
4
4
|
{
|
|
5
|
-
"name": "Review",
|
|
5
|
+
"name": "Review changes",
|
|
6
6
|
"category": "Plan",
|
|
7
|
-
"
|
|
7
|
+
"requireDirty": true,
|
|
8
|
+
"description": "Review the current code changes (Plan)",
|
|
8
9
|
"prompt": "Review the changes on branch {{branch}} ({{files_changed_count}} changed files: {{files_changed}}). Last commit: {{last_commit}}. Check `git status` and `git diff` to see what changed, then double-check the changes for bugs, edge cases, security issues, and consistency with the rest of the codebase. Do a plan proposal for the fixes if needed. Do a summary of your findings"
|
|
9
10
|
},
|
|
11
|
+
{
|
|
12
|
+
"name": "Review code",
|
|
13
|
+
"category": "Plan",
|
|
14
|
+
"description": "Review the whole project's code quality (Plan)",
|
|
15
|
+
"prompt": "Review this project's code holistically: identify code smells, dead code, duplication, awkward architecture or patterns, maintainability issues, inconsistencies, and missing or unclear documentation. Prioritize by impact, propose a plan for the fixes, and summarize your findings. Do not make any changes yet."
|
|
16
|
+
},
|
|
10
17
|
{
|
|
11
18
|
"name": "Cleanup",
|
|
12
19
|
"category": "Plan",
|
|
@@ -127,9 +127,9 @@ import { join } from "node:path";
|
|
|
127
127
|
/** Used when neither config file defines any task. */
|
|
128
128
|
export const DEFAULT_TASKS: DoAlwaysTask[] = [
|
|
129
129
|
{
|
|
130
|
-
name: "Review",
|
|
130
|
+
name: "Review changes",
|
|
131
131
|
category: "Plan",
|
|
132
|
-
description: "Review
|
|
132
|
+
description: "Review the current code changes (Plan)",
|
|
133
133
|
requireDirty: true,
|
|
134
134
|
prompt:
|
|
135
135
|
"Review the changes on branch {{branch}} ({{files_changed_count}} changed files: {{files_changed}}). " +
|
|
@@ -138,6 +138,14 @@ export const DEFAULT_TASKS: DoAlwaysTask[] = [
|
|
|
138
138
|
"edge cases, security issues, and consistency with the rest of the codebase. " +
|
|
139
139
|
"Do a plan proposal for the fixes if needed. Do a summary of your findings",
|
|
140
140
|
},
|
|
141
|
+
{
|
|
142
|
+
name: "Review code",
|
|
143
|
+
category: "Plan",
|
|
144
|
+
description: "Review the whole project's code quality (Plan)",
|
|
145
|
+
prompt:
|
|
146
|
+
"Review this project's code holistically: identify code smells, dead code, duplication, awkward architecture or patterns, maintainability issues, inconsistencies, and missing or unclear documentation. " +
|
|
147
|
+
"Prioritize by impact, propose a plan for the fixes, and summarize your findings. Do not make any changes yet.",
|
|
148
|
+
},
|
|
141
149
|
{
|
|
142
150
|
name: "Cleanup",
|
|
143
151
|
category: "Plan",
|