caique 0.0.1
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 +25 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.js +7 -0
- package/package.json +51 -0
package/README.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# caique
|
|
2
|
+
|
|
3
|
+
**Not yet released.** This version reserves the name; the first working release follows
|
|
4
|
+
[`docs/intents/cli-prompts/`](https://github.com/ofri-peretz/burgee/tree/main/docs/intents/cli-prompts).
|
|
5
|
+
|
|
6
|
+
A **caique** (kah-EEK) is a small, loud, never-silent parrot — and this one always answers
|
|
7
|
+
back. It is also the light wooden boat of the Bosphorus and the Greek islands, the one that
|
|
8
|
+
runs between the ship and the shore carrying people and messages across the gap. Both are
|
|
9
|
+
true of this package: it is the go-between that carries a question from a program to whoever
|
|
10
|
+
is calling, human or agent, and brings the answer back. **It never hangs.**
|
|
11
|
+
|
|
12
|
+
## What it will be
|
|
13
|
+
|
|
14
|
+
- **Every prompt is a flag first.** A caller who passes the flag is never asked. An agent
|
|
15
|
+
answers before the question, on the command line, in one pass.
|
|
16
|
+
- **Non-TTY never hangs.** No human on deck means an error that names the flag, exit 2, with
|
|
17
|
+
a fix a machine can apply and retry.
|
|
18
|
+
- **`--interactive`** asks for every missing required option in one pass; **`--yes`** accepts
|
|
19
|
+
every confirmation; cancellation exits `CANCELLED` and restores the terminal.
|
|
20
|
+
- **Accessible mode** falls back to line input with no live redraw.
|
|
21
|
+
- **Drop-in paths** for inquirer and clack, graded by their own suites.
|
|
22
|
+
|
|
23
|
+
Part of the [burgee](https://github.com/ofri-peretz/burgee) family: a CLI on burgee declares
|
|
24
|
+
what it is, roundel carries its colours, flagstaff flies it, caique answers back. Each is
|
|
25
|
+
an independent package; none requires the others.
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* caique — reserved. The first working release follows
|
|
3
|
+
* docs/intents/cli-prompts/ in the burgee repository. Until then this entry
|
|
4
|
+
* exports only its own name, so that importing it costs nothing and promises nothing.
|
|
5
|
+
*/
|
|
6
|
+
export declare const name: "caique";
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* caique — reserved. The first working release follows
|
|
3
|
+
* docs/intents/cli-prompts/ in the burgee repository. Until then this entry
|
|
4
|
+
* exports only its own name, so that importing it costs nothing and promises nothing.
|
|
5
|
+
*/
|
|
6
|
+
export const name = 'caique';
|
|
7
|
+
//# sourceMappingURL=index.js.map
|
package/package.json
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "caique",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "The parrot that always answers back, and the boat that goes between ship and shore. Prompts that are flags first, so agents answer before they are asked and non-TTY callers get an error naming the flag, never a hang. Drop-in path for inquirer and clack.",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"engines": {
|
|
8
|
+
"node": ">=24"
|
|
9
|
+
},
|
|
10
|
+
"exports": {
|
|
11
|
+
".": {
|
|
12
|
+
"types": "./dist/index.d.ts",
|
|
13
|
+
"import": "./dist/index.js",
|
|
14
|
+
"default": "./dist/index.js"
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
"files": [
|
|
18
|
+
"dist",
|
|
19
|
+
"!dist/**/*.map",
|
|
20
|
+
"!dist/**/*.test.*"
|
|
21
|
+
],
|
|
22
|
+
"scripts": {
|
|
23
|
+
"build": "tsc -p tsconfig.build.json",
|
|
24
|
+
"typecheck": "tsc -p tsconfig.json --noEmit",
|
|
25
|
+
"test": "vitest run --passWithNoTests",
|
|
26
|
+
"lint": "eslint src"
|
|
27
|
+
},
|
|
28
|
+
"repository": {
|
|
29
|
+
"type": "git",
|
|
30
|
+
"url": "git+https://github.com/ofri-peretz/burgee.git",
|
|
31
|
+
"directory": "packages/caique"
|
|
32
|
+
},
|
|
33
|
+
"homepage": "https://github.com/ofri-peretz/burgee/tree/main/packages/caique#readme",
|
|
34
|
+
"bugs": {
|
|
35
|
+
"url": "https://github.com/ofri-peretz/burgee/issues"
|
|
36
|
+
},
|
|
37
|
+
"keywords": [
|
|
38
|
+
"cli",
|
|
39
|
+
"terminal",
|
|
40
|
+
"prompt",
|
|
41
|
+
"prompts",
|
|
42
|
+
"interactive",
|
|
43
|
+
"inquirer",
|
|
44
|
+
"clack",
|
|
45
|
+
"agent",
|
|
46
|
+
"non-tty"
|
|
47
|
+
],
|
|
48
|
+
"devDependencies": {
|
|
49
|
+
"vitest": "^4.0.0"
|
|
50
|
+
}
|
|
51
|
+
}
|