@repobuddy/storybook 2.26.0 → 2.27.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.
@@ -8,7 +8,7 @@ type TagBadgeParameter = TagBadgeParameters[0];
8
8
  /**
9
9
  * Type representing the names of predefined tags used in Storybook stories.
10
10
  */
11
- type TagNames = '!test' | 'editor' | 'source' | 'type' | '!type' | 'func' | '!func' | 'var' | '!var' | 'new' | 'a11y' | 'alpha' | 'beta' | 'rc' | 'props' | 'deprecated' | 'outdated' | 'danger' | 'todo' | 'code-only' | 'spec' | 'snapshot' | '!snapshot' | 'unit' | 'integration' | 'keyboard' | 'internal' | 'usecase' | 'use-case' | 'playground' | 'example' | 'perf' | 'version:next' | 'remove' | 'remove:next' | 'autodocs';
11
+ type TagNames = '!test' | 'editor' | 'source' | 'type' | '!type' | 'class' | '!class' | 'func' | '!func' | 'var' | '!var' | 'new' | 'a11y' | 'alpha' | 'beta' | 'rc' | 'props' | 'deprecated' | 'outdated' | 'danger' | 'todo' | 'code-only' | 'spec' | 'snapshot' | '!snapshot' | 'unit' | 'integration' | 'keyboard' | 'internal' | 'usecase' | 'use-case' | 'playground' | 'example' | 'perf' | 'version:next' | 'remove' | 'remove:next' | 'autodocs';
12
12
  /** Badge (✏️) for stories with a live editor. Shown in sidebar on story and inherited. */
13
13
  declare const editorBadge: TagBadgeParameter;
14
14
  /** Badge (🆕) for recently added stories. */
@@ -37,6 +37,8 @@ declare const todoBadge: TagBadgeParameter;
37
37
  declare const codeOnlyBadge: TagBadgeParameter;
38
38
  /** Badge (<T>) for stories that showcase or document TypeScript types. Hidden in MDX. */
39
39
  declare const typeBadge: TagBadgeParameter;
40
+ /** Badge (🔷) for stories that showcase or document classes. Hidden in MDX. */
41
+ declare const classBadge: TagBadgeParameter;
40
42
  /** Badge (ƒ(x)) for stories that showcase or document functions. Hidden in MDX. */
41
43
  declare const functionBadge: TagBadgeParameter;
42
44
  /** Badge (var) for stories that describe values and variables. */
@@ -68,7 +70,7 @@ declare const perfBadge: TagBadgeParameter;
68
70
  * Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
69
71
  *
70
72
  * Badge order (first match wins): New → Alpha → Beta → RC → Deprecated → Remove → Outdated → Danger → Use Case →
71
- * Spec → Playground → Example → Perf → A11y → Keyboard → Source → Type → Function → Var → Props → Todo → Unit →
73
+ * Spec → Playground → Example → Perf → A11y → Keyboard → Source → Type → Class → Function → Var → Props → Todo → Unit →
72
74
  * Integration → Editor → Code Only → Version → Internal → Snapshot.
73
75
  *
74
76
  * - 🆕 New - Recently added stories
@@ -87,10 +89,11 @@ declare const perfBadge: TagBadgeParameter;
87
89
  * - ♿ A11y - Stories that demonstrate or test accessibility
88
90
  * - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
89
91
  * - `</>` Source - Source-code-focused stories
92
+ * - 🔧 Props - Stories that demonstrate props or configuration
90
93
  * - `<T>` Type - Stories that showcase or document TypeScript types
94
+ * - 🔷 Class - Stories that showcase or document classes
91
95
  * - `ƒ(x)` Function - Stories that showcase or document functions
92
96
  * - `var` Variables - Stories that describe values and variables
93
- * - 🔧 Props - Stories that demonstrate props or configuration
94
97
  * - 📋 Todo - Stories marked as todo/incomplete
95
98
  * - 🧪 Unit - Stories with unit tests
96
99
  * - 🔗 Integration - Stories with integration tests
@@ -174,4 +177,4 @@ type StoryObj<TMetaOrCmpOrArgs = Args> = ExtendStoryObj<TMetaOrCmpOrArgs, StoryO
174
177
  tag: TagNames;
