roundel 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 +24 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.js +7 -0
- package/package.json +52 -0
package/README.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# roundel
|
|
2
|
+
|
|
3
|
+
**Not yet released.** This version reserves the name; the first working release follows
|
|
4
|
+
[`docs/intents/cli-style/`](https://github.com/ofri-peretz/burgee/tree/main/docs/intents/cli-style).
|
|
5
|
+
|
|
6
|
+
A **roundel** is a flag's colours carried onto another surface — the rings on an aircraft's
|
|
7
|
+
wing, the London Underground sign. Identity, expressed purely in colour, on something that is
|
|
8
|
+
not a flag. That is what this package is for a command-line program: not `red` and `blue`,
|
|
9
|
+
but `error`, `hint`, `command` and `flag`, the colours that mean *you*, carried onto the
|
|
10
|
+
terminal as a theme.
|
|
11
|
+
|
|
12
|
+
## What it will be
|
|
13
|
+
|
|
14
|
+
- **One output policy**, decided once from the runtime: `tty`, `pipe`, `json`, `accessible`
|
|
15
|
+
or `ci`. Every component reads it; none detects the terminal on its own.
|
|
16
|
+
- **Semantic tokens** over `util.styleText`, silent under every mode but `tty`.
|
|
17
|
+
- **A theme** that changes every token at once, contrast-checked when it emits truecolor.
|
|
18
|
+
- **`roundel/chalk`** — chalk's API over Node natives, graded by chalk's own test suite, so a
|
|
19
|
+
migration is one import and your tests are unchanged.
|
|
20
|
+
- **Zero dependencies**, and every subpath measured against the lightest incumbent it replaces.
|
|
21
|
+
|
|
22
|
+
Part of the [burgee](https://github.com/ofri-peretz/burgee) family: a CLI on burgee declares
|
|
23
|
+
what it is, roundel carries its colours, flagstaff flies it, answerback replies. Each is
|
|
24
|
+
an independent package; none requires the others.
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* roundel — reserved. The first working release follows
|
|
3
|
+
* docs/intents/cli-style/ 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: "roundel";
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* roundel — reserved. The first working release follows
|
|
3
|
+
* docs/intents/cli-style/ 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 = 'roundel';
|
|
7
|
+
//# sourceMappingURL=index.js.map
|
package/package.json
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "roundel",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "The colours a CLI carries. One output policy, semantic tokens, a theme, and a chalk migration path lighter than chalk. 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/roundel"
|
|
32
|
+
},
|
|
33
|
+
"homepage": "https://github.com/ofri-peretz/burgee/tree/main/packages/roundel#readme",
|
|
34
|
+
"bugs": {
|
|
35
|
+
"url": "https://github.com/ofri-peretz/burgee/issues"
|
|
36
|
+
},
|
|
37
|
+
"keywords": [
|
|
38
|
+
"cli",
|
|
39
|
+
"terminal",
|
|
40
|
+
"color",
|
|
41
|
+
"colour",
|
|
42
|
+
"ansi",
|
|
43
|
+
"style",
|
|
44
|
+
"theme",
|
|
45
|
+
"chalk",
|
|
46
|
+
"picocolors",
|
|
47
|
+
"styleText"
|
|
48
|
+
],
|
|
49
|
+
"devDependencies": {
|
|
50
|
+
"vitest": "^4.0.0"
|
|
51
|
+
}
|
|
52
|
+
}
|