@repobuddy/storybook 2.17.0 → 2.18.1

package/esm/storybook-addon-tag-badges/index.d.ts

@@ -8,12 +8,12 @@ type TagBadgeParameter = TagBadgeParameters[0];
 /**
  * Type representing the names of predefined tags used in Storybook stories.
  */
-type TagNames = 'editor' | 'source' | 'type' | 'func' | 'var' | 'new' | 'beta' | 'props' | 'deprecated' | 'outdated' | 'danger' | 'todo' | 'code-only' | 'snapshot' | 'unit' | 'integration' | 'keyboard' | 'internal' | 'usecase' | 'use-case' | 'version:next';
+type TagNames = '!test' | 'editor' | 'source' | 'type' | '!type' | 'func' | '!func' | 'var' | '!var' | 'new' | 'beta' | 'props' | 'deprecated' | 'outdated' | 'danger' | 'todo' | 'code-only' | 'snapshot' | '!snapshot' | 'unit' | 'integration' | 'keyboard' | 'internal' | 'usecase' | 'use-case' | 'version:next';
 /** Badge (✏️) for stories with a live editor. Shown in sidebar on story and inherited. */
 declare const editorBadge: TagBadgeParameter;
 /** Badge (🆕) for recently added stories. */
 declare const newBadge: TagBadgeParameter;
-/** Badge (🅱️) for stories covering features in beta. */
+/** Badge (🌱) for stories covering features in beta. */
 declare const betaBadge: TagBadgeParameter;
 /** Badge (🔧) for stories that demonstrate props or configuration. */
 declare const propsBadge: TagBadgeParameter;
@@ -45,27 +45,33 @@ declare const integrationBadge: TagBadgeParameter;
 declare const keyboardBadge: TagBadgeParameter;
 /** Badge (🔒) for internal or private-use-only stories. */
 declare const internalBadge: TagBadgeParameter;
