@repobuddy/storybook 2.14.0 → 2.15.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.
Files changed (5) hide show
  1. package/esm/storybook-addon-tag-badges/index.d.ts +20 -2
  2. package/esm/storybook-addon-tag-badges/index.js +31 -1
  3. package/package.json +1 -1
  4. package/readme.md +4 -0
  5. package/src/storybook-addon-tag-badges/tag_badges.ts +35 -0
package/esm/storybook-addon-tag-badges/index.d.ts CHANGED
@@ -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 = 'editor' | 'source' | 'new' | 'beta' | 'props' | 'deprecated' | 'outdated' | 'danger' | 'todo' | 'code-only' | 'snapshot' | 'unit' | 'integration' | 'keyboard' | 'internal' | 'usecase' | 'version:next';
11
+ type TagNames = 'editor' | 'source' | 'type' | 'new' | 'beta' | 'props' | 'deprecated' | 'outdated' | 'danger' | 'todo' | 'code-only' | 'snapshot' | 'unit' | 'integration' | 'keyboard' | 'internal' | 'usecase' | 'version:next';
12
12
  /**
13
13
  * Configuration for story tag badges that appear in the Storybook sidebar.
14
14
  * Each badge is associated with a specific tag and displays an emoji with a tooltip.
@@ -28,21 +28,39 @@ type TagNames = 'editor' | 'source' | 'new' | 'beta' | 'props' | 'deprecated' |
28
28
  *
29
29
  * Also includes the default version badge from `storybook-addon-tag-badges`.
30
30
  */
31
+ /** Badge (✏️) for stories with a live editor. Shown in sidebar on story and inherited. */
31
32
  declare const editorBadge: TagBadgeParameter;
33
+ /** Badge (🆕) for recently added stories. */
32
34
  declare const newBadge: TagBadgeParameter;
35
+ /** Badge (🅱️) for stories covering features in beta. */
33
36
  declare const betaBadge: TagBadgeParameter;
37
+ /** Badge (🔧) for stories that demonstrate props or configuration. */
34
38
  declare const propsBadge: TagBadgeParameter;
39
+ /** Badge (🪦) for stories documenting deprecated features. */
35
40
  declare const deprecatedBadge: TagBadgeParameter;
41
+ /** Badge (⚠️) for stories that need updating. */
36
42
  declare const outdatedBadge: TagBadgeParameter;
43
+ /** Badge (🚨) for stories demonstrating dangerous or cautionary patterns. */
37
44
  declare const dangerBadge: TagBadgeParameter;
45
+ /** Badge (📋) for stories marked as todo or incomplete. */
38
46
  declare const todoBadge: TagBadgeParameter;
47
+ /** Badge (📝) for stories without visual examples (code-only). Hidden in MDX. */
39
48
  declare const codeOnlyBadge: TagBadgeParameter;
49
+ /** Badge (<T>) for stories that showcase or document TypeScript types. Hidden in MDX. */
50
+ declare const typeBadge: TagBadgeParameter;
51
+ /** Badge (`</>`) for source-code-focused stories. Hidden in MDX. */
40
52
  declare const sourceBadge: TagBadgeParameter;
53
+ /** Badge (📸) for stories with snapshot tests. Shown in toolbar only, not in sidebar. */
41
54
  declare const snapshotBadge: TagBadgeParameter;
55
+ /** Badge (🧪) for stories with unit tests. */
42
56
  declare const unitBadge: TagBadgeParameter;
57
+ /** Badge (🔗) for stories with integration tests. Hidden in sidebar. */
43
58
  declare const integrationBadge: TagBadgeParameter;
59
+ /** Badge (⌨️) for stories that demonstrate or test keyboard interaction. */
44
60
  declare const keyboardBadge: TagBadgeParameter;
61
+ /** Badge (🔒) for internal or private-use-only stories. */
45
62
  declare const internalBadge: TagBadgeParameter;
63
+ /** Ordered list of all tag badge configs used by the addon (includes version badge). */
46
64
  declare const tagBadges: TagBadgeParameters;
47
65
  //#endregion
48
66
  //#region src/types/_extract_string_literals.d.ts
@@ -116,4 +134,4 @@ type StoryObj<TMetaOrCmpOrArgs = Args> = ExtendStoryObj<TMetaOrCmpOrArgs, StoryO
116
134
  tag: TagNames;
117
135
  }>;
118
136
  //#endregion
