@repobuddy/storybook 2.24.0 → 2.25.0

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

@@ -8,7 +8,7 @@ type TagBadgeParameter = TagBadgeParameters[0];
 /**
  * Type representing the names of predefined tags used in Storybook stories.
  */
-type TagNames = '!test' | 'editor' | 'source' | 'type' | '!type' | 'func' | '!func' | 'var' | '!var' | 'new' | 'alpha' | 'beta' | 'rc' | 'props' | 'deprecated' | 'outdated' | 'danger' | 'todo' | 'code-only' | 'snapshot' | '!snapshot' | 'unit' | 'integration' | 'keyboard' | 'internal' | 'usecase' | 'use-case' | 'playground' | 'example' | 'perf' | 'version:next' | 'remove' | 'remove:next' | 'autodocs';
+type TagNames = '!test' | 'editor' | 'source' | 'type' | '!type' | 'func' | '!func' | 'var' | '!var' | 'new' | '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';
 /** Badge (✏️) for stories with a live editor. Shown in sidebar on story and inherited. */
 declare const editorBadge: TagBadgeParameter;
 /** Badge (🆕) for recently added stories. */
@@ -29,6 +29,8 @@ declare const removeBadge: TagBadgeParameter;
 declare const outdatedBadge: TagBadgeParameter;
 /** Badge (🚨) for stories demonstrating dangerous or cautionary patterns. */
 declare const dangerBadge: TagBadgeParameter;
+/** Badge (📜) for stories that serve as the specification of the component or code. */
+declare const specBadge: TagBadgeParameter;
 /** Badge (📋) for stories marked as todo or incomplete. */
 declare const todoBadge: TagBadgeParameter;
 /** Badge (📝) for stories without visual examples (code-only). Hidden in MDX. */
@@ -64,8 +66,8 @@ declare const perfBadge: TagBadgeParameter;
  * Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
  *
  * Badge order (first match wins): New → Alpha → Beta → RC → Deprecated → Remove → Outdated → Danger → Use Case →
- * Playground → Example → Perf → Keyboard → Source → Type → Function → Var → Props → Todo → Unit → Integration →
- * Editor → Code Only → Version → Internal → Snapshot.
+ * Spec → Playground → Example → Perf → Keyboard → Source → Type → Function → Var → Props → Todo → Unit →
+ * Integration → Editor → Code Only → Version → Internal → Snapshot.
  *
  * - 🆕 New - Recently added stories
  * - 🔴 Alpha - Stories for features in alpha
@@ -76,6 +78,7 @@ declare const perfBadge: TagBadgeParameter;
  * - ⚠️ Outdated - Stories that need updating
  * - 🚨 Danger - Stories demonstrating dangerous patterns
  * - 🎯 Use Case - Stories that demonstrate a specific use case or scenario
+ * - 📜 Spec - Stories that serve as the specification of the component or code
  * - ▶️ Playground - High-quality interactive stories for users to explore and interact with the component
  * - ✨ Example - Example or demo stories
  * - ⚡ Perf - Stories that demonstrate or test performance
@@ -168,4 +171,4 @@ type StoryObj<TMetaOrCmpOrArgs = Args> = ExtendStoryObj<TMetaOrCmpOrArgs, StoryO
   tag: TagNames;
 }>;
 //#endregion
-export { Meta, StoryObj, TagNames, alphaBadge, betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, exampleBadge, functionBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, perfBadge, playgroundBadge, propsBadge, rcBadge, removeBadge, snapshotBadge, sourceBadge, tagBadges, todoBadge, typeBadge, unitBadge, useCaseBadge, varBadge };
+export { Meta, StoryObj, TagNames, 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 };

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

@@ -144,6 +144,22 @@ const dangerBadge = {
 		tooltip: "Dangerous"
 	}
 };
