-
-
Notifications
You must be signed in to change notification settings - Fork 9.1k
/
CsfFile.test.ts
590 lines (560 loc) · 13.7 KB
/
CsfFile.test.ts
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
/* eslint-disable no-underscore-dangle */
import dedent from 'ts-dedent';
import yaml from 'js-yaml';
import { loadCsf } from './CsfFile';
// @ts-ignore
expect.addSnapshotSerializer({
print: (val: any) => yaml.dump(val).trimEnd(),
test: (val) => typeof val !== 'string',
});
const parse = (code: string, includeParameters?: boolean) => {
const { stories, meta } = loadCsf(code, { defaultTitle: 'Default Title' }).parse();
const filtered = includeParameters
? stories
: stories.map(({ id, name, parameters, ...rest }) => ({ id, name, ...rest }));
return { meta, stories: filtered };
};
describe('CsfFile', () => {
describe('basic', () => {
it('args stories', () => {
expect(
parse(
dedent`
export default { title: 'foo/bar' };
export const A = () => {};
export const B = (args) => {};
`,
true
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
stories:
- id: foo-bar--a
name: A
parameters:
__isArgsStory: false
__id: foo-bar--a
- id: foo-bar--b
name: B
parameters:
__isArgsStory: true
__id: foo-bar--b
`);
});
it('exported const stories', () => {
expect(
parse(
dedent`
export default { title: 'foo/bar' };
const A = () => {};
const B = (args) => {};
export { A, B };
`,
true
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
stories:
- id: foo-bar--a
name: A
parameters:
__id: foo-bar--a
- id: foo-bar--b
name: B
parameters:
__id: foo-bar--b
`);
});
it('underscores', () => {
expect(
parse(
dedent`
export default { title: 'foo/bar' };
export const __Basic__ = () => {};
`,
true
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
stories:
- id: foo-bar--basic
name: Basic
parameters:
__isArgsStory: false
__id: foo-bar--basic
`);
});
it('exclude stories', () => {
expect(
parse(
dedent`
export default { title: 'foo/bar', excludeStories: ['B', 'C'] };
export const A = () => {};
export const B = (args) => {};
export const C = () => {};
`
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
excludeStories:
- B
- C
stories:
- id: foo-bar--a
name: A
`);
});
it('include stories', () => {
expect(
parse(
dedent`
export default { title: 'foo/bar', includeStories: /^Include.*/ };
export const SomeHelper = () => {};
export const IncludeA = () => {};
`
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
includeStories: !<tag:yaml.org,2002:js/regexp> /^Include.*/
stories:
- id: foo-bar--include-a
name: Include A
`);
});
it('storyName annotation', () => {
expect(
parse(
dedent`
export default { title: 'foo/bar' };
export const A = () => {};
A.storyName = 'Some story';
`
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
stories:
- id: foo-bar--a
name: Some story
`);
});
it('no title', () => {
expect(
parse(
dedent`
export default { component: 'foo' }
export const A = () => {};
export const B = () => {};
`
)
).toMatchInlineSnapshot(`
meta:
component: '''foo'''
title: Default Title
stories:
- id: default-title--a
name: A
- id: default-title--b
name: B
`);
});
it('custom component id', () => {
expect(
parse(
dedent`
export default { title: 'foo/bar', id: 'custom-id' };
export const A = () => {};
export const B = () => {};
`
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
id: custom-id
stories:
- id: custom-id--a
name: A
- id: custom-id--b
name: B
`);
});
it('typescript', () => {
expect(
parse(
dedent`
import { Meta, Story } from '@storybook/react';
type PropTypes = {};
export default { title: 'foo/bar/baz' } as Meta<PropTypes>;
export const A: Story<PropTypes> = () => <>A</>;
export const B: Story<PropTypes> = () => <>B</>;
`
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar/baz
stories:
- id: foo-bar-baz--a
name: A
- id: foo-bar-baz--b
name: B
`);
});
it('component object', () => {
expect(
parse(
dedent`
export default { component: {} }
export const A = () => {};
export const B = () => {};
`
)
).toMatchInlineSnapshot(`
meta:
component: '{}'
title: Default Title
stories:
- id: default-title--a
name: A
- id: default-title--b
name: B
`);
});
it('template bind', () => {
expect(
parse(
dedent`
export default { title: 'foo/bar' };
const Template = (args) => { };
export const A = Template.bind({});
A.args = { x: 1 };
`,
true
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
stories:
- id: foo-bar--a
name: A
parameters:
__isArgsStory: true
__id: foo-bar--a
`);
});
it('meta variable', () => {
expect(
parse(
dedent`
const meta = { title: 'foo/bar' };
export default meta;
export const A = () => {}
`,
true
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
stories:
- id: foo-bar--a
name: A
parameters:
__isArgsStory: false
__id: foo-bar--a
`);
});
it('docs-only story', () => {
expect(
parse(
dedent`
export default { title: 'foo/bar' };
export const __page = () => {};
__page.parameters = { docsOnly: true };
`,
true
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
stories:
- id: foo-bar--page
name: Page
parameters:
__isArgsStory: false
__id: foo-bar--page
docsOnly: true
`);
});
it('title variable', () => {
expect(
parse(
dedent`
const title = 'foo/bar';
export default { title };
export const A = () => {};
export const B = (args) => {};
`,
true
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
stories:
- id: foo-bar--a
name: A
parameters:
__isArgsStory: false
__id: foo-bar--a
- id: foo-bar--b
name: B
parameters:
__isArgsStory: true
__id: foo-bar--b
`);
});
it('re-exported stories', () => {
expect(
parse(
dedent`
export default { title: 'foo/bar' };
export { default as A } from './A';
export { B } from './B';
`
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
stories:
- id: foo-bar--a
name: A
- id: foo-bar--b
name: B
`);
});
it('named exports order', () => {
expect(
parse(
dedent`
export default { title: 'foo/bar' };
export const A = () => {};
export const B = (args) => {};
export const __namedExportsOrder = ['B', 'A'];
`,
true
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
stories:
- id: foo-bar--b
name: B
parameters:
__isArgsStory: true
__id: foo-bar--b
- id: foo-bar--a
name: A
parameters:
__isArgsStory: false
__id: foo-bar--a
`);
});
});
describe('error handling', () => {
it('no meta', () => {
expect(() =>
parse(
dedent`
export const A = () => {};
export const B = () => {};
`
)
).toThrow('CSF: missing default export');
});
it('no metadata', () => {
expect(() =>
parse(
dedent`
export default { foo: '5' };
export const A = () => {};
export const B = () => {};
`
)
).toThrow('CSF: missing title/component');
});
it('dynamic titles', () => {
expect(() =>
parse(
dedent`
export default { title: 'foo' + 'bar' };
export const A = () => {};
`,
true
)
).toThrow('CSF: unexpected dynamic title');
});
it('storiesOf calls', () => {
expect(() =>
parse(
dedent`
import { storiesOf } from '@storybook/react';
export default { title: 'foo/bar' };
export const A = () => {};
storiesOf('foo').add('bar', () => <baz />);
`,
true
)
).toThrow('CSF: unexpected storiesOf call');
});
it('function exports', () => {
expect(
parse(
dedent`
export default { title: 'foo/bar' };
export function A() {}
export function B() {}
`
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
stories:
- id: foo-bar--a
name: A
- id: foo-bar--b
name: B
`);
});
});
// NOTE: this does not have a public API, but we can still test it
describe('indexed annotations', () => {
it('meta annotations', () => {
const input = dedent`
export default { title: 'foo/bar', x: 1, y: 2 };
`;
const csf = loadCsf(input, { defaultTitle: 'Default Title' }).parse();
expect(Object.keys(csf._metaAnnotations)).toEqual(['title', 'x', 'y']);
});
it('story annotations', () => {
const input = dedent`
export default { title: 'foo/bar' };
export const A = () => {};
A.x = 1;
A.y = 2;
export const B = () => {};
B.z = 3;
`;
const csf = loadCsf(input, { defaultTitle: 'Default Title' }).parse();
expect(Object.keys(csf._storyAnnotations.A)).toEqual(['x', 'y']);
expect(Object.keys(csf._storyAnnotations.B)).toEqual(['z']);
});
it('v1-style story annotations', () => {
const input = dedent`
export default { title: 'foo/bar' };
export const A = () => {};
A.story = {
x: 1,
y: 2,
}
export const B = () => {};
B.story = {
z: 3,
}
`;
const csf = loadCsf(input, { defaultTitle: 'Default Title' }).parse();
expect(Object.keys(csf._storyAnnotations.A)).toEqual(['x', 'y']);
expect(Object.keys(csf._storyAnnotations.B)).toEqual(['z']);
});
});
describe('CSF3', () => {
it('Object export with no-args render', () => {
expect(
parse(
dedent`
export default { title: 'foo/bar' };
export const A = {
render: () => {}
}
`,
true
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
stories:
- id: foo-bar--a
name: A
parameters:
__isArgsStory: false
__id: foo-bar--a
`);
});
it('Object export with args render', () => {
expect(
parse(
dedent`
export default { title: 'foo/bar' };
export const A = {
render: (args) => {}
}
`,
true
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
stories:
- id: foo-bar--a
name: A
parameters:
__isArgsStory: true
__id: foo-bar--a
`);
});
it('Object export with default render', () => {
expect(
parse(
dedent`
export default { title: 'foo/bar' };
export const A = {}
`,
true
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
stories:
- id: foo-bar--a
name: A
parameters:
__isArgsStory: true
__id: foo-bar--a
`);
});
it('Object export with name', () => {
expect(
parse(
dedent`
export default { title: 'foo/bar' };
export const A = {
name: 'Apple'
}
`,
true
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
stories:
- id: foo-bar--a
name: Apple
parameters:
__isArgsStory: true
__id: foo-bar--a
`);
});
});
});