119
- export { Meta, StoryObj, TagNames, betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, propsBadge, snapshotBadge, sourceBadge, tagBadges, todoBadge, unitBadge };
137
+ export { Meta, StoryObj, TagNames, betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, propsBadge, snapshotBadge, sourceBadge, tagBadges, todoBadge, typeBadge, unitBadge };
package/esm/storybook-addon-tag-badges/index.js CHANGED
@@ -22,6 +22,7 @@ const [, , , , , , versionBadge] = defaultConfig;
22
22
  *
23
23
  * Also includes the default version badge from `storybook-addon-tag-badges`.
24
24
  */
25
+ /** Badge (✏️) for stories with a live editor. Shown in sidebar on story and inherited. */
25
26
  const editorBadge = {
26
27
  tags: "editor",
27
28
  badge: {
@@ -37,6 +38,7 @@ const editorBadge = {
37
38
  skipInherited: false
38
39
  } }
39
40
  };
41
+ /** Badge (🆕) for recently added stories. */
40
42
  const newBadge = {
41
43
  tags: "new",
42
44
  badge: {
@@ -48,6 +50,7 @@ const newBadge = {
48
50
  tooltip: "New"
49
51
  }
50
52
  };
53
+ /** Badge (🅱️) for stories covering features in beta. */
51
54
  const betaBadge = {
52
55
  tags: "beta",
53
56
  badge: {
@@ -59,6 +62,7 @@ const betaBadge = {
59
62
  tooltip: "Beta"
60
63
  }
61
64
  };
65
+ /** Badge (🔧) for stories that demonstrate props or configuration. */
62
66
  const propsBadge = {
63
67
  tags: "props",
64
68
  badge: {
@@ -70,6 +74,7 @@ const propsBadge = {
70
74
  tooltip: "Props"
71
75
  }
72
76
  };
77
+ /** Badge (🪦) for stories documenting deprecated features. */
73
78
  const deprecatedBadge = {
74
79
  tags: "deprecated",
75
80
  badge: {
@@ -81,6 +86,7 @@ const deprecatedBadge = {
81
86
  tooltip: "Deprecated"
82
87
  }
83
88
  };
89
+ /** Badge (⚠️) for stories that need updating. */
84
90
  const outdatedBadge = {
85
91
  tags: "outdated",
86
92
  badge: {
@@ -92,6 +98,7 @@ const outdatedBadge = {
92
98
  tooltip: "Outdated"
93
99
  }
94
100
  };
101
+ /** Badge (🚨) for stories demonstrating dangerous or cautionary patterns. */
95
102
  const dangerBadge = {
96
103
  tags: "danger",
97
104
  badge: {
@@ -103,6 +110,7 @@ const dangerBadge = {
103
110
  tooltip: "Dangerous"
104
111
  }
105
112
  };
113
+ /** Badge (📋) for stories marked as todo or incomplete. */
106
114
  const todoBadge = {
107
115
  tags: "todo",
108
116
  badge: {
@@ -114,6 +122,7 @@ const todoBadge = {
114
122
  tooltip: "Todo"
115
123
  }
116
124
  };
125
+ /** Badge (📝) for stories without visual examples (code-only). Hidden in MDX. */
117
126
  const codeOnlyBadge = {
118
127
  tags: "code-only",
119
128
  badge: {
@@ -126,6 +135,20 @@ const codeOnlyBadge = {
126
135
  },
127
136
  display: { mdx: false }
128
137
  };
138
+ /** Badge (<T>) for stories that showcase or document TypeScript types. Hidden in MDX. */
139
+ const typeBadge = {
140
+ tags: "type",
141
+ badge: {
142
+ text: "<T>",
143
+ style: {
144
+ backgroundColor: "transparent",
145
+ borderColor: "transparent"
146
+ },
147
+ tooltip: "TypeScript Types"
148
+ },
149
+ display: { mdx: false }
150
+ };
151
+ /** Badge (`</>`) for source-code-focused stories. Hidden in MDX. */
129
152
  const sourceBadge = {
130
153
  tags: "source",
131
154
  badge: {
@@ -138,6 +161,7 @@ const sourceBadge = {
138
161
  },
139
162
  display: { mdx: false }
140
163
  };
164
+ /** Badge (📸) for stories with snapshot tests. Shown in toolbar only, not in sidebar. */
141
165
  const snapshotBadge = {
142
166
  tags: "snapshot",
143
167
  badge: {
@@ -153,6 +177,7 @@ const snapshotBadge = {
153
177
  toolbar: ["story"]
154
178
  }
155
179
  };
180
+ /** Badge (🧪) for stories with unit tests. */
156
181
  const unitBadge = {
157
182
  tags: "unit",
158
183
  badge: {
@@ -165,6 +190,7 @@ const unitBadge = {
165
190
  },
166
191
  display: { sidebar: true }
167
192
  };
193
+ /** Badge (🔗) for stories with integration tests. Hidden in sidebar. */
168
194
  const integrationBadge = {
169
195
  tags: "integration",
170
196
  badge: {
@@ -177,6 +203,7 @@ const integrationBadge = {
177
203
  },
178
204
  display: { sidebar: false }
179
205
  };
206
+ /** Badge (⌨️) for stories that demonstrate or test keyboard interaction. */
180
207
  const keyboardBadge = {
181
208
  tags: "keyboard",
182
209
  badge: {
@@ -188,6 +215,7 @@ const keyboardBadge = {
188
215
  tooltip: "Keyboard Interaction"
189
216
  }
190
217
  };
218
+ /** Badge (🔒) for internal or private-use-only stories. */
191
219
  const internalBadge = {
192
220
  tags: "internal",
193
221
  badge: {
@@ -199,9 +227,11 @@ const internalBadge = {
199
227
  tooltip: "Internal"
200
228
  }
201
229
  };
230
+ /** Ordered list of all tag badge configs used by the addon (includes version badge). */
202
231
  const tagBadges = [
203
232
  editorBadge,
204
233
  sourceBadge,
234
+ typeBadge,
205
235
  unitBadge,
206
236
  integrationBadge,
207
237
  keyboardBadge,
@@ -219,4 +249,4 @@ const tagBadges = [
219
249
  ];
220
250
 
221
251
  //#endregion
222
- export { betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, propsBadge, snapshotBadge, sourceBadge, tagBadges, todoBadge, unitBadge };
252
+ export { betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, propsBadge, snapshotBadge, sourceBadge, tagBadges, todoBadge, typeBadge, unitBadge };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@repobuddy/storybook",
3
- "version": "2.14.0",
3
+ "version": "2.15.0",
4
4
  "description": "Storybook repo buddy",
5
5
  "keywords": [
6
6
  "storybook",
package/readme.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # @repobuddy/storybook
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/@repobuddy/storybook.svg)](https://www.npmjs.com/package/@repobuddy/storybook)
4
+ [![npm downloads](https://img.shields.io/npm/dm/@repobuddy/storybook.svg)](https://www.npmjs.com/package/@repobuddy/storybook)
5
+ [![GitHub Actions](https://github.com/repobuddy/storybook/actions/workflows/release.yml/badge.svg)](https://github.com/repobuddy/storybook/actions/workflows/release.yml)
6
+
3
7
  Your repository buddy for Storybook.
4
8
 
5
9
  > [!NOTE]
package/src/storybook-addon-tag-badges/tag_badges.ts CHANGED
@@ -10,6 +10,7 @@ type TagBadgeParameter = TagBadgeParameters[0]
10
10
  export type TagNames =
11
11
  | 'editor'
12
12
  | 'source'
13
+ | 'type'
13
14
  | 'new'
14
15
  | 'beta'
15
16
  | 'props'
@@ -45,6 +46,8 @@ export type TagNames =
45
46
  *
46
47
  * Also includes the default version badge from `storybook-addon-tag-badges`.
47
48
  */
49
+
50
+ /** Badge (✏️) for stories with a live editor. Shown in sidebar on story and inherited. */
48
51
  export const editorBadge: TagBadgeParameter = {
49
52
  tags: 'editor',
50
53
  badge: {
@@ -63,6 +66,7 @@ export const editorBadge: TagBadgeParameter = {
63
66
  }
64
67
  }
65
68
 
69
+ /** Badge (🆕) for recently added stories. */
66
70
  export const newBadge: TagBadgeParameter = {
67
71
  tags: 'new',
68
72
  badge: {
@@ -75,6 +79,7 @@ export const newBadge: TagBadgeParameter = {
75
79
  }
76
80
  }
77
81
 
82
+ /** Badge (🅱️) for stories covering features in beta. */
78
83
  export const betaBadge: TagBadgeParameter = {
79
84
  tags: 'beta',
80
85
  badge: {
@@ -87,6 +92,7 @@ export const betaBadge: TagBadgeParameter = {
87
92
  }
88
93
  }
89
94
 
95
+ /** Badge (🔧) for stories that demonstrate props or configuration. */
90
96
  export const propsBadge: TagBadgeParameter = {
91
97
  tags: 'props',
92
98
  badge: {
@@ -99,6 +105,7 @@ export const propsBadge: TagBadgeParameter = {
99
105
  }
100
106
  }
101
107
 
108
+ /** Badge (🪦) for stories documenting deprecated features. */
102
109
  export const deprecatedBadge: TagBadgeParameter = {
103
110
  tags: 'deprecated',
104
111
  badge: {
@@ -111,6 +118,7 @@ export const deprecatedBadge: TagBadgeParameter = {
111
118
  }
112
119
  }
113
120
 
121
+ /** Badge (⚠️) for stories that need updating. */
114
122
  export const outdatedBadge: TagBadgeParameter = {
115
123
  tags: 'outdated',
116
124
  badge: {
@@ -123,6 +131,7 @@ export const outdatedBadge: TagBadgeParameter = {
123
131
  }
124
132
  }
125
133
 
134
+ /** Badge (🚨) for stories demonstrating dangerous or cautionary patterns. */
126
135
  export const dangerBadge: TagBadgeParameter = {
127
136
  tags: 'danger',
128
137
  badge: {
@@ -135,6 +144,7 @@ export const dangerBadge: TagBadgeParameter = {
135
144
  }
136
145
  }
137
146
 
147
+ /** Badge (📋) for stories marked as todo or incomplete. */
138
148
  export const todoBadge: TagBadgeParameter = {
139
149
  tags: 'todo',
140
150
  badge: {
@@ -147,6 +157,7 @@ export const todoBadge: TagBadgeParameter = {
147
157
  }
148
158
  }
149
159
 
160
+ /** Badge (📝) for stories without visual examples (code-only). Hidden in MDX. */
150
161
  export const codeOnlyBadge: TagBadgeParameter = {
151
162
  tags: 'code-only',
152
163
  badge: {
@@ -162,6 +173,23 @@ export const codeOnlyBadge: TagBadgeParameter = {
162
173
  }
163
174
  }
164
175
 
176
+ /** Badge (<T>) for stories that showcase or document TypeScript types. Hidden in MDX. */
177
+ export const typeBadge: TagBadgeParameter = {
178
+ tags: 'type',
179
+ badge: {
180
+ text: '<T>',
181
+ style: {
182
+ backgroundColor: 'transparent',
183
+ borderColor: 'transparent'
184
+ },
185
+ tooltip: 'TypeScript Types'
186
+ },
187
+ display: {
188
+ mdx: false
189
+ }
190
+ }
191
+
192
+ /** Badge (`</>`) for source-code-focused stories. Hidden in MDX. */
165
193
  export const sourceBadge: TagBadgeParameter = {
166
194
  tags: 'source',
167
195
  badge: {
@@ -177,6 +205,7 @@ export const sourceBadge: TagBadgeParameter = {
177
205
  }
178
206
  }
179
207
 
208
+ /** Badge (📸) for stories with snapshot tests. Shown in toolbar only, not in sidebar. */
180
209
  export const snapshotBadge: TagBadgeParameter = {
181
210
  tags: 'snapshot',
182
211
  badge: {
@@ -193,6 +222,7 @@ export const snapshotBadge: TagBadgeParameter = {
193
222
  }
194
223
  }
195
224
 
225
+ /** Badge (🧪) for stories with unit tests. */
196
226
  export const unitBadge: TagBadgeParameter = {
197
227
  tags: 'unit',
198
228
  badge: {
@@ -208,6 +238,7 @@ export const unitBadge: TagBadgeParameter = {
208
238
  }
209
239
  }
210
240
 
241
+ /** Badge (🔗) for stories with integration tests. Hidden in sidebar. */
211
242
  export const integrationBadge: TagBadgeParameter = {
212
243
  tags: 'integration',
213
244
  badge: {
@@ -223,6 +254,7 @@ export const integrationBadge: TagBadgeParameter = {
223
254
  }
224
255
  }
225
256
 
257
+ /** Badge (⌨️) for stories that demonstrate or test keyboard interaction. */
226
258
  export const keyboardBadge: TagBadgeParameter = {
227
259
  tags: 'keyboard',
228
260
  badge: {
@@ -235,6 +267,7 @@ export const keyboardBadge: TagBadgeParameter = {
235
267
  }
236
268
  }
237
269
 
270
+ /** Badge (🔒) for internal or private-use-only stories. */
238
271
  export const internalBadge: TagBadgeParameter = {
239
272
  tags: 'internal',
240
273
  badge: {
@@ -247,9 +280,11 @@ export const internalBadge: TagBadgeParameter = {
247
280
  }
248
281
  }
249
282
 
283
+ /** Ordered list of all tag badge configs used by the addon (includes version badge). */
250
284
  export const tagBadges: TagBadgeParameters = [
251
285
  editorBadge,
252
286
  sourceBadge,
287
+ typeBadge,
253
288
  unitBadge,
254
289
  integrationBadge,
255
290
  keyboardBadge,