+/** Badge (📜) for stories that serve as the specification of the component or code. */
+const specBadge = {
+	tags: "spec",
+	badge: {
+		text: "📜",
+		style: {
+			backgroundColor: "transparent",
+			borderColor: "transparent"
+		},
+		tooltip: "Specification"
+	},
+	display: { sidebar: {
+		type: "story",
+		skipInherited: false
+	} }
+};
 /** Badge (📋) for stories marked as todo or incomplete. */
 const todoBadge = {
 	tags: "todo",
@@ -368,8 +384,8 @@ const perfBadge = {
 * Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
 *
 * Badge order (first match wins): New → Alpha → Beta → RC → Deprecated → Remove → Outdated → Danger → Use Case →
-* Playground → Example → Perf → Keyboard → Source → Type → Function → Var → Props → Todo → Unit → Integration →
-* Editor → Code Only → Version → Internal → Snapshot.
+* Spec → Playground → Example → Perf → Keyboard → Source → Type → Function → Var → Props → Todo → Unit →
+* Integration → Editor → Code Only → Version → Internal → Snapshot.
 *
 * - 🆕 New - Recently added stories
 * - 🔴 Alpha - Stories for features in alpha
@@ -380,6 +396,7 @@ const perfBadge = {
 * - ⚠️ Outdated - Stories that need updating
 * - 🚨 Danger - Stories demonstrating dangerous patterns
 * - 🎯 Use Case - Stories that demonstrate a specific use case or scenario
+* - 📜 Spec - Stories that serve as the specification of the component or code
 * - ▶️ Playground - High-quality interactive stories for users to explore and interact with the component
 * - ✨ Example - Example or demo stories
 * - ⚡ Perf - Stories that demonstrate or test performance
@@ -409,6 +426,7 @@ const tagBadges = [
 	outdatedBadge,
 	dangerBadge,
 	useCaseBadge,
+	specBadge,
 	playgroundBadge,
 	exampleBadge,
 	perfBadge,
@@ -429,4 +447,4 @@ const tagBadges = [
 ];
 
 //#endregion
-export { alphaBadge, betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, exampleBadge, functionBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, perfBadge, playgroundBadge, propsBadge, rcBadge, removeBadge, snapshotBadge, sourceBadge, tagBadges, todoBadge, typeBadge, unitBadge, useCaseBadge, varBadge };
+export { 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 };

package/package.json

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

package/readme.md

@@ -89,6 +89,7 @@ we provide a different set of badges that uses emojis (order: first match wins):
 | ⚠️      | `outdated`                                               | Stories that need updating                                                                |
 | 🚨      | `danger`                                                 | Dangerous or cautionary patterns                                                          |
 | 🎯      | `use-case`                                               | Specific use case or scenario                                                             |
+| 📜      | `spec`                                                    | Specification of the component or code                                                    |
 | ▶️      | `playground`                                             | High-quality interactive stories for users to explore and interact with the component     |
 | ✨      | `example`                                                | Example or demo stories                                                                   |
 | ⚡      | `perf`                                                   | Performance (stories that demonstrate or test performance)                                |

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

@@ -27,6 +27,7 @@ export type TagNames =
 	| 'danger'
 	| 'todo'
 	| 'code-only'
+	| 'spec'
 	| 'snapshot'
 	| '!snapshot'
 	| 'unit'
@@ -199,6 +200,25 @@ export const dangerBadge: TagBadgeParameter = {
 	}
 }
 
+/** Badge (📜) for stories that serve as the specification of the component or code. */
+export const specBadge: TagBadgeParameter = {
+	tags: 'spec',
+	badge: {
+		text: '📜',
+		style: {
+			backgroundColor: 'transparent',
+			borderColor: 'transparent'
+		},
+		tooltip: 'Specification'
+	},
+	display: {
+		sidebar: {
+			type: 'story',
+			skipInherited: false
+		}
+	}
+}
+
 /** Badge (📋) for stories marked as todo or incomplete. */
 export const todoBadge: TagBadgeParameter = {
 	tags: 'todo',
@@ -458,8 +478,8 @@ export const perfBadge: TagBadgeParameter = {
  * Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
  *
  * Badge order (first match wins): New → Alpha → Beta → RC → Deprecated → Remove → Outdated → Danger → Use Case →
- * Playground → Example → Perf → Keyboard → Source → Type → Function → Var → Props → Todo → Unit → Integration →
- * Editor → Code Only → Version → Internal → Snapshot.
+ * Spec → Playground → Example → Perf → Keyboard → Source → Type → Function → Var → Props → Todo → Unit →
+ * Integration → Editor → Code Only → Version → Internal → Snapshot.
  *
  * - 🆕 New - Recently added stories
  * - 🔴 Alpha - Stories for features in alpha
@@ -470,6 +490,7 @@ export const perfBadge: TagBadgeParameter = {
  * - ⚠️ Outdated - Stories that need updating
  * - 🚨 Danger - Stories demonstrating dangerous patterns
  * - 🎯 Use Case - Stories that demonstrate a specific use case or scenario
+ * - 📜 Spec - Stories that serve as the specification of the component or code
  * - ▶️ Playground - High-quality interactive stories for users to explore and interact with the component
  * - ✨ Example - Example or demo stories
  * - ⚡ Perf - Stories that demonstrate or test performance
@@ -499,6 +520,7 @@ export const tagBadges: TagBadgeParameters = [
 	outdatedBadge,
 	dangerBadge,
 	useCaseBadge,
+	specBadge,
 	playgroundBadge,
 	exampleBadge,
 	perfBadge,