-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathnpm-page.html
More file actions
639 lines (565 loc) · 34.9 KB
/
npm-page.html
File metadata and controls
639 lines (565 loc) · 34.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>@munesoft/cli-ui — npm</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link href="https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@400;500;700&family=Syne:wght@400;600;700;800&display=swap" rel="stylesheet">
<style>
*, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; }
:root {
--bg: #07080f;
--surface: #0c0e1a;
--surface2: #111428;
--surface3: #181c30;
--border: #1c2038;
--border2: #272d48;
--text: #e4e8f8;
--muted: #56619a;
--subdued: #303860;
/* ── Accent palette ── */
--peri: #818cf8; /* electric periwinkle */
--peri2: #a5b4fc;
--peri-glow: rgba(129,140,248,.14);
--emerald: #34d399; /* neon emerald */
--emerald2: #6ee7b7;
--em-glow: rgba(52,211,153,.1);
--coral: #fb7185; /* coral-rose */
--coral2: #fda4af;
--co-glow: rgba(251,113,133,.1);
--amber: #fbbf24; /* warm amber */
--amber2: #fcd34d;
--am-glow: rgba(251,191,36,.1);
--violet: #c084fc; /* vivid violet */
--violet2: #d8b4fe;
--vi-glow: rgba(192,132,252,.1);
--sky: #38bdf8; /* sky blue */
--sky2: #7dd3fc;
--grad: linear-gradient(135deg,#818cf8,#c084fc);
--grad2: linear-gradient(135deg,#34d399,#38bdf8);
--grad3: linear-gradient(135deg,#818cf8,#38bdf8,#34d399);
}
html { scroll-behavior: smooth; }
body {
background: var(--bg);
color: var(--text);
font-family: 'Syne', sans-serif;
font-size: 15px;
line-height: 1.7;
min-height: 100vh;
}
/* ── Topbar ─────────────────────────────────────────────── */
.topbar {
background: rgba(12,14,26,.88);
backdrop-filter: blur(16px);
border-bottom: 1px solid var(--border);
padding: 0 44px;
display: flex; align-items: center; gap: 18px;
height: 54px; position: sticky; top: 0; z-index: 200;
}
.npm-logo {
font-family: 'JetBrains Mono', monospace; font-weight: 700; font-size: 17px;
letter-spacing: -.5px; color: #f87171;
background: rgba(248,113,113,.1); border: 1px solid rgba(248,113,113,.2);
padding: 2px 8px; border-radius: 5px;
}
.topbar-sep { color: var(--subdued); font-size: 17px; }
.topbar-pkg { font-family: 'JetBrains Mono', monospace; font-size: 13px; }
.topbar-pkg .sc { color: var(--muted); }
.topbar-pkg .nm { color: var(--peri2); font-weight: 500; }
.topbar-right { margin-left: auto; display: flex; gap: 10px; align-items: center; }
.btn {
padding: 7px 18px; border-radius: 7px;
font-family: 'Syne', sans-serif; font-size: 13px; font-weight: 700;
cursor: pointer; border: none; transition: all .16s; text-decoration: none;
display: inline-flex; align-items: center; gap: 6px;
}
.btn-ghost { background: transparent; border: 1px solid var(--border2); color: var(--muted); }
.btn-ghost:hover { border-color: var(--peri); color: var(--peri2); }
.btn-primary { background: var(--grad); color: #fff; box-shadow: 0 0 22px rgba(129,140,248,.22); }
.btn-primary:hover { box-shadow: 0 0 32px rgba(129,140,248,.38); opacity: .92; }
/* ── Layout ─────────────────────────────────────────────── */
.layout {
max-width: 1200px; margin: 0 auto; padding: 44px 44px 100px;
display: grid; grid-template-columns: 1fr 286px; gap: 52px; align-items: start;
}
/* ── Hero ───────────────────────────────────────────────── */
.hero { margin-bottom: 44px; }
.pkg-name { font-size: 40px; font-weight: 800; letter-spacing: -1.5px; line-height: 1.05; margin-bottom: 14px; }
.pkg-name .sc { color: var(--subdued); }
.pkg-name .nm { background: var(--grad); -webkit-background-clip: text; -webkit-text-fill-color: transparent; background-clip: text; }
.pkg-desc { font-size: 17px; color: var(--muted); margin-bottom: 22px; max-width: 520px; }
/* colour swatch bar */
.swatches { display: flex; gap: 5px; margin-bottom: 22px; }
.sw { height: 4px; flex: 1; border-radius: 2px; }
/* badges */
.badges { display: flex; flex-wrap: wrap; gap: 7px; margin-bottom: 28px; }
.badge {
display: inline-flex; align-items: center; gap: 5px;
padding: 3px 10px; border-radius: 20px;
font-family: 'JetBrains Mono', monospace; font-size: 11px; font-weight: 500; border: 1px solid;
}
.b-p { color: var(--peri2); border-color: rgba(165,180,252,.25); background: rgba(129,140,248,.07); }
.b-e { color: var(--emerald2); border-color: rgba(110,231,183,.25); background: rgba(52,211,153,.07); }
.b-v { color: var(--violet2); border-color: rgba(216,180,254,.25); background: rgba(192,132,252,.07); }
.b-a { color: var(--amber2); border-color: rgba(252,211,77,.25); background: rgba(251,191,36,.07); }
.b-s { color: var(--sky2); border-color: rgba(125,211,252,.25); background: rgba(56,189,248,.07); }
/* install box */
.install-box {
background: var(--surface); border: 1px solid var(--border);
border-radius: 12px; padding: 14px 18px;
display: flex; align-items: center; justify-content: space-between; gap: 16px;
margin-bottom: 36px; position: relative; overflow: hidden;
}
.install-box::before {
content: ''; position: absolute; left: 0; top: 0; bottom: 0; width: 3px;
background: var(--grad); border-radius: 12px 0 0 12px;
}
.install-cmd { font-family: 'JetBrains Mono', monospace; font-size: 14px; padding-left: 8px; }
.install-cmd .dl { color: var(--subdued); }
.install-cmd .cm { color: var(--peri2); }
.copy-btn {
background: var(--surface2); border: 1px solid var(--border2); color: var(--muted);
padding: 5px 14px; border-radius: 6px; cursor: pointer;
font-size: 11px; font-family: 'JetBrains Mono', monospace; font-weight: 500;
transition: all .15s; white-space: nowrap; flex-shrink: 0;
}
.copy-btn:hover { color: var(--peri2); border-color: var(--peri); background: var(--peri-glow); }
.copy-btn.copied { color: var(--emerald); border-color: var(--emerald); background: var(--em-glow); }
/* ── Terminal window ────────────────────────────────────── */
.terminal {
background: #040508;
border: 1px solid var(--border);
border-radius: 12px; margin-bottom: 44px; overflow: hidden;
box-shadow: 0 24px 64px rgba(0,0,0,.6), 0 0 0 1px rgba(129,140,248,.05);
}
.tbar {
background: var(--surface); border-bottom: 1px solid var(--border);
padding: 10px 16px; display: flex; align-items: center; gap: 7px;
}
.dot { width: 11px; height: 11px; border-radius: 50%; flex-shrink: 0; }
.dr { background: #ff5f57; } .dy { background: #ffbd2e; } .dg { background: #28c840; }
.ttitle { margin-left: 10px; font-size: 12px; color: var(--muted); font-family: 'JetBrains Mono', monospace; }
.tbody { padding: 22px 26px; font-family: 'JetBrains Mono', monospace; font-size: 13px; line-height: 2.05; }
.tok { color: #34d399; }
.twrn { color: #fbbf24; }
.terr { color: #fb7185; }
.tmut { color: #232b4a; }
.tdim { color: #1a2038; }
/* animated spinner frame */
.sp { display: inline-block; color: #818cf8; }
.sp::before { content: "⠋"; animation: spc .9s steps(1) infinite; }
@keyframes spc {
0%{content:"⠋"}11%{content:"⠙"}22%{content:"⠹"}33%{content:"⠸"}
44%{content:"⠼"}55%{content:"⠴"}66%{content:"⠦"}77%{content:"⠧"}88%{content:"⠇"}99%{content:"⠏"}
}
/* animated gradient progress bar */
.barwrap { display: inline-flex; align-items: baseline; gap: 4px; }
.barfill {
display: inline-block; overflow: hidden; white-space: nowrap;
width: 0; vertical-align: bottom;
background: linear-gradient(90deg, #818cf8, #c084fc, #38bdf8);
-webkit-background-clip: text; -webkit-text-fill-color: transparent; background-clip: text;
animation: bfill 3.4s ease-in-out infinite;
}
@keyframes bfill { 0%,8%{width:0} 72%,86%{width:96px} 100%{width:0} }
.barempty { color: #181e38; }
/* ── Tabs ───────────────────────────────────────────────── */
.tabs { display: flex; border-bottom: 1px solid var(--border); margin-bottom: 36px; }
.tab {
padding: 11px 22px; font-size: 14px; font-weight: 700; color: var(--muted);
cursor: pointer; border-bottom: 2px solid transparent; transition: all .15s; margin-bottom: -1px;
}
.tab.active { color: var(--peri2); border-bottom-color: var(--peri); }
.tab:hover:not(.active) { color: var(--text); }
.tab-content { display: none; }
.tab-content.active { display: block; }
/* ── Section / headings ─────────────────────────────────── */
.section { margin-bottom: 48px; }
h2 {
font-size: 21px; font-weight: 800; color: var(--text);
margin-bottom: 18px; padding-bottom: 12px;
border-bottom: 1px solid var(--border); letter-spacing: -.3px;
}
h3 {
font-size: 12px; font-weight: 700; color: var(--peri2);
margin: 26px 0 10px; font-family: 'JetBrains Mono', monospace;
letter-spacing: .07em; text-transform: uppercase;
}
p { color: var(--muted); margin-bottom: 14px; line-height: 1.75; }
p strong { color: var(--text); }
/* ── Code blocks ────────────────────────────────────────── */
pre {
background: var(--surface); border: 1px solid var(--border);
border-radius: 10px; padding: 20px 22px;
overflow-x: auto; margin-bottom: 20px; position: relative;
}
pre::after {
content: ''; position: absolute;
top: 0; left: 0; right: 0; height: 1px;
background: linear-gradient(90deg, var(--peri) 0%, var(--violet) 45%, transparent 100%);
opacity: .35; border-radius: 10px 10px 0 0;
}
code { font-family: 'JetBrains Mono', monospace; font-size: 13px; line-height: 1.85; }
pre code { color: var(--text); }
.ck { color: #c084fc; }
.cf { color: #818cf8; }
.cs { color: #34d399; }
.cc { color: #252e50; font-style: italic; }
.cn { color: #fbbf24; }
.co { color: #303858; }
.cp { color: #38bdf8; }
/* ── Features grid ──────────────────────────────────────── */
.features { display: grid; grid-template-columns: 1fr 1fr; gap: 14px; margin-bottom: 36px; }
.fc {
background: var(--surface); border: 1px solid var(--border); border-radius: 12px;
padding: 22px; transition: border-color .2s, transform .2s, box-shadow .2s;
position: relative; overflow: hidden;
}
.fc:hover { border-color: var(--border2); transform: translateY(-2px); box-shadow: 0 12px 32px rgba(0,0,0,.35); }
.fi { font-size: 22px; margin-bottom: 10px; }
.ft { font-size: 14px; font-weight: 700; color: var(--text); margin-bottom: 6px; }
.fd { font-size: 13px; color: var(--muted); line-height: 1.55; }
/* ── Tables ─────────────────────────────────────────────── */
table {
width: 100%; border-collapse: collapse; margin-bottom: 24px;
font-size: 14px; border-radius: 10px; overflow: hidden; border: 1px solid var(--border);
}
th {
text-align: left; padding: 11px 18px;
background: var(--surface); border-bottom: 1px solid var(--border);
color: var(--muted); font-weight: 700; font-size: 11px;
text-transform: uppercase; letter-spacing: .6px;
}
td { padding: 12px 18px; border-bottom: 1px solid var(--border); color: var(--text); }
td:not(:first-child) { text-align: center; }
tr:last-child td { border-bottom: none; }
tr:hover td { background: rgba(129,140,248,.025); }
.ck2 { color: var(--emerald); font-size: 15px; }
.cx { color: var(--coral); font-size: 15px; }
.cm2 { color: var(--amber); font-size: 15px; }
.api-table td:first-child { font-family: 'JetBrains Mono', monospace; font-size: 12px; color: var(--sky2); white-space: nowrap; }
.api-table td:last-child { color: var(--muted); font-size: 13px; }
.api-sig {
background: var(--surface2); border: 1px solid var(--border);
border-left: 3px solid var(--peri); border-radius: 0 8px 8px 0;
padding: 12px 18px; margin-bottom: 18px;
font-family: 'JetBrains Mono', monospace; font-size: 13px; color: var(--peri2);
}
/* ── Sidebar ────────────────────────────────────────────── */
.sidebar { position: sticky; top: 76px; }
.sc { background: var(--surface); border: 1px solid var(--border); border-radius: 12px; padding: 20px; margin-bottom: 14px; }
.sl { font-size: 10px; font-weight: 700; text-transform: uppercase; letter-spacing: 1px; color: var(--subdued); margin-bottom: 12px; }
.sr {
display: flex; justify-content: space-between; align-items: center;
padding: 5px 0; border-bottom: 1px solid var(--border); font-size: 13px;
}
.sr:last-child { border-bottom: none; }
.sr .lb { color: var(--muted); }
.sr .vl { color: var(--peri2); font-family: 'JetBrains Mono', monospace; font-size: 12px; }
.sr .vl.gr { color: var(--emerald); }
.slinks { display: flex; flex-direction: column; gap: 6px; }
.slink {
display: flex; align-items: center; gap: 10px; padding: 9px 12px; border-radius: 8px;
text-decoration: none; color: var(--muted); font-size: 13px;
transition: all .15s; border: 1px solid transparent;
}
.slink:hover { color: var(--text); background: var(--surface2); border-color: var(--border); }
.si2 { font-size: 14px; width: 16px; text-align: center; }
.epill {
display: inline-flex; align-items: center; padding: 4px 12px; border-radius: 20px;
font-family: 'JetBrains Mono', monospace; font-size: 12px; margin: 3px 3px 3px 0;
background: var(--peri-glow); border: 1px solid rgba(129,140,248,.2); color: var(--peri2);
}
.avatar {
width: 36px; height: 36px; border-radius: 50%;
background: var(--grad); display: flex; align-items: center; justify-content: center;
font-weight: 800; font-size: 14px; color: #fff;
box-shadow: 0 0 18px rgba(129,140,248,.28); flex-shrink: 0;
}
/* ── Colour palette sidebar card ─────────────────────────── */
.pal-row { display: flex; align-items: center; gap: 10px; font-family: 'JetBrains Mono', monospace; font-size: 11px; padding: 3px 0; }
.pal-swatch { width: 13px; height: 13px; border-radius: 3px; flex-shrink: 0; }
::-webkit-scrollbar { width: 6px; height: 6px; }
::-webkit-scrollbar-track { background: transparent; }
::-webkit-scrollbar-thumb { background: var(--border2); border-radius: 3px; }
@media (max-width: 960px) {
.layout { grid-template-columns: 1fr; padding: 24px 20px 60px; }
.topbar { padding: 0 20px; }
.sidebar { position: static; }
.features { grid-template-columns: 1fr; }
}
</style>
</head>
<body>
<nav class="topbar">
<span class="npm-logo">npm</span>
<span class="topbar-sep">/</span>
<span class="topbar-pkg"><span class="sc">@munesoft/</span><span class="nm">cli-ui</span></span>
<div class="topbar-right">
<button class="btn btn-ghost">⭐ Star</button>
<button class="btn btn-primary" onclick="copyInstall(this)">↓ Install</button>
</div>
</nav>
<div class="layout">
<main>
<div class="hero">
<div class="pkg-name"><span class="sc">@munesoft/</span><span class="nm">cli-ui</span></div>
<p class="pkg-desc">Beautiful CLI spinners, progress bars, and task displays — with zero setup.</p>
<div class="swatches">
<div class="sw" style="background:#818cf8"></div>
<div class="sw" style="background:#34d399"></div>
<div class="sw" style="background:#fb7185"></div>
<div class="sw" style="background:#fbbf24"></div>
<div class="sw" style="background:#c084fc"></div>
<div class="sw" style="background:#38bdf8"></div>
</div>
<div class="badges">
<span class="badge b-p">v1.0.0</span>
<span class="badge b-e">0 dependencies</span>
<span class="badge b-e">MIT</span>
<span class="badge b-v">TypeScript ✓</span>
<span class="badge b-a">Node ≥ 14</span>
<span class="badge b-s">ESM</span>
</div>
<div class="install-box">
<div class="install-cmd"><span class="dl">$ </span><span class="cm">npm install @munesoft/cli-ui</span></div>
<button class="copy-btn" onclick="copyInstall(this)">copy</button>
</div>
<div class="terminal">
<div class="tbar">
<div class="dot dr"></div><div class="dot dy"></div><div class="dot dg"></div>
<span class="ttitle">node deploy.js</span>
</div>
<div class="tbody">
<div><span class="tok">✔</span> <span style="color:#bcc4e8">Install packages</span></div>
<div><span class="tok">✔</span> <span style="color:#bcc4e8">Compile TypeScript</span></div>
<div><span class="sp"></span><span style="color:#6878b0"> Run test suite</span></div>
<div><span class="tmut">○</span> <span style="color:#252e50">Deploy to staging</span></div>
<div style="margin-top:12px">
<span style="color:#303858">Building [</span><span class="barfill">████████████████████████</span><span class="barempty">██████</span><span style="color:#303858">]</span>
<span style="color:#818cf8;font-weight:500"> 80%</span>
<span style="color:#252e50"> 80/100</span>
</div>
</div>
</div>
</div>
<div class="tabs">
<div class="tab active" onclick="showTab('readme',this)">README</div>
<div class="tab" onclick="showTab('api',this)">API</div>
<div class="tab" onclick="showTab('compare',this)">Compare</div>
</div>
<!-- README -->
<div class="tab-content active" id="tab-readme">
<div class="section">
<h2>Why cli-ui?</h2>
<p>Most CLI scripts look static and lifeless. <strong>cli-ui</strong> gives your Node.js tools clean, animated terminal UX — no config, no dependency tree.</p>
<div class="features">
<div class="fc"><div class="fi">🌀</div><div class="ft">Animated Spinners</div><div class="fd">3 styles · 5 vivid modern colours · 4 states. Update the label live mid-spin.</div></div>
<div class="fc"><div class="fi">📊</div><div class="ft">Progress Bars</div><div class="fd">Block-fill bars with label, colour, absolute or incremental updates.</div></div>
<div class="fc"><div class="fi">🔄</div><div class="ft">Multi-Task Display</div><div class="fd">Track many async jobs at once — each task updates in place, no scroll noise.</div></div>
<div class="fc"><div class="fi">⚡</div><div class="ft">Zero Dependencies</div><div class="fd">Pure ANSI escape sequences. Nothing in your lockfile except your own code.</div></div>
</div>
</div>
<div class="section">
<h2>Quick start</h2>
<pre><code><span class="ck">import</span> { spinner, progress, tasks, run } <span class="ck">from</span> <span class="cs">"@munesoft/cli-ui"</span><span class="co">;</span>
<span class="cc">// ── Single spinner</span>
<span class="ck">const</span> spin <span class="co">=</span> <span class="cf">spinner</span>(<span class="cs">"Loading..."</span>)<span class="co">;</span>
spin<span class="co">.</span><span class="cf">start</span>()<span class="co">;</span>
<span class="ck">await</span> <span class="cf">doWork</span>()<span class="co">;</span>
spin<span class="co">.</span><span class="cf">success</span>(<span class="cs">"Done!"</span>)<span class="co">;</span>
<span class="cc">// ── Auto-managed async task</span>
<span class="ck">const</span> data <span class="co">=</span> <span class="ck">await</span> <span class="cf">run</span>(<span class="cs">"Fetching config"</span><span class="co">,</span> fetchConfig)<span class="co">;</span>
<span class="cc">// ── Multi-task pipeline</span>
<span class="ck">const</span> t <span class="co">=</span> <span class="cf">tasks</span>()<span class="co">;</span>
<span class="ck">await</span> t<span class="co">.</span><span class="cf">run</span>(<span class="cs">"Build"</span><span class="co">,</span> build)<span class="co">;</span>
<span class="ck">await</span> t<span class="co">.</span><span class="cf">run</span>(<span class="cs">"Test"</span><span class="co">,</span> runTests)<span class="co">;</span>
<span class="ck">await</span> t<span class="co">.</span><span class="cf">run</span>(<span class="cs">"Deploy"</span><span class="co">,</span> deploy)<span class="co">;</span></code></pre>
</div>
<div class="section">
<h2>Spinners</h2>
<pre><code><span class="ck">import</span> { spinner } <span class="ck">from</span> <span class="cs">"@munesoft/cli-ui"</span><span class="co">;</span>
<span class="cc">// Styles</span>
<span class="cf">spinner</span>(<span class="cs">"Loading"</span><span class="co">,</span> { <span class="cp">style</span><span class="co">:</span> <span class="cs">"dots"</span> })<span class="co">;</span> <span class="cc">// ⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏ (default)</span>
<span class="cf">spinner</span>(<span class="cs">"Loading"</span><span class="co">,</span> { <span class="cp">style</span><span class="co">:</span> <span class="cs">"line"</span> })<span class="co">;</span> <span class="cc">// - \ | /</span>
<span class="cf">spinner</span>(<span class="cs">"Loading"</span><span class="co">,</span> { <span class="cp">style</span><span class="co">:</span> <span class="cs">"pulse"</span> })<span class="co">;</span> <span class="cc">// █ ▓ ▒ ░ ▒ ▓</span>
<span class="cc">// Colours — vivid modern ANSI bright variants</span>
<span class="cf">spinner</span>(<span class="cs">"Loading"</span><span class="co">,</span> { <span class="cp">color</span><span class="co">:</span> <span class="cs">"cyan"</span> })<span class="co">;</span> <span class="cc">// electric periwinkle-teal (default)</span>
<span class="cf">spinner</span>(<span class="cs">"Loading"</span><span class="co">,</span> { <span class="cp">color</span><span class="co">:</span> <span class="cs">"green"</span> })<span class="co">;</span> <span class="cc">// neon emerald</span>
<span class="cf">spinner</span>(<span class="cs">"Loading"</span><span class="co">,</span> { <span class="cp">color</span><span class="co">:</span> <span class="cs">"red"</span> })<span class="co">;</span> <span class="cc">// coral-rose</span>
<span class="cf">spinner</span>(<span class="cs">"Loading"</span><span class="co">,</span> { <span class="cp">color</span><span class="co">:</span> <span class="cs">"yellow"</span> })<span class="co">;</span> <span class="cc">// warm amber</span>
<span class="cf">spinner</span>(<span class="cs">"Loading"</span><span class="co">,</span> { <span class="cp">color</span><span class="co">:</span> <span class="cs">"magenta"</span> })<span class="co">;</span> <span class="cc">// vivid violet</span>
<span class="cc">// States</span>
<span class="ck">const</span> spin <span class="co">=</span> <span class="cf">spinner</span>(<span class="cs">"Uploading…"</span>)<span class="co">;</span>
spin<span class="co">.</span><span class="cf">start</span>()<span class="co">;</span>
spin<span class="co">.</span><span class="cf">update</span>(<span class="cs">"Uploading chunk 3/5…"</span>)<span class="co">;</span> <span class="cc">// live label update</span>
spin<span class="co">.</span><span class="cf">success</span>(<span class="cs">"Upload complete"</span>)<span class="co">;</span> <span class="cc">// ✔ emerald</span>
spin<span class="co">.</span><span class="cf">error</span>(<span class="cs">"Connection reset"</span>)<span class="co">;</span> <span class="cc">// ✖ coral-rose</span>
spin<span class="co">.</span><span class="cf">warn</span>(<span class="cs">"Cert expires soon"</span>)<span class="co">;</span> <span class="cc">// ⚠ amber</span>
spin<span class="co">.</span><span class="cf">stop</span>()<span class="co">;</span> <span class="cc">// silent clear</span></code></pre>
</div>
<div class="section">
<h2>Progress bars</h2>
<pre><code><span class="ck">import</span> { progress } <span class="ck">from</span> <span class="cs">"@munesoft/cli-ui"</span><span class="co">;</span>
<span class="ck">const</span> bar <span class="co">=</span> <span class="cf">progress</span>({ <span class="cp">total</span><span class="co">:</span> <span class="cn">100</span><span class="co">,</span> <span class="cp">label</span><span class="co">:</span> <span class="cs">"Building"</span><span class="co">,</span> <span class="cp">color</span><span class="co">:</span> <span class="cs">"cyan"</span> })<span class="co">;</span>
bar<span class="co">.</span><span class="cf">update</span>(<span class="cn">25</span>)<span class="co">;</span> <span class="cc">// Building [████████░░░░░░░░░░░░░░░░░░░░░░] 25%</span>
bar<span class="co">.</span><span class="cf">increment</span>()<span class="co">;</span> <span class="cc">// +1</span>
bar<span class="co">.</span><span class="cf">increment</span>(<span class="cn">10</span>)<span class="co">;</span> <span class="cc">// +10</span>
bar<span class="co">.</span><span class="cf">complete</span>(<span class="cs">"Done!"</span>)<span class="co">;</span> <span class="cc">// 100%, newline, ✔ Done!</span></code></pre>
</div>
<div class="section">
<h2>Multi-task display</h2>
<pre><code><span class="ck">import</span> { tasks } <span class="ck">from</span> <span class="cs">"@munesoft/cli-ui"</span><span class="co">;</span>
<span class="ck">const</span> t <span class="co">=</span> <span class="cf">tasks</span>()<span class="co">;</span>
t<span class="co">.</span><span class="cf">add</span>(<span class="cs">"Download data"</span>)<span class="co">.</span><span class="cf">add</span>(<span class="cs">"Process files"</span>)<span class="co">.</span><span class="cf">add</span>(<span class="cs">"Upload results"</span>)<span class="co">;</span>
<span class="cc">// Manual control</span>
t<span class="co">.</span><span class="cf">start</span>(<span class="cs">"Download data"</span>)<span class="co">;</span> <span class="ck">await</span> download()<span class="co">;</span> t<span class="co">.</span><span class="cf">success</span>(<span class="cs">"Download data"</span>)<span class="co">;</span>
<span class="cc">// Automatic async runner — handles start → success/error</span>
<span class="ck">await</span> t<span class="co">.</span><span class="cf">run</span>(<span class="cs">"Process files"</span><span class="co">,</span> processFiles)<span class="co">;</span>
<span class="ck">await</span> t<span class="co">.</span><span class="cf">run</span>(<span class="cs">"Upload results"</span><span class="co">,</span> uploadResults)<span class="co">;</span></code></pre>
</div>
<div class="section">
<h2>Silent mode</h2>
<pre><code><span class="cc"># Suppress all output (CI environments)</span>
$ CLI_UI_SILENT=true node deploy.js</code></pre>
<pre><code>process<span class="co">.</span><span class="cp">env</span><span class="co">.</span><span class="cp">CLI_UI_SILENT</span> <span class="co">=</span> <span class="cs">"true"</span><span class="co">;</span> <span class="cc">// or set before importing</span></code></pre>
</div>
</div><!-- /readme -->
<!-- API -->
<div class="tab-content" id="tab-api">
<div class="section">
<h2>spinner(label, options?)</h2>
<div class="api-sig">spinner(label: string, options?: SpinnerOptions): Spinner</div>
<table class="api-table">
<tr><th>Method</th><th style="text-align:left">Description</th></tr>
<tr><td>.start(msg?)</td><td>Begin animation. Optionally update label first.</td></tr>
<tr><td>.update(msg)</td><td>Change the label text while spinning.</td></tr>
<tr><td>.success(msg?)</td><td>Stop → ✔ emerald. Defaults to current label.</td></tr>
<tr><td>.error(msg?)</td><td>Stop → ✖ coral. Defaults to current label.</td></tr>
<tr><td>.warn(msg?)</td><td>Stop → ⚠ amber. Defaults to current label.</td></tr>
<tr><td>.stop()</td><td>Stop and clear the line silently.</td></tr>
</table>
<h3>SpinnerOptions</h3>
<table class="api-table">
<tr><th>Option</th><th style="text-align:left">Type</th><th style="text-align:left">Default</th><th style="text-align:left">Values</th></tr>
<tr><td>style</td><td>string</td><td>"dots"</td><td>"dots" · "line" · "pulse"</td></tr>
<tr><td>color</td><td>string</td><td>"cyan"</td><td>"cyan" · "green" · "red" · "yellow" · "magenta"</td></tr>
</table>
</div>
<div class="section">
<h2>progress(options?)</h2>
<div class="api-sig">progress(options?: ProgressOptions): ProgressBar</div>
<table class="api-table">
<tr><th>Method / Property</th><th style="text-align:left">Description</th></tr>
<tr><td>.update(n)</td><td>Set current value (absolute, clamped to [0, total]).</td></tr>
<tr><td>.increment(step?)</td><td>Add step to current value. Default step = 1.</td></tr>
<tr><td>.complete(msg?)</td><td>Jump to 100%, optional done message, newline.</td></tr>
<tr><td>.value</td><td>Read current progress value.</td></tr>
<tr><td>.totalValue</td><td>Read configured total.</td></tr>
</table>
</div>
<div class="section">
<h2>tasks()</h2>
<div class="api-sig">tasks(): Tasks</div>
<table class="api-table">
<tr><th>Method</th><th style="text-align:left">Description</th></tr>
<tr><td>.add(name)</td><td>Register task as ○ pending. Chainable.</td></tr>
<tr><td>.start(name)</td><td>Mark as running with animated spinner icon.</td></tr>
<tr><td>.success(name, label?)</td><td>Mark as ✔. Optional label override.</td></tr>
<tr><td>.error(name, msg?)</td><td>Mark as ✖. Optional inline error message.</td></tr>
<tr><td>.warn(name, label?)</td><td>Mark as ⚠. Optional label override.</td></tr>
<tr><td>.run(name, fn)</td><td>Auto-managed: start → success or error.</td></tr>
</table>
</div>
<div class="section">
<h2>run(label, fn, options?)</h2>
<div class="api-sig">run<T>(label: string, fn: () => Promise<T>, options?: SpinnerOptions): Promise<T></div>
<p>Run an async function under a spinner. Returns the resolved value. On throw, displays ✖ coral and rethrows.</p>
</div>
</div><!-- /api -->
<!-- Compare -->
<div class="tab-content" id="tab-compare">
<div class="section">
<h2>How does cli-ui stack up?</h2>
<table>
<tr><th>Feature</th><th style="text-align:center">ora</th><th style="text-align:center">cli-progress</th><th style="text-align:center;color:var(--peri2)">cli-ui</th></tr>
<tr><td>Spinners</td> <td><span class="ck2">✔</span></td><td><span class="cx">✖</span></td><td><span class="ck2">✔</span></td></tr>
<tr><td>Progress bars</td> <td><span class="cx">✖</span></td><td><span class="ck2">✔</span></td><td><span class="ck2">✔</span></td></tr>
<tr><td>Multi-task display</td><td><span class="cx">✖</span></td><td><span class="cx">✖</span></td><td><span class="ck2">✔</span></td></tr>
<tr><td>Async task runner</td> <td><span class="cx">✖</span></td><td><span class="cx">✖</span></td><td><span class="ck2">✔</span></td></tr>
<tr><td>TypeScript types</td> <td><span class="ck2">✔</span></td><td><span class="ck2">✔</span></td><td><span class="ck2">✔</span></td></tr>
<tr><td>Zero dependencies</td> <td><span class="cx">✖</span></td><td><span class="cx">✖</span></td><td><span class="ck2">✔</span></td></tr>
<tr><td>Silent / CI mode</td> <td><span class="cm2">~</span></td><td><span class="cm2">~</span></td><td><span class="ck2">✔</span></td></tr>
</table>
</div>
</div><!-- /compare -->
</main>
<!-- Sidebar -->
<aside class="sidebar">
<div class="sc">
<div class="sl">Package info</div>
<div class="sr"><span class="lb">Version</span><span class="vl">1.0.0</span></div>
<div class="sr"><span class="lb">License</span><span class="vl">MIT</span></div>
<div class="sr"><span class="lb">Unpacked size</span><span class="vl">~12 kB</span></div>
<div class="sr"><span class="lb">Dependencies</span><span class="vl gr">0</span></div>
<div class="sr"><span class="lb">Node</span><span class="vl">≥ 14.0.0</span></div>
<div class="sr"><span class="lb">Module type</span><span class="vl">ESM</span></div>
</div>
<div class="sc">
<div class="sl">Links</div>
<div class="slinks">
<a href="#" class="slink"><span class="si2">📦</span> npm registry</a>
<a href="#" class="slink"><span class="si2">🐙</span> GitHub repository</a>
<a href="#" class="slink"><span class="si2">🐛</span> Issues</a>
<a href="#" class="slink"><span class="si2">📄</span> Changelog</a>
</div>
</div>
<div class="sc">
<div class="sl">Exports</div>
<div style="margin-top:4px">
<span class="epill">spinner()</span>
<span class="epill">progress()</span>
<span class="epill">tasks()</span>
<span class="epill">run()</span>
</div>
</div>
<div class="sc">
<div class="sl">Colour palette</div>
<div style="display:flex;flex-direction:column;gap:6px;margin-top:4px">
<div class="pal-row"><div class="pal-swatch" style="background:#818cf8"></div><span style="color:#818cf8">cyan</span><span style="color:var(--subdued);margin-left:auto">periwinkle-teal</span></div>
<div class="pal-row"><div class="pal-swatch" style="background:#34d399"></div><span style="color:#34d399">green</span><span style="color:var(--subdued);margin-left:auto">neon emerald</span></div>
<div class="pal-row"><div class="pal-swatch" style="background:#fb7185"></div><span style="color:#fb7185">red</span><span style="color:var(--subdued);margin-left:auto">coral-rose</span></div>
<div class="pal-row"><div class="pal-swatch" style="background:#fbbf24"></div><span style="color:#fbbf24">yellow</span><span style="color:var(--subdued);margin-left:auto">warm amber</span></div>
<div class="pal-row"><div class="pal-swatch" style="background:#c084fc"></div><span style="color:#c084fc">magenta</span><span style="color:var(--subdued);margin-left:auto">vivid violet</span></div>
</div>
</div>
<div class="sc">
<div class="sl">Built by</div>
<div style="display:flex;align-items:center;gap:12px;margin-top:6px">
<div class="avatar">M</div>
<div>
<div style="font-size:14px;font-weight:700;color:var(--text)">Munesoft</div>
<div style="font-size:12px;color:var(--muted)">github.com/munesoft</div>
</div>
</div>
</div>
</aside>
</div>
<script>
function showTab(name,el){
document.querySelectorAll('.tab').forEach(t=>t.classList.remove('active'));
document.querySelectorAll('.tab-content').forEach(t=>t.classList.remove('active'));
el.classList.add('active');
document.getElementById('tab-'+name).classList.add('active');
}
function copyInstall(btn){
navigator.clipboard.writeText('npm install @munesoft/cli-ui').then(()=>{
const o=btn.textContent; btn.textContent='✔ copied!'; btn.classList.add('copied');
setTimeout(()=>{btn.textContent=o;btn.classList.remove('copied');},2000);
});
}
</script>
</body>
</html>