175
178
  }>;
176
179
  //#endregion
177
- export { Meta, StoryObj, TagNames, a11yBadge, alphaBadge, betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, exampleBadge, functionBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, perfBadge, playgroundBadge, propsBadge, rcBadge, removeBadge, snapshotBadge, sourceBadge, specBadge, tagBadges, todoBadge, typeBadge, unitBadge, useCaseBadge, varBadge };
180
+ export { Meta, StoryObj, TagNames, a11yBadge, alphaBadge, betaBadge, classBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, exampleBadge, functionBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, perfBadge, playgroundBadge, propsBadge, rcBadge, removeBadge, snapshotBadge, sourceBadge, specBadge, tagBadges, todoBadge, typeBadge, unitBadge, useCaseBadge, varBadge };
@@ -198,6 +198,19 @@ const typeBadge = {
198
198
  },
199
199
  display: { mdx: true }
200
200
  };
201
+ /** Badge (🔷) for stories that showcase or document classes. Hidden in MDX. */
202
+ const classBadge = {
203
+ tags: "class",
204
+ badge: {
205
+ text: "🔷",
206
+ style: {
207
+ backgroundColor: "transparent",
208
+ borderColor: "transparent"
209
+ },
210
+ tooltip: "Class"
211
+ },
212
+ display: { mdx: true }
213
+ };
201
214
  /** Badge (ƒ(x)) for stories that showcase or document functions. Hidden in MDX. */
