GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-03 05:04:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

Addon-docs: Remove leading pipe if using raw value for Flow union

Browse Source
This commit is contained in:
Blaine Bublitz 2020-09-22 19:47:39 -07:00
parent cdf3ed5090
commit 97602f0c3b
2 changed files with 28 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
addons/docs/src/lib/docgen/flow/createPropDef.test.ts
View File

@ -317,6 +317,32 @@ describe('type', () => {
expect(type.summary).toBe('"minimum" | "maximum" | UserSize');
});
it('removes a leading | if raw union value is used', () => {
const docgenInfo = createDocgenInfo({
flowType: {
name: 'union',
raw: '| "minimum" | "maximum" | UserSize',
},
});
const { type } = createFlowPropDef(PROP_NAME, docgenInfo);
expect(type.summary).toBe('"minimum" | "maximum" | UserSize');
});
it('even removes extra spaces after a leading | if raw union value is used', () => {
const docgenInfo = createDocgenInfo({
flowType: {
name: 'union',
raw: '| "minimum" | "maximum" | UserSize',
},
});
const { type } = createFlowPropDef(PROP_NAME, docgenInfo);
expect(type.summary).toBe('"minimum" | "maximum" | UserSize');
});
it('should support intersection', () => {
const docgenInfo = createDocgenInfo({
flowType: {

3
addons/docs/src/lib/docgen/flow/createType.ts
View File

@ -40,7 +40,8 @@ function generateUnion({ name, raw, elements }: DocgenFlowUnionType): PropType {
}
if (raw != null) {
return createSummaryValue(raw);
// Flow Unions can be defined with or without a leading `|` character, so try to remove it.
return createSummaryValue(raw.replace(/^\|\s*/, ''));
}
return createSummaryValue(name);