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

Addon-docs: Error on non-string description (#7650)

Browse Source 
Addon-docs: Error on non-string description
This commit is contained in:
Michael Shilman 2019-08-01 17:20:11 +08:00 committed by GitHub
commit bf876cecd1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
addons/docs/src/blocks/Description.tsx
View File

@ -20,13 +20,23 @@ interface DescriptionProps {
markdown?: string;
}
const getNotes = (notes?: Notes) =>
(notes && (typeof notes === 'string' ? notes : notes.markdown || notes.text)) || '';
const str = (o: any) => {
if (!o) {
return '';
}
if (typeof o === 'string') {
return o as string;
}
throw new Error(`Description: expected string, got: ${JSON.stringify(o)}`);
};
const getInfo = (info?: Info) => (info && (typeof info === 'string' ? info : info.text)) || '';
const getNotes = (notes?: Notes) =>
notes && (typeof notes === 'string' ? notes : str(notes.markdown) || str(notes.text));
const getInfo = (info?: Info) => info && (typeof info === 'string' ? info : str(info.text));
const getDocgen = (component?: Component) =>
(component && component.__docgenInfo && component.__docgenInfo.description) || '';
component && component.__docgenInfo && str(component.__docgenInfo.description);
export const getDescriptionProps = (
{ of, type, markdown }: DescriptionProps,
@ -50,7 +60,7 @@ export const getDescriptionProps = (
markdown: `
${getNotes(notes) || getInfo(info) || ''}
${getDocgen(target)}
${getDocgen(target) || ''}
`.trim(),
};
}