202
215
  const functionBadge = {
203
216
  tags: "func",
@@ -400,7 +413,7 @@ const perfBadge = {
400
413
  * Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
401
414
  *
402
415
  * Badge order (first match wins): New → Alpha → Beta → RC → Deprecated → Remove → Outdated → Danger → Use Case →
403
- * Spec → Playground → Example → Perf → A11y → Keyboard → Source → Type → Function → Var → Props → Todo → Unit →
416
+ * Spec → Playground → Example → Perf → A11y → Keyboard → Source → Type → Class → Function → Var → Props → Todo → Unit →
404
417
  * Integration → Editor → Code Only → Version → Internal → Snapshot.
405
418
  *
406
419
  * - 🆕 New - Recently added stories
@@ -419,10 +432,11 @@ const perfBadge = {
419
432
  * - ♿ A11y - Stories that demonstrate or test accessibility
420
433
  * - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
421
434
  * - `</>` Source - Source-code-focused stories
435
+ * - 🔧 Props - Stories that demonstrate props or configuration
422
436
  * - `<T>` Type - Stories that showcase or document TypeScript types
437
+ * - 🔷 Class - Stories that showcase or document classes
423
438
  * - `ƒ(x)` Function - Stories that showcase or document functions
424
439
  * - `var` Variables - Stories that describe values and variables
425
- * - 🔧 Props - Stories that demonstrate props or configuration
426
440
  * - 📋 Todo - Stories marked as todo/incomplete
427
441
  * - 🧪 Unit - Stories with unit tests
428
442
  * - 🔗 Integration - Stories with integration tests
@@ -447,13 +461,14 @@ const tagBadges = [
447
461
  playgroundBadge,
448
462
  exampleBadge,
449
463
  perfBadge,
464
+ sourceBadge,
450
465
  a11yBadge,
451
466
  keyboardBadge,
452
- sourceBadge,
467
+ propsBadge,
453
468
  typeBadge,
469
+ classBadge,
454
470
  functionBadge,
455
471
  varBadge,
456
- propsBadge,
457
472
  todoBadge,
458
473
  unitBadge,
459
474
  integrationBadge,
@@ -465,4 +480,4 @@ const tagBadges = [
465
480
  ];
466
481
 
467
482
  //#endregion
468
- export { a11yBadge, alphaBadge, betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, exampleBadge, functionBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, perfBadge, playgroundBadge, propsBadge, rcBadge, removeBadge, snapshotBadge, sourceBadge, specBadge, tagBadges, todoBadge, typeBadge, unitBadge, useCaseBadge, varBadge };
483
+ export { a11yBadge, alphaBadge, betaBadge, classBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, exampleBadge, functionBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, perfBadge, playgroundBadge, propsBadge, rcBadge, removeBadge, snapshotBadge, sourceBadge, specBadge, tagBadges, todoBadge, typeBadge, unitBadge, useCaseBadge, varBadge };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@repobuddy/storybook",
3
- "version": "2.26.0",
3
+ "version": "2.27.0",
4
4
  "description": "Storybook repo buddy",
5
5
  "keywords": [
6
6
  "storybook",
package/readme.md CHANGED
@@ -97,6 +97,7 @@ we provide a different set of badges that uses emojis (order: first match wins):
97
97
  | ⌨️ | `keyboard` | Keyboard interaction |
98
98
  | `</>` | `source` | Source-code-focused stories |
99
99
  | `<T>` | `type` | TypeScript types (shown in MDX) |
100
+ | 🔷 | `class` | Classes (shown in MDX) |
100
101
  | `ƒ(x)` | `func` | Functions (shown in MDX) |
101
102
  | `var` | `var` | Variables (shown in MDX) |
102
103
  | 🔧 | `props` | Props or configuration |
@@ -13,6 +13,8 @@ export type TagNames =
13
13
  | 'source'
14
14
  | 'type'
15
15
  | '!type'
16
+ | 'class'
17
+ | '!class'
16
18
  | 'func'
17
19
  | '!func'
18
20
  | 'var'
@@ -265,6 +267,22 @@ export const typeBadge: TagBadgeParameter = {
265
267
  }
266
268
  }
267
269
 
270
+ /** Badge (🔷) for stories that showcase or document classes. Hidden in MDX. */
271
+ export const classBadge: TagBadgeParameter = {
272
+ tags: 'class',
273
+ badge: {
274
+ text: '🔷',
275
+ style: {
276
+ backgroundColor: 'transparent',
277
+ borderColor: 'transparent'
278
+ },
279
+ tooltip: 'Class'
280
+ },
281
+ display: {
282
+ mdx: true
283
+ }
284
+ }
285
+
268
286
  /** Badge (ƒ(x)) for stories that showcase or document functions. Hidden in MDX. */
269
287
  export const functionBadge: TagBadgeParameter = {
270
288
  tags: 'func',
@@ -498,7 +516,7 @@ export const perfBadge: TagBadgeParameter = {
498
516
  * Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
499
517
  *
500
518
  * Badge order (first match wins): New → Alpha → Beta → RC → Deprecated → Remove → Outdated → Danger → Use Case →
501
- * Spec → Playground → Example → Perf → A11y → Keyboard → Source → Type → Function → Var → Props → Todo → Unit →
519
+ * Spec → Playground → Example → Perf → A11y → Keyboard → Source → Type → Class → Function → Var → Props → Todo → Unit →
502
520
  * Integration → Editor → Code Only → Version → Internal → Snapshot.
503
521
  *
504
522
  * - 🆕 New - Recently added stories
@@ -517,10 +535,11 @@ export const perfBadge: TagBadgeParameter = {
517
535
  * - ♿ A11y - Stories that demonstrate or test accessibility
518
536
  * - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
519
537
  * - `</>` Source - Source-code-focused stories
538
+ * - 🔧 Props - Stories that demonstrate props or configuration
520
539
  * - `<T>` Type - Stories that showcase or document TypeScript types
540
+ * - 🔷 Class - Stories that showcase or document classes
521
541
  * - `ƒ(x)` Function - Stories that showcase or document functions
522
542
  * - `var` Variables - Stories that describe values and variables
523
- * - 🔧 Props - Stories that demonstrate props or configuration
524
543
  * - 📋 Todo - Stories marked as todo/incomplete
525
544
  * - 🧪 Unit - Stories with unit tests
526
545
  * - 🔗 Integration - Stories with integration tests
@@ -545,13 +564,14 @@ export const tagBadges: TagBadgeParameters = [
545
564
  playgroundBadge,
546
565
  exampleBadge,
547
566
  perfBadge,
567
+ sourceBadge,
548
568
  a11yBadge,
549
569
  keyboardBadge,
550
- sourceBadge,
570
+ propsBadge,
551
571
  typeBadge,
572
+ classBadge,
552
573
  functionBadge,
553
574
  varBadge,
554
- propsBadge,
555
575
  todoBadge,
556
576
  unitBadge,
557
577
  integrationBadge,