+/** Badge (🎯) for stories that demonstrate a specific use case or scenario. */
+declare const useCaseBadge: TagBadgeParameter;
 /**
  * Configuration for story tag badges that appear in the Storybook sidebar.
  * Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
  *
- * The badges help visually identify stories with certain characteristics:
+ * Badge order (first match wins): New → Beta → Deprecated → Outdated → Danger → Use Case →
+ * Keyboard → Source → Type → Function → Var → Props → Todo → Unit → Integration → Editor →
+ * Code Only → Version → Internal → Snapshot.
+ *
  * - 🆕 New - Recently added stories
- * - 🅱️ Beta - Stories for features in beta
+ * - 🌱 Beta - Stories for features in beta
  * - 🪦 Deprecated - Stories for deprecated features
  * - ⚠️ Outdated - Stories that need updating
- * - ✏️ Editor - Stories with live editor
- * - 🧪 Unit - Stories with unit tests
- * - 🔗 Integration - Stories with integration tests
- * - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
  * - 🚨 Danger - Stories demonstrating dangerous patterns
+ * - 🎯 Use Case - Stories that demonstrate a specific use case or scenario
+ * - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
  * - `</>` Source - Source-code-focused stories
  * - `<T>` Type - Stories that showcase or document TypeScript types
  * - `ƒ(x)` Function - Stories that showcase or document functions
  * - `var` Variables - Stories that describe values and variables
  * - 🔧 Props - Stories that demonstrate props or configuration
- * - 📝 Code Only - Stories without visual examples
  * - 📋 Todo - Stories marked as todo/incomplete
+ * - 🧪 Unit - Stories with unit tests
+ * - 🔗 Integration - Stories with integration tests
+ * - ✏️ Editor - Stories with live editor
+ * - 📝 Code Only - Stories without visual examples
  * - `next` - (`version:next`) The component or function is available in the next version
  * - `x.y` - (`version:x.y`) The component or function was created or updated in the x.y version
  * - 🔒 Internal - Internal or private-use-only stories
@@ -144,4 +150,4 @@ type StoryObj<TMetaOrCmpOrArgs = Args> = ExtendStoryObj<TMetaOrCmpOrArgs, StoryO
   tag: TagNames;
 }>;
 //#endregion
-export { Meta, StoryObj, TagNames, betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, functionBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, propsBadge, snapshotBadge, sourceBadge, tagBadges, todoBadge, typeBadge, unitBadge, varBadge };
+export { Meta, StoryObj, TagNames, betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, functionBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, propsBadge, snapshotBadge, sourceBadge, tagBadges, todoBadge, typeBadge, unitBadge, useCaseBadge, varBadge };

package/esm/storybook-addon-tag-badges/index.js

@@ -31,11 +31,11 @@ const newBadge = {
 		tooltip: "New"
 	}
 };
-/** Badge (🅱️) for stories covering features in beta. */
+/** Badge (🌱) for stories covering features in beta. */
 const betaBadge = {
 	tags: "beta",
 	badge: {
-		text: "🅱️",
+		text: "🌱",
 		style: {
 			backgroundColor: "transparent",
 			borderColor: "transparent"
@@ -234,27 +234,43 @@ const internalBadge = {
 		tooltip: "Internal"
 	}
 };
+/** Badge (🎯) for stories that demonstrate a specific use case or scenario. */
+const useCaseBadge = {
+	tags: "use-case",
+	badge: {
+		text: "🎯",
+		style: {
+			backgroundColor: "transparent",
+			borderColor: "transparent"
+		},
+		tooltip: "Use Case"
+	}
+};
 /**
 * Configuration for story tag badges that appear in the Storybook sidebar.
 * Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
 *
-* The badges help visually identify stories with certain characteristics:
+* Badge order (first match wins): New → Beta → Deprecated → Outdated → Danger → Use Case →
+* Keyboard → Source → Type → Function → Var → Props → Todo → Unit → Integration → Editor →
+* Code Only → Version → Internal → Snapshot.
+*
 * - 🆕 New - Recently added stories
-* - 🅱️ Beta - Stories for features in beta
+* - 🌱 Beta - Stories for features in beta
 * - 🪦 Deprecated - Stories for deprecated features
 * - ⚠️ Outdated - Stories that need updating
-* - ✏️ Editor - Stories with live editor
-* - 🧪 Unit - Stories with unit tests
-* - 🔗 Integration - Stories with integration tests
-* - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
 * - 🚨 Danger - Stories demonstrating dangerous patterns
+* - 🎯 Use Case - Stories that demonstrate a specific use case or scenario
+* - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
 * - `</>` Source - Source-code-focused stories
 * - `<T>` Type - Stories that showcase or document TypeScript types
 * - `ƒ(x)` Function - Stories that showcase or document functions
 * - `var` Variables - Stories that describe values and variables
 * - 🔧 Props - Stories that demonstrate props or configuration
-* - 📝 Code Only - Stories without visual examples
 * - 📋 Todo - Stories marked as todo/incomplete
+* - 🧪 Unit - Stories with unit tests
+* - 🔗 Integration - Stories with integration tests
+* - ✏️ Editor - Stories with live editor
+* - 📝 Code Only - Stories without visual examples
 * - `next` - (`version:next`) The component or function is available in the next version
 * - `x.y` - (`version:x.y`) The component or function was created or updated in the x.y version
 * - 🔒 Internal - Internal or private-use-only stories
@@ -265,22 +281,23 @@ const tagBadges = [
 	betaBadge,
 	deprecatedBadge,
 	outdatedBadge,
-	editorBadge,
-	unitBadge,
-	integrationBadge,
-	keyboardBadge,
 	dangerBadge,
+	useCaseBadge,
+	keyboardBadge,
 	sourceBadge,
 	typeBadge,
 	functionBadge,
 	varBadge,
 	propsBadge,
-	codeOnlyBadge,
 	todoBadge,
+	unitBadge,
+	integrationBadge,
+	editorBadge,
+	codeOnlyBadge,
 	versionBadge,
 	internalBadge,
 	snapshotBadge
 ];
 
 //#endregion
-export { betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, functionBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, propsBadge, snapshotBadge, sourceBadge, tagBadges, todoBadge, typeBadge, unitBadge, varBadge };
+export { betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, functionBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, propsBadge, snapshotBadge, sourceBadge, tagBadges, todoBadge, typeBadge, unitBadge, useCaseBadge, varBadge };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@repobuddy/storybook",
-  "version": "2.17.0",
+  "version": "2.18.1",
   "description": "Storybook repo buddy",
   "keywords": [
     "storybook",

package/readme.md

@@ -76,21 +76,28 @@ addons.setConfig({
 ### `storybook-addon-tag-badges`
 
 If you use [`storybook-addon-tag-badges`][`storybook-addon-tag-badges`],
-we provide a different set of badges that uses emojis:
-
-- ✏️ `editor` - Live Editor Stories (with [`storybook-addon-code-editor`][`storybook-addon-code-editor`])
-- 🆕 `new` - New components/features
-- 🅱️ `beta` - Beta status
-- 🪦 `deprecated` - Deprecated notices
-- ⚠️ `outdated` - Outdated warnings
-- 🚨 `danger` - Dangerous
-- 📋 `todo` - To-do items
-- 📝 `code-only` - Code-only stories
-- 🔒 `internal` - Internal stories (when set up, hidden from the sidebar in public Storybook)
-- 📸 `snapshot` - Snapshot tests
+we provide a different set of badges that uses emojis (order: first match wins):
+
+- 🆕 `new` - Recently added stories
+- 🌱 `beta` - Features in beta
+- 🪦 `deprecated` - Deprecated features
+- ⚠️ `outdated` - Stories that need updating
+- 🚨 `danger` - Dangerous or cautionary patterns
+- 🎯 `use-case` - Specific use case or scenario
+- ⌨️ `keyboard` - Keyboard interaction
+- `</>` `source` - Source-code-focused stories
+- `<T>` `type` - TypeScript types (shown in MDX)
+- `ƒ(x)` `func` - Functions (shown in MDX)
+- `var` `var` - Variables (shown in MDX)
+- 🔧 `props` - Props or configuration
+- 📋 `todo` - Todo or incomplete stories
 - 🧪 `unit` - Unit tests
-- 🔗 `integration` - Integration tests
+- 🔗 `integration` - Integration tests (hidden in sidebar)
+- ✏️ `editor` - Live editor stories (with [`storybook-addon-code-editor`][`storybook-addon-code-editor`])
+- 📝 `code-only` - Stories without visual examples (hidden in MDX)
 - Version indicators (unchanged)
+- 🔒 `internal` - Internal or private-use-only stories
+- 📸 `snapshot` - Snapshot tests (toolbar only, not sidebar)
 
 To use them, add them to your `.storybook/manager.ts`:
 

package/src/storybook-addon-tag-badges/tag_badges.ts

@@ -8,11 +8,15 @@ type TagBadgeParameter = TagBadgeParameters[0]
  * Type representing the names of predefined tags used in Storybook stories.
  */
 export type TagNames =
+	| '!test'
 	| 'editor'
 	| 'source'
 	| 'type'
+	| '!type'
 	| 'func'
+	| '!func'
 	| 'var'
+	| '!var'
 	| 'new'
 	| 'beta'
 	| 'props'
@@ -22,6 +26,7 @@ export type TagNames =
 	| 'todo'
 	| 'code-only'
 	| 'snapshot'
+	| '!snapshot'
 	| 'unit'
 	| 'integration'
 	| 'keyboard'
@@ -62,11 +67,11 @@ export const newBadge: TagBadgeParameter = {
 	}
 }
 
-/** Badge (🅱️) for stories covering features in beta. */
+/** Badge (🌱) for stories covering features in beta. */
 export const betaBadge: TagBadgeParameter = {
 	tags: 'beta',
 	badge: {
-		text: '🅱️',
+		text: '🌱',
 		style: {
 			backgroundColor: 'transparent',
 			borderColor: 'transparent'
@@ -295,27 +300,44 @@ export const internalBadge: TagBadgeParameter = {
 	}
 }
 
+/** Badge (🎯) for stories that demonstrate a specific use case or scenario. */
+export const useCaseBadge: TagBadgeParameter = {
+	tags: 'use-case',
+	badge: {
+		text: '🎯',
+		style: {
+			backgroundColor: 'transparent',
+			borderColor: 'transparent'
+		},
+		tooltip: 'Use Case'
+	}
+}
+
 /**
  * Configuration for story tag badges that appear in the Storybook sidebar.
  * Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
  *
- * The badges help visually identify stories with certain characteristics:
+ * Badge order (first match wins): New → Beta → Deprecated → Outdated → Danger → Use Case →
+ * Keyboard → Source → Type → Function → Var → Props → Todo → Unit → Integration → Editor →
+ * Code Only → Version → Internal → Snapshot.
+ *
  * - 🆕 New - Recently added stories
- * - 🅱️ Beta - Stories for features in beta
+ * - 🌱 Beta - Stories for features in beta
  * - 🪦 Deprecated - Stories for deprecated features
  * - ⚠️ Outdated - Stories that need updating
- * - ✏️ Editor - Stories with live editor
- * - 🧪 Unit - Stories with unit tests
- * - 🔗 Integration - Stories with integration tests
- * - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
  * - 🚨 Danger - Stories demonstrating dangerous patterns
+ * - 🎯 Use Case - Stories that demonstrate a specific use case or scenario
+ * - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
  * - `</>` Source - Source-code-focused stories
  * - `<T>` Type - Stories that showcase or document TypeScript types
  * - `ƒ(x)` Function - Stories that showcase or document functions
  * - `var` Variables - Stories that describe values and variables
  * - 🔧 Props - Stories that demonstrate props or configuration
- * - 📝 Code Only - Stories without visual examples
  * - 📋 Todo - Stories marked as todo/incomplete
+ * - 🧪 Unit - Stories with unit tests
+ * - 🔗 Integration - Stories with integration tests
+ * - ✏️ Editor - Stories with live editor
+ * - 📝 Code Only - Stories without visual examples
  * - `next` - (`version:next`) The component or function is available in the next version
  * - `x.y` - (`version:x.y`) The component or function was created or updated in the x.y version
  * - 🔒 Internal - Internal or private-use-only stories
@@ -326,18 +348,19 @@ export const tagBadges: TagBadgeParameters = [
 	betaBadge,
 	deprecatedBadge,
 	outdatedBadge,
-	editorBadge,
-	unitBadge,
-	integrationBadge,
-	keyboardBadge,
 	dangerBadge,
+	useCaseBadge,
+	keyboardBadge,
 	sourceBadge,
 	typeBadge,
 	functionBadge,
 	varBadge,
 	propsBadge,
-	codeOnlyBadge,
 	todoBadge,
+	unitBadge,
+	integrationBadge,
+	editorBadge,
+	codeOnlyBadge,
 	versionBadge,
 	internalBadge,
 	snapshotBadge