roundel 0.1.0 → 0.2.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/LICENSE +21 -0
- package/README.md +34 -5
- package/package.json +2 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Ofri Peretz
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,4 +1,23 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://github.com/ofri-peretz/burgee/tree/main/packages/roundel" target="blank">
|
|
3
|
+
<picture>
|
|
4
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ofri-peretz/burgee/main/brand-assets/roundel-lockup.svg" />
|
|
5
|
+
<img src="https://raw.githubusercontent.com/ofri-peretz/burgee/main/brand-assets/roundel-lockup-light.svg" alt="roundel" width="360" />
|
|
6
|
+
</picture>
|
|
7
|
+
</a>
|
|
8
|
+
</p>
|
|
9
|
+
|
|
10
|
+
<p align="center">
|
|
11
|
+
The colours a CLI carries — error and hint, not red and blue.
|
|
12
|
+
</p>
|
|
13
|
+
|
|
14
|
+
<p align="center">
|
|
15
|
+
<a href="https://www.npmjs.com/package/roundel"><img src="https://img.shields.io/npm/v/roundel?style=flat-square&color=0a6b47" alt="npm version" /></a>
|
|
16
|
+
<a href="https://www.npmjs.com/package/roundel"><img src="https://img.shields.io/npm/dm/roundel?style=flat-square" alt="npm downloads" /></a>
|
|
17
|
+
<img src="https://img.shields.io/badge/runtime%20dependencies-0-0a6b47?style=flat-square" alt="Zero runtime dependencies" />
|
|
18
|
+
<img src="https://img.shields.io/badge/Node.js-24+-green.svg?style=flat-square" alt="Node.js 24+" />
|
|
19
|
+
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square" alt="License: MIT" />
|
|
20
|
+
</p>
|
|
2
21
|
|
|
3
22
|
chalk gives you `red`; picocolors gives you `red` for fewer bytes. Neither gives you
|
|
4
23
|
`error`, and each decides on its own whether the terminal has colour — which is why a
|
|
@@ -14,7 +33,11 @@ not a flag. That is what this package is for a command-line program: not `red` a
|
|
|
14
33
|
but `error`, `hint`, `command` and `flag`, the colours that mean *you*, carried onto the
|
|
15
34
|
terminal as a theme.
|
|
16
35
|
|
|
17
|
-
##
|
|
36
|
+
## Start here
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npm install roundel
|
|
40
|
+
```
|
|
18
41
|
|
|
19
42
|
```js
|
|
20
43
|
import { fly } from 'roundel/theme';
|
|
@@ -144,6 +167,12 @@ Node ≥ 24.
|
|
|
144
167
|
- **`roundel/import`** — `fromBase16(scheme)` and `fromITerm(plist)`: a theme from the two
|
|
145
168
|
largest corpora of terminal palettes, contrast-checked on the way in.
|
|
146
169
|
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
Part of the [burgee](https://github.com/ofri-peretz/burgee) family: a CLI on
|
|
173
|
+
[burgee](https://www.npmjs.com/package/burgee) declares what it is, roundel carries its
|
|
174
|
+
colours, [flagstaff](https://www.npmjs.com/package/flagstaff) flies it, and
|
|
175
|
+
[caique](https://www.npmjs.com/package/caique) answers back. Each is an independent package;
|
|
176
|
+
none requires the others.
|
|
177
|
+
|
|
178
|
+
MIT © Ofri Peretz — see [LICENSE](./LICENSE).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "roundel",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
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
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -55,6 +55,7 @@
|
|
|
55
55
|
"build": "tsc -p tsconfig.build.json && node ../../scripts/schema-to-dist.mjs && node ../../scripts/strip-comments.mjs dist",
|
|
56
56
|
"typecheck": "tsc -p tsconfig.json --noEmit",
|
|
57
57
|
"test": "vitest run --passWithNoTests",
|
|
58
|
+
"coverage": "vitest run --coverage.enabled",
|
|
58
59
|
"lint": "eslint src"
|
|
59
60
|
},
|
|
60
61
|
"repository": {
|