@henryqw/pi-ask-question 0.1.2 → 0.1.3
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 +13 -16
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# `@henryqw/pi-ask-question`
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Ask the user one interactive question with up to three choices, or a custom answer.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
@@ -8,7 +8,11 @@ Pi extension exposing `ask_question`, an interactive tool for asking user one qu
|
|
|
8
8
|
pi install npm:@henryqw/pi-ask-question
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
## Use
|
|
12
|
+
|
|
13
|
+
| Surface | Purpose |
|
|
14
|
+
| --- | --- |
|
|
15
|
+
| `ask_question` | Pause for one interactive answer. |
|
|
12
16
|
|
|
13
17
|
```json
|
|
14
18
|
{
|
|
@@ -21,9 +25,9 @@ Tool accepts:
|
|
|
21
25
|
}
|
|
22
26
|
```
|
|
23
27
|
|
|
24
|
-
Supply one to three
|
|
28
|
+
Supply one to three options in preference order. UI marks the first `(Recommended)` and adds `Something else.` for a custom answer. Number keys select options. Empty questions, blank or duplicate labels, empty lists, more than three options, and non-interactive sessions return an error. Aborting the tool closes the pending question.
|
|
25
29
|
|
|
26
|
-
Remove
|
|
30
|
+
## Remove
|
|
27
31
|
|
|
28
32
|
```bash
|
|
29
33
|
pi remove npm:@henryqw/pi-ask-question
|
|
@@ -32,20 +36,13 @@ pi remove npm:@henryqw/pi-ask-question
|
|
|
32
36
|
## Development
|
|
33
37
|
|
|
34
38
|
```bash
|
|
35
|
-
npm test
|
|
36
|
-
npm run typecheck
|
|
37
|
-
npm run pack:check
|
|
39
|
+
npm test --workspace @henryqw/pi-ask-question
|
|
40
|
+
npm run typecheck --workspace @henryqw/pi-ask-question
|
|
41
|
+
npm run pack:check --workspace @henryqw/pi-ask-question
|
|
38
42
|
```
|
|
39
43
|
|
|
40
|
-
|
|
44
|
+
Manual TUI check outside CI:
|
|
41
45
|
|
|
42
46
|
```bash
|
|
43
|
-
npm run test:manual
|
|
47
|
+
npm run test:manual --workspace @henryqw/pi-ask-question
|
|
44
48
|
```
|
|
45
|
-
|
|
46
|
-
Pass criteria:
|
|
47
|
-
|
|
48
|
-
1. Agent calls `ask_question` instead of asking in plain text.
|
|
49
|
-
2. UI shows one to three useful choices, first marked `(Recommended)`, plus `Something else.`.
|
|
50
|
-
3. Option descriptions explain tradeoffs without repeating labels.
|
|
51
|
-
4. Number key selects matching option; custom choice accepts typed answer; `Esc` cancels.
|