flagstaff 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 +53 -0
package/README.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# flagstaff
|
|
2
|
+
|
|
3
|
+
**Not yet released.** This version reserves the name; the first working release follows
|
|
4
|
+
[`docs/intents/cli-render/`](https://github.com/ofri-peretz/burgee/tree/main/docs/intents/cli-render).
|
|
5
|
+
|
|
6
|
+
A **flagstaff** is the staff a flag flies from. It is the simplest part of the whole
|
|
7
|
+
apparatus and the only one that is always in view: a flag is hoisted on it, held there "at the
|
|
8
|
+
dip" or "close up", changed, and lowered when it is done. That is a terminal render loop — the
|
|
9
|
+
place frames are hoisted, held, changed and lowered, in view of whoever is reading.
|
|
10
|
+
|
|
11
|
+
## What it will be
|
|
12
|
+
|
|
13
|
+
- **A frame loop with a static projection.** A spinner animates on a TTY, prints one line
|
|
14
|
+
per state on a pipe, emits one event under `--json`, and is plain text in accessible mode.
|
|
15
|
+
A component without a static projection is refused at registration.
|
|
16
|
+
- **Plugins as data.** A third-party spinner, progress style or character is a plain object;
|
|
17
|
+
the built-ins ship in the same shape. A plugin is a flag someone else made, flown from the
|
|
18
|
+
same staff.
|
|
19
|
+
- **Drop-in paths** for ora, log-update, boxen and cli-table3, graded by their own suites.
|
|
20
|
+
- **No layout engine**, on purpose. Box, columns and a status line are the ceiling.
|
|
21
|
+
- **Zero external dependencies.**
|
|
22
|
+
|
|
23
|
+
Part of the [burgee](https://github.com/ofri-peretz/burgee) family: a CLI on burgee declares
|
|
24
|
+
what it is, pennon gives it colours, flagstaff flies it, answering is how it replies. Each is
|
|
25
|
+
an independent package; none requires the others.
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* flagstaff — reserved. The first working release follows
|
|
3
|
+
* docs/intents/cli-render/ 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: "flagstaff";
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* flagstaff — reserved. The first working release follows
|
|
3
|
+
* docs/intents/cli-render/ 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 = 'flagstaff';
|
|
7
|
+
//# sourceMappingURL=index.js.map
|
package/package.json
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "flagstaff",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "The staff the flag flies from. A terminal frame loop with a static projection for agents and screen readers, and a plugin host for spinners, progress, boxes and tables. Drop-in paths for ora, log-update, boxen and cli-table3. Zero dependencies.",
|
|
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/flagstaff"
|
|
32
|
+
},
|
|
33
|
+
"homepage": "https://github.com/ofri-peretz/burgee/tree/main/packages/flagstaff#readme",
|
|
34
|
+
"bugs": {
|
|
35
|
+
"url": "https://github.com/ofri-peretz/burgee/issues"
|
|
36
|
+
},
|
|
37
|
+
"keywords": [
|
|
38
|
+
"cli",
|
|
39
|
+
"terminal",
|
|
40
|
+
"spinner",
|
|
41
|
+
"progress",
|
|
42
|
+
"render",
|
|
43
|
+
"animation",
|
|
44
|
+
"ora",
|
|
45
|
+
"log-update",
|
|
46
|
+
"boxen",
|
|
47
|
+
"cli-table3",
|
|
48
|
+
"plugins"
|
|
49
|
+
],
|
|
50
|
+
"devDependencies": {
|
|
51
|
+
"vitest": "^4.0.0"
|
|
52
|
+
}
|
|
53
|
+
}
|