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

Update snapshots on testfixtures

Browse Source 
(and got tests working)
This commit is contained in:
Tom Coleman 2021-02-19 15:27:05 +11:00
parent 7077801f84
commit f4dc3da08f
14 changed files with 2563 additions and 274 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
addons/docs/src/frameworks/react/__testfixtures__/imported.js
View File

@ -1 +1 @@
export const imported = 'imported-value';
module.exports = { imported: 'imported-value' };

246
addons/docs/src/frameworks/react/__testfixtures__/js-class-component/docgen.snapshot
View File

@ -1,45 +1,243 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`react component properties js-class-component 1`] = `
"/* eslint-disable react/prefer-stateless-function */
import React from 'react';
"import React from 'react';
import PropTypes from 'prop-types';
import { imported } from '../imported';
const local = 'local-value';
/**
* Component description
* A component that renders its props
*/
// eslint-disable-next-line react/prefer-stateless-function
class ErrorBox extends React.Component {
class PropsWriter extends React.Component {
render() {
const {
children
} = this.props;
return /*#__PURE__*/React.createElement(\\"div\\", {
className: \\"error-box\\"
}, children);
return /*#__PURE__*/React.createElement(\\"pre\\", null, JSON.stringify(this.props));
}
}
ErrorBox.propTypes = {
/**
* PropTypes description
*/
children: PropTypes.node.isRequired
PropsWriter.propTypes = {
numberRequired: PropTypes.number.isRequired,
numberOptional: PropTypes.number,
stringRequired: PropTypes.string.isRequired,
stringOptional: PropTypes.string,
booleanRequired: PropTypes.bool.isRequired,
booleanOptional: PropTypes.bool,
arrayRequired: PropTypes.arrayOf(PropTypes.string.isRequired).isRequired,
arrayOptional: PropTypes.arrayOf(PropTypes.string.isRequired),
objectRequired: PropTypes.shape({}).isRequired,
objectOptional: PropTypes.shape({}),
functionRequired: PropTypes.func.isRequired,
functionOptional: PropTypes.func,
dateRequired: PropTypes.instanceOf(Date).isRequired,
dateOptional: PropTypes.instanceOf(Date),
localReference: PropTypes.string,
importedReference: PropTypes.string,
globalReference: PropTypes.any,
stringGlobalName: PropTypes.string
};
ErrorBox.__docgenInfo = {
\\"description\\": \\"Component description\\",
PropsWriter.defaultProps = {
numberOptional: 1,
stringOptional: 'stringOptional',
booleanOptional: false,
arrayOptional: ['array', 'optional'],
objectOptional: {
object: 'optional'
},
functionOptional: () => 'foo',
dateOptional: new Date(),
localReference: local,
importedReference: imported,
globalReference: Date,
stringGlobalName: 'top'
};
export const component = PropsWriter;
PropsWriter.__docgenInfo = {
\\"description\\": \\"A component that renders its props\\",
\\"methods\\": [],
\\"displayName\\": \\"ErrorBox\\",
\\"displayName\\": \\"PropsWriter\\",
\\"props\\": {
\\"children\\": {
\\"numberOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"1\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"node\\"
\\"name\\": \\"number\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"stringOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"'stringOptional'\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"string\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"booleanOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"false\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"bool\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"arrayOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"['array', 'optional']\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"arrayOf\\",
\\"value\\": {
\\"name\\": \\"string\\"
}
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"objectOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"{ object: 'optional' }\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"shape\\",
\\"value\\": {}
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"functionOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"() => 'foo'\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"func\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"dateOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"new Date()\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"instanceOf\\",
\\"value\\": \\"Date\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"localReference\\": {
\\"defaultValue\\": {
\\"value\\": \\"'local-value'\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"string\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"importedReference\\": {
\\"defaultValue\\": {
\\"value\\": \\"imported\\",
\\"computed\\": true
},
\\"type\\": {
\\"name\\": \\"string\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"globalReference\\": {
\\"defaultValue\\": {
\\"value\\": \\"Date\\",
\\"computed\\": true
},
\\"type\\": {
\\"name\\": \\"any\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"stringGlobalName\\": {
\\"defaultValue\\": {
\\"value\\": \\"'top'\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"string\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"numberRequired\\": {
\\"type\\": {
\\"name\\": \\"number\\"
},
\\"required\\": true,
\\"description\\": \\"PropTypes description\\"
\\"description\\": \\"\\"
},
\\"stringRequired\\": {
\\"type\\": {
\\"name\\": \\"string\\"
},
\\"required\\": true,
\\"description\\": \\"\\"
},
\\"booleanRequired\\": {
\\"type\\": {
\\"name\\": \\"bool\\"
},
\\"required\\": true,
\\"description\\": \\"\\"
},
\\"arrayRequired\\": {
\\"type\\": {
\\"name\\": \\"arrayOf\\",
\\"value\\": {
\\"name\\": \\"string\\"
}
},
\\"required\\": true,
\\"description\\": \\"\\"
},
\\"objectRequired\\": {
\\"type\\": {
\\"name\\": \\"shape\\",
\\"value\\": {}
},
\\"required\\": true,
\\"description\\": \\"\\"
},
\\"functionRequired\\": {
\\"type\\": {
\\"name\\": \\"func\\"
},
\\"required\\": true,
\\"description\\": \\"\\"
},
\\"dateRequired\\": {
\\"type\\": {
\\"name\\": \\"instanceOf\\",
\\"value\\": \\"Date\\"
},
\\"required\\": true,
\\"description\\": \\"\\"
}
}
};
export default ErrorBox;
export const component = ErrorBox;"
};"
`;

274
addons/docs/src/frameworks/react/__testfixtures__/js-class-component/properties.snapshot
View File

@ -5,16 +5,280 @@ Object {
"rows": Array [
Object {
"defaultValue": null,
"description": "PropTypes description",
"name": "children",
"description": "",
"name": "numberRequired",
"required": true,
"sbType": Object {
"name": "other",
"value": "node",
"name": "number",
},
"type": Object {
"detail": undefined,
"summary": "node",
"summary": "number",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "1",
},
"description": "",
"name": "numberOptional",
"required": false,
"sbType": Object {
"name": "number",
},
"type": Object {
"detail": undefined,
"summary": "number",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "stringRequired",
"required": true,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "'stringOptional'",
},
"description": "",
"name": "stringOptional",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "booleanRequired",
"required": true,
"sbType": Object {
"name": "boolean",
},
"type": Object {
"detail": undefined,
"summary": "bool",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "false",
},
"description": "",
"name": "booleanOptional",
"required": false,
"sbType": Object {
"name": "boolean",
},
"type": Object {
"detail": undefined,
"summary": "bool",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "arrayRequired",
"required": true,
"sbType": Object {
"name": "array",
"value": Object {
"name": "string",
},
},
"type": Object {
"detail": undefined,
"summary": "string[]",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "['array', 'optional']",
},
"description": "",
"name": "arrayOptional",
"required": false,
"sbType": Object {
"name": "array",
"value": Object {
"name": "string",
},
},
"type": Object {
"detail": undefined,
"summary": "string[]",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "objectRequired",
"required": true,
"sbType": Object {
"name": "object",
"value": Object {},
},
"type": Object {
"detail": undefined,
"summary": "{ }",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "{ object: 'optional' }",
},
"description": "",
"name": "objectOptional",
"required": false,
"sbType": Object {
"name": "object",
"value": Object {},
},
"type": Object {
"detail": undefined,
"summary": "{ }",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "functionRequired",
"required": true,
"sbType": Object {
"name": "function",
},
"type": Object {
"detail": undefined,
"summary": "func",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "() => 'foo'",
},
"description": "",
"name": "functionOptional",
"required": false,
"sbType": Object {
"name": "function",
},
"type": Object {
"detail": undefined,
"summary": "func",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "dateRequired",
"required": true,
"sbType": Object {
"name": "other",
"value": "instanceOf(Date)",
},
"type": Object {
"detail": undefined,
"summary": "Date",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "new Date()",
},
"description": "",
"name": "dateOptional",
"required": false,
"sbType": Object {
"name": "other",
"value": "instanceOf(Date)",
},
"type": Object {
"detail": undefined,
"summary": "Date",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "'local-value'",
},
"description": "",
"name": "localReference",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "imported",
},
"description": "",
"name": "importedReference",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "Date",
},
"description": "",
"name": "globalReference",
"required": false,
"sbType": Object {
"name": "other",
"value": "any",
},
"type": Object {
"detail": undefined,
"summary": "any",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "'top'",
},
"description": "",
"name": "stringGlobalName",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
],

148
addons/docs/src/frameworks/react/__testfixtures__/js-function-component-inline-defaults-no-propTypes/docgen.snapshot
View File

@ -1,63 +1,123 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`react component properties ts-function-component 1`] = `
"import React from 'react';
exports[`react component properties js-function-component-inline-defaults-no-propTypes 1`] = `
"/* eslint-disable react/prop-types */
import React from 'react';
import { imported } from '../imported';
const local = 'local-value';
/**
* The world's most _basic_ button
* A component that renders its props
*/
export const Button = ({
onClick
}) => /*#__PURE__*/React.createElement(\\"button\\", {
onClick: onClick,
type: \\"button\\"
}, \\"hello\\");
Button.defaultProps = {
primary: true,
secondary: false
};
export const component = Button;
Button.__docgenInfo = {
\\"description\\": \\"The world's most _basic_ button\\",
export const PropsWriter = ({
numberOptional = 1,
stringOptional = 'stringOptional',
booleanOptional = false,
arrayOptional = ['array', 'optional'],
objectOptional = {
object: 'optional'
},
functionOptional = () => 'foo',
dateOptional = new Date(),
localReference = local,
importedReference = imported,
globalReference = Date,
stringGlobalName = 'top'
}) => /*#__PURE__*/React.createElement(\\"pre\\", null, JSON.stringify({
numberOptional,
stringOptional,
booleanOptional,
arrayOptional,
objectOptional,
functionOptional,
dateOptional,
localReference,
importedReference,
globalReference,
stringGlobalName
}));
export const component = PropsWriter;
PropsWriter.__docgenInfo = {
\\"description\\": \\"A component that renders its props\\",
\\"methods\\": [],
\\"displayName\\": \\"Button\\",
\\"displayName\\": \\"PropsWriter\\",
\\"props\\": {
\\"primary\\": {
\\"numberOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"true\\",
\\"value\\": \\"1\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"boolean\\"
},
\\"description\\": \\"Is primary?\\"
\\"required\\": false
},
\\"secondary\\": {
\\"stringOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"'stringOptional'\\",
\\"computed\\": false
},
\\"required\\": false
},
\\"booleanOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"false\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"boolean\\"
},
\\"description\\": \\"default is false\\"
\\"required\\": false
},
\\"onClick\\": {
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"signature\\",
\\"type\\": \\"function\\",
\\"raw\\": \\"() => void\\",
\\"signature\\": {
\\"arguments\\": [],
\\"return\\": {
\\"name\\": \\"void\\"
}
}
\\"arrayOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"['array', 'optional']\\",
\\"computed\\": false
},
\\"description\\": \\"Simple click handler\\"
\\"required\\": false
},
\\"objectOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"{ object: 'optional' }\\",
\\"computed\\": false
},
\\"required\\": false
},
\\"functionOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"() => 'foo'\\",
\\"computed\\": false
},
\\"required\\": false
},
\\"dateOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"new Date()\\",
\\"computed\\": false
},
\\"required\\": false
},
\\"localReference\\": {
\\"defaultValue\\": {
\\"value\\": \\"'local-value'\\",
\\"computed\\": false
},
\\"required\\": false
},
\\"importedReference\\": {
\\"defaultValue\\": {
\\"value\\": \\"imported\\",
\\"computed\\": true
},
\\"required\\": false
},
\\"globalReference\\": {
\\"defaultValue\\": {
\\"value\\": \\"Date\\",
\\"computed\\": true
},
\\"required\\": false
},
\\"stringGlobalName\\": {
\\"defaultValue\\": {
\\"value\\": \\"'top'\\",
\\"computed\\": false
},
\\"required\\": false
}
}
};"

141
addons/docs/src/frameworks/react/__testfixtures__/js-function-component-inline-defaults-no-propTypes/properties.snapshot
View File

@ -1,22 +1,32 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`react component properties ts-function-component 1`] = `
exports[`react component properties js-function-component-inline-defaults-no-propTypes 1`] = `
Object {
"rows": Array [
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "true",
"summary": "1",
},
"description": "Is primary?",
"name": "primary",
"description": undefined,
"name": "numberOptional",
"required": false,
"sbType": Object {
"name": "boolean",
},
"type": Object {
"detail": undefined,
"summary": "boolean",
"summary": "unknown",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "'stringOptional'",
},
"description": undefined,
"name": "stringOptional",
"required": false,
"type": Object {
"detail": undefined,
"summary": "unknown",
},
},
Object {
@ -24,29 +34,116 @@ Object {
"detail": undefined,
"summary": "false",
},
"description": "default is false",
"name": "secondary",
"description": undefined,
"name": "booleanOptional",
"required": false,
"sbType": Object {
"name": "boolean",
},
"type": Object {
"detail": undefined,
"summary": "boolean",
"summary": "unknown",
},
},
Object {
"defaultValue": null,
"description": "Simple click handler",
"name": "onClick",
"required": false,
"sbType": Object {
"name": "function",
"raw": "() => void",
"defaultValue": Object {
"detail": undefined,
"summary": "['array', 'optional']",
},
"description": undefined,
"name": "arrayOptional",
"required": false,
"type": Object {
"detail": undefined,
"summary": "signature",
"summary": "unknown",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "{ object: 'optional' }",
},
"description": undefined,
"name": "objectOptional",
"required": false,
"type": Object {
"detail": undefined,
"summary": "unknown",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "() => 'foo'",
},
"description": undefined,
"name": "functionOptional",
"required": false,
"type": Object {
"detail": undefined,
"summary": "unknown",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "new Date()",
},
"description": undefined,
"name": "dateOptional",
"required": false,
"type": Object {
"detail": undefined,
"summary": "unknown",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "'local-value'",
},
"description": undefined,
"name": "localReference",
"required": false,
"type": Object {
"detail": undefined,
"summary": "unknown",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "imported",
},
"description": undefined,
"name": "importedReference",
"required": false,
"type": Object {
"detail": undefined,
"summary": "unknown",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "Date",
},
"description": undefined,
"name": "globalReference",
"required": false,
"type": Object {
"detail": undefined,
"summary": "unknown",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "'top'",
},
"description": undefined,
"name": "stringGlobalName",
"required": false,
"type": Object {
"detail": undefined,
"summary": "unknown",
},
},
],

261
addons/docs/src/frameworks/react/__testfixtures__/js-function-component-inline-defaults/docgen.snapshot
View File

@ -1,63 +1,246 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`react component properties ts-function-component 1`] = `
exports[`react component properties js-function-component-inline-defaults 1`] = `
"import React from 'react';
import PropTypes from 'prop-types';
import { imported } from '../imported';
const local = 'local-value';
/**
* The world's most _basic_ button
* A component that renders its props
*/
export const Button = ({
onClick
}) => /*#__PURE__*/React.createElement(\\"button\\", {
onClick: onClick,
type: \\"button\\"
}, \\"hello\\");
Button.defaultProps = {
primary: true,
secondary: false
export const PropsWriter = ({
numberOptional = 1,
stringOptional = 'stringOptional',
booleanOptional = false,
arrayOptional = ['array', 'optional'],
objectOptional = {
object: 'optional'
},
functionOptional = () => 'foo',
dateOptional = new Date(),
localReference = local,
importedReference = imported,
globalReference = Date,
stringGlobalName = 'top'
}) => /*#__PURE__*/React.createElement(\\"pre\\", null, JSON.stringify({
numberOptional,
stringOptional,
booleanOptional,
arrayOptional,
objectOptional,
functionOptional,
dateOptional,
localReference,
importedReference,
globalReference,
stringGlobalName
}));
PropsWriter.propTypes = {
numberRequired: PropTypes.number.isRequired,
numberOptional: PropTypes.number,
stringRequired: PropTypes.string.isRequired,
stringOptional: PropTypes.string,
booleanRequired: PropTypes.bool.isRequired,
booleanOptional: PropTypes.bool,
arrayRequired: PropTypes.arrayOf(PropTypes.string.isRequired).isRequired,
arrayOptional: PropTypes.arrayOf(PropTypes.string.isRequired),
objectRequired: PropTypes.shape({}).isRequired,
objectOptional: PropTypes.shape({}),
functionRequired: PropTypes.func.isRequired,
functionOptional: PropTypes.func,
dateRequired: PropTypes.instanceOf(Date).isRequired,
dateOptional: PropTypes.instanceOf(Date),
localReference: PropTypes.string,
importedReference: PropTypes.string,
globalReference: PropTypes.any,
stringGlobalName: PropTypes.string
};
export const component = Button;
Button.__docgenInfo = {
\\"description\\": \\"The world's most _basic_ button\\",
export const component = PropsWriter;
PropsWriter.__docgenInfo = {
\\"description\\": \\"A component that renders its props\\",
\\"methods\\": [],
\\"displayName\\": \\"Button\\",
\\"displayName\\": \\"PropsWriter\\",
\\"props\\": {
\\"primary\\": {
\\"numberOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"true\\",
\\"value\\": \\"1\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"boolean\\"
\\"type\\": {
\\"name\\": \\"number\\"
},
\\"description\\": \\"Is primary?\\"
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"secondary\\": {
\\"stringOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"'stringOptional'\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"string\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"booleanOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"false\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"boolean\\"
\\"type\\": {
\\"name\\": \\"bool\\"
},
\\"description\\": \\"default is false\\"
},
\\"onClick\\": {
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"signature\\",
\\"type\\": \\"function\\",
\\"raw\\": \\"() => void\\",
\\"signature\\": {
\\"arguments\\": [],
\\"return\\": {
\\"name\\": \\"void\\"
}
\\"description\\": \\"\\"
},
\\"arrayOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"['array', 'optional']\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"arrayOf\\",
\\"value\\": {
\\"name\\": \\"string\\"
}
},
\\"description\\": \\"Simple click handler\\"
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"objectOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"{ object: 'optional' }\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"shape\\",
\\"value\\": {}
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"functionOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"() => 'foo'\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"func\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"dateOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"new Date()\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"instanceOf\\",
\\"value\\": \\"Date\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"localReference\\": {
\\"defaultValue\\": {
\\"value\\": \\"'local-value'\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"string\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"importedReference\\": {
\\"defaultValue\\": {
\\"value\\": \\"imported\\",
\\"computed\\": true
},
\\"type\\": {
\\"name\\": \\"string\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"globalReference\\": {
\\"defaultValue\\": {
\\"value\\": \\"Date\\",
\\"computed\\": true
},
\\"type\\": {
\\"name\\": \\"any\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"stringGlobalName\\": {
\\"defaultValue\\": {
\\"value\\": \\"'top'\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"string\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"numberRequired\\": {
\\"type\\": {
\\"name\\": \\"number\\"
},
\\"required\\": true,
\\"description\\": \\"\\"
},
\\"stringRequired\\": {
\\"type\\": {
\\"name\\": \\"string\\"
},
\\"required\\": true,
\\"description\\": \\"\\"
},
\\"booleanRequired\\": {
\\"type\\": {
\\"name\\": \\"bool\\"
},
\\"required\\": true,
\\"description\\": \\"\\"
},
\\"arrayRequired\\": {
\\"type\\": {
\\"name\\": \\"arrayOf\\",
\\"value\\": {
\\"name\\": \\"string\\"
}
},
\\"required\\": true,
\\"description\\": \\"\\"
},
\\"objectRequired\\": {
\\"type\\": {
\\"name\\": \\"shape\\",
\\"value\\": {}
},
\\"required\\": true,
\\"description\\": \\"\\"
},
\\"functionRequired\\": {
\\"type\\": {
\\"name\\": \\"func\\"
},
\\"required\\": true,
\\"description\\": \\"\\"
},
\\"dateRequired\\": {
\\"type\\": {
\\"name\\": \\"instanceOf\\",
\\"value\\": \\"Date\\"
},
\\"required\\": true,
\\"description\\": \\"\\"
}
}
};"

260
addons/docs/src/frameworks/react/__testfixtures__/js-function-component-inline-defaults/properties.snapshot
View File

@ -1,22 +1,77 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`react component properties ts-function-component 1`] = `
exports[`react component properties js-function-component-inline-defaults 1`] = `
Object {
"rows": Array [
Object {
"defaultValue": null,
"description": "",
"name": "numberRequired",
"required": true,
"sbType": Object {
"name": "number",
},
"type": Object {
"detail": undefined,
"summary": "number",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "true",
"summary": "1",
},
"description": "Is primary?",
"name": "primary",
"description": "",
"name": "numberOptional",
"required": false,
"sbType": Object {
"name": "number",
},
"type": Object {
"detail": undefined,
"summary": "number",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "stringRequired",
"required": true,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "'stringOptional'",
},
"description": "",
"name": "stringOptional",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "booleanRequired",
"required": true,
"sbType": Object {
"name": "boolean",
},
"type": Object {
"detail": undefined,
"summary": "boolean",
"summary": "bool",
},
},
Object {
@ -24,29 +79,206 @@ Object {
"detail": undefined,
"summary": "false",
},
"description": "default is false",
"name": "secondary",
"description": "",
"name": "booleanOptional",
"required": false,
"sbType": Object {
"name": "boolean",
},
"type": Object {
"detail": undefined,
"summary": "boolean",
"summary": "bool",
},
},
Object {
"defaultValue": null,
"description": "Simple click handler",
"name": "onClick",
"required": false,
"description": "",
"name": "arrayRequired",
"required": true,
"sbType": Object {
"name": "function",
"raw": "() => void",
"name": "array",
"value": Object {
"name": "string",
},
},
"type": Object {
"detail": undefined,
"summary": "signature",
"summary": "string[]",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "['array', 'optional']",
},
"description": "",
"name": "arrayOptional",
"required": false,
"sbType": Object {
"name": "array",
"value": Object {
"name": "string",
},
},
"type": Object {
"detail": undefined,
"summary": "string[]",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "objectRequired",
"required": true,
"sbType": Object {
"name": "object",
"value": Object {},
},
"type": Object {
"detail": undefined,
"summary": "{ }",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "{ object: 'optional' }",
},
"description": "",
"name": "objectOptional",
"required": false,
"sbType": Object {
"name": "object",
"value": Object {},
},
"type": Object {
"detail": undefined,
"summary": "{ }",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "functionRequired",
"required": true,
"sbType": Object {
"name": "function",
},
"type": Object {
"detail": undefined,
"summary": "func",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "() => 'foo'",
},
"description": "",
"name": "functionOptional",
"required": false,
"sbType": Object {
"name": "function",
},
"type": Object {
"detail": undefined,
"summary": "func",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "dateRequired",
"required": true,
"sbType": Object {
"name": "other",
"value": "instanceOf(Date)",
},
"type": Object {
"detail": undefined,
"summary": "Date",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "new Date()",
},
"description": "",
"name": "dateOptional",
"required": false,
"sbType": Object {
"name": "other",
"value": "instanceOf(Date)",
},
"type": Object {
"detail": undefined,
"summary": "Date",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "'local-value'",
},
"description": "",
"name": "localReference",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "imported",
},
"description": "",
"name": "importedReference",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "Date",
},
"description": "",
"name": "globalReference",
"required": false,
"sbType": Object {
"name": "other",
"value": "any",
},
"type": Object {
"detail": undefined,
"summary": "any",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "'top'",
},
"description": "",
"name": "stringGlobalName",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
],

250
addons/docs/src/frameworks/react/__testfixtures__/js-function-component/docgen.snapshot
View File

@ -1,63 +1,235 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`react component properties ts-function-component 1`] = `
exports[`react component properties js-function-component 1`] = `
"import React from 'react';
import PropTypes from 'prop-types';
import { imported } from '../imported';
const local = 'local-value';
/**
* The world's most _basic_ button
* A component that renders its props
*/
export const Button = ({
onClick
}) => /*#__PURE__*/React.createElement(\\"button\\", {
onClick: onClick,
type: \\"button\\"
}, \\"hello\\");
Button.defaultProps = {
primary: true,
secondary: false
export const PropsWriter = props => /*#__PURE__*/React.createElement(\\"pre\\", null, JSON.stringify(props));
PropsWriter.propTypes = {
numberRequired: PropTypes.number.isRequired,
numberOptional: PropTypes.number,
stringRequired: PropTypes.string.isRequired,
stringOptional: PropTypes.string,
booleanRequired: PropTypes.bool.isRequired,
booleanOptional: PropTypes.bool,
arrayRequired: PropTypes.arrayOf(PropTypes.string.isRequired).isRequired,
arrayOptional: PropTypes.arrayOf(PropTypes.string.isRequired),
objectRequired: PropTypes.shape({}).isRequired,
objectOptional: PropTypes.shape({}),
functionRequired: PropTypes.func.isRequired,
functionOptional: PropTypes.func,
dateRequired: PropTypes.instanceOf(Date).isRequired,
dateOptional: PropTypes.instanceOf(Date),
localReference: PropTypes.string,
importedReference: PropTypes.string,
globalReference: PropTypes.any,
stringGlobalName: PropTypes.string
};
export const component = Button;
Button.__docgenInfo = {
\\"description\\": \\"The world's most _basic_ button\\",
PropsWriter.defaultProps = {
numberOptional: 1,
stringOptional: 'stringOptional',
booleanOptional: false,
arrayOptional: ['array', 'optional'],
objectOptional: {
object: 'optional'
},
functionOptional: () => 'foo',
dateOptional: new Date(),
localReference: local,
importedReference: imported,
globalReference: Date,
stringGlobalName: 'top'
};
export const component = PropsWriter;
PropsWriter.__docgenInfo = {
\\"description\\": \\"A component that renders its props\\",
\\"methods\\": [],
\\"displayName\\": \\"Button\\",
\\"displayName\\": \\"PropsWriter\\",
\\"props\\": {
\\"primary\\": {
\\"numberOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"true\\",
\\"value\\": \\"1\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"boolean\\"
\\"type\\": {
\\"name\\": \\"number\\"
},
\\"description\\": \\"Is primary?\\"
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"secondary\\": {
\\"stringOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"'stringOptional'\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"string\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"booleanOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"false\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"boolean\\"
\\"type\\": {
\\"name\\": \\"bool\\"
},
\\"description\\": \\"default is false\\"
},
\\"onClick\\": {
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"signature\\",
\\"type\\": \\"function\\",
\\"raw\\": \\"() => void\\",
\\"signature\\": {
\\"arguments\\": [],
\\"return\\": {
\\"name\\": \\"void\\"
}
\\"description\\": \\"\\"
},
\\"arrayOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"['array', 'optional']\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"arrayOf\\",
\\"value\\": {
\\"name\\": \\"string\\"
}
},
\\"description\\": \\"Simple click handler\\"
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"objectOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"{ object: 'optional' }\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"shape\\",
\\"value\\": {}
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"functionOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"() => 'foo'\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"func\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"dateOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"new Date()\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"instanceOf\\",
\\"value\\": \\"Date\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"localReference\\": {
\\"defaultValue\\": {
\\"value\\": \\"'local-value'\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"string\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"importedReference\\": {
\\"defaultValue\\": {
\\"value\\": \\"imported\\",
\\"computed\\": true
},
\\"type\\": {
\\"name\\": \\"string\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"globalReference\\": {
\\"defaultValue\\": {
\\"value\\": \\"Date\\",
\\"computed\\": true
},
\\"type\\": {
\\"name\\": \\"any\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"stringGlobalName\\": {
\\"defaultValue\\": {
\\"value\\": \\"'top'\\",
\\"computed\\": false
},
\\"type\\": {
\\"name\\": \\"string\\"
},
\\"required\\": false,
\\"description\\": \\"\\"
},
\\"numberRequired\\": {
\\"type\\": {
\\"name\\": \\"number\\"
},
\\"required\\": true,
\\"description\\": \\"\\"
},
\\"stringRequired\\": {
\\"type\\": {
\\"name\\": \\"string\\"
},
\\"required\\": true,
\\"description\\": \\"\\"
},
\\"booleanRequired\\": {
\\"type\\": {
\\"name\\": \\"bool\\"
},
\\"required\\": true,
\\"description\\": \\"\\"
},
\\"arrayRequired\\": {
\\"type\\": {
\\"name\\": \\"arrayOf\\",
\\"value\\": {
\\"name\\": \\"string\\"
}
},
\\"required\\": true,
\\"description\\": \\"\\"
},
\\"objectRequired\\": {
\\"type\\": {
\\"name\\": \\"shape\\",
\\"value\\": {}
},
\\"required\\": true,
\\"description\\": \\"\\"
},
\\"functionRequired\\": {
\\"type\\": {
\\"name\\": \\"func\\"
},
\\"required\\": true,
\\"description\\": \\"\\"
},
\\"dateRequired\\": {
\\"type\\": {
\\"name\\": \\"instanceOf\\",
\\"value\\": \\"Date\\"
},
\\"required\\": true,
\\"description\\": \\"\\"
}
}
};"

260
addons/docs/src/frameworks/react/__testfixtures__/js-function-component/properties.snapshot
View File

@ -1,22 +1,77 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`react component properties ts-function-component 1`] = `
exports[`react component properties js-function-component 1`] = `
Object {
"rows": Array [
Object {
"defaultValue": null,
"description": "",
"name": "numberRequired",
"required": true,
"sbType": Object {
"name": "number",
},
"type": Object {
"detail": undefined,
"summary": "number",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "true",
"summary": "1",
},
"description": "Is primary?",
"name": "primary",
"description": "",
"name": "numberOptional",
"required": false,
"sbType": Object {
"name": "number",
},
"type": Object {
"detail": undefined,
"summary": "number",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "stringRequired",
"required": true,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "'stringOptional'",
},
"description": "",
"name": "stringOptional",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "booleanRequired",
"required": true,
"sbType": Object {
"name": "boolean",
},
"type": Object {
"detail": undefined,
"summary": "boolean",
"summary": "bool",
},
},
Object {
@ -24,29 +79,206 @@ Object {
"detail": undefined,
"summary": "false",
},
"description": "default is false",
"name": "secondary",
"description": "",
"name": "booleanOptional",
"required": false,
"sbType": Object {
"name": "boolean",
},
"type": Object {
"detail": undefined,
"summary": "boolean",
"summary": "bool",
},
},
Object {
"defaultValue": null,
"description": "Simple click handler",
"name": "onClick",
"required": false,
"description": "",
"name": "arrayRequired",
"required": true,
"sbType": Object {
"name": "function",
"raw": "() => void",
"name": "array",
"value": Object {
"name": "string",
},
},
"type": Object {
"detail": undefined,
"summary": "signature",
"summary": "string[]",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "['array', 'optional']",
},
"description": "",
"name": "arrayOptional",
"required": false,
"sbType": Object {
"name": "array",
"value": Object {
"name": "string",
},
},
"type": Object {
"detail": undefined,
"summary": "string[]",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "objectRequired",
"required": true,
"sbType": Object {
"name": "object",
"value": Object {},
},
"type": Object {
"detail": undefined,
"summary": "{ }",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "{ object: 'optional' }",
},
"description": "",
"name": "objectOptional",
"required": false,
"sbType": Object {
"name": "object",
"value": Object {},
},
"type": Object {
"detail": undefined,
"summary": "{ }",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "functionRequired",
"required": true,
"sbType": Object {
"name": "function",
},
"type": Object {
"detail": undefined,
"summary": "func",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "() => 'foo'",
},
"description": "",
"name": "functionOptional",
"required": false,
"sbType": Object {
"name": "function",
},
"type": Object {
"detail": undefined,
"summary": "func",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "dateRequired",
"required": true,
"sbType": Object {
"name": "other",
"value": "instanceOf(Date)",
},
"type": Object {
"detail": undefined,
"summary": "Date",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "new Date()",
},
"description": "",
"name": "dateOptional",
"required": false,
"sbType": Object {
"name": "other",
"value": "instanceOf(Date)",
},
"type": Object {
"detail": undefined,
"summary": "Date",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "'local-value'",
},
"description": "",
"name": "localReference",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "imported",
},
"description": "",
"name": "importedReference",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "Date",
},
"description": "",
"name": "globalReference",
"required": false,
"sbType": Object {
"name": "other",
"value": "any",
},
"type": Object {
"detail": undefined,
"summary": "any",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "'top'",
},
"description": "",
"name": "stringGlobalName",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
],

240
addons/docs/src/frameworks/react/__testfixtures__/ts-function-component-inline-defaults/docgen.snapshot
View File

@ -1,39 +1,69 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`react component properties ts-function-component 1`] = `
exports[`react component properties ts-function-component-inline-defaults 1`] = `
"import React from 'react';
import { imported } from '../imported';
const local = 'local-value';
/**
* The world's most _basic_ button
* A component that renders its props
*/
export const Button = ({
onClick
}) => /*#__PURE__*/React.createElement(\\"button\\", {
onClick: onClick,
type: \\"button\\"
}, \\"hello\\");
Button.defaultProps = {
primary: true,
secondary: false
};
export const component = Button;
Button.__docgenInfo = {
\\"description\\": \\"The world's most _basic_ button\\",
export const PropsWriter = ({
numberOptional = 1,
stringOptional = 'stringOptional',
booleanOptional = false,
arrayOptional = ['array', 'optional'],
objectOptional = {
object: 'optional'
},
functionOptional = () => 'foo',
dateOptional = new Date(),
localReference = local,
importedReference = imported,
globalReference = Date,
stringGlobalName = 'top'
}) => /*#__PURE__*/React.createElement(\\"pre\\", null, JSON.stringify({
numberOptional,
stringOptional,
booleanOptional,
arrayOptional,
objectOptional,
functionOptional,
dateOptional,
localReference,
importedReference,
globalReference,
stringGlobalName
}));
export const component = PropsWriter;
PropsWriter.__docgenInfo = {
\\"description\\": \\"A component that renders its props\\",
\\"methods\\": [],
\\"displayName\\": \\"Button\\",
\\"displayName\\": \\"PropsWriter\\",
\\"props\\": {
\\"primary\\": {
\\"numberOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"true\\",
\\"value\\": \\"1\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"boolean\\"
\\"name\\": \\"number\\"
},
\\"description\\": \\"Is primary?\\"
\\"description\\": \\"\\"
},
\\"secondary\\": {
\\"stringOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"'stringOptional'\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"string\\"
},
\\"description\\": \\"\\"
},
\\"booleanOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"false\\",
\\"computed\\": false
@ -42,22 +72,180 @@ Button.__docgenInfo = {
\\"tsType\\": {
\\"name\\": \\"boolean\\"
},
\\"description\\": \\"default is false\\"
\\"description\\": \\"\\"
},
\\"onClick\\": {
\\"arrayOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"['array', 'optional']\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"Array\\",
\\"elements\\": [{
\\"name\\": \\"string\\"
}],
\\"raw\\": \\"string[]\\"
},
\\"description\\": \\"\\"
},
\\"objectOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"{ object: 'optional' }\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"Record\\",
\\"elements\\": [{
\\"name\\": \\"string\\"
}, {
\\"name\\": \\"string\\"
}],
\\"raw\\": \\"Record<string, string>\\"
},
\\"description\\": \\"\\"
},
\\"functionOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"() => 'foo'\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"signature\\",
\\"type\\": \\"function\\",
\\"raw\\": \\"() => void\\",
\\"raw\\": \\"() => string\\",
\\"signature\\": {
\\"arguments\\": [],
\\"return\\": {
\\"name\\": \\"void\\"
\\"name\\": \\"string\\"
}
}
},
\\"description\\": \\"Simple click handler\\"
\\"description\\": \\"\\"
},
\\"dateOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"new Date()\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"Date\\"
},
\\"description\\": \\"\\"
},
\\"localReference\\": {
\\"defaultValue\\": {
\\"value\\": \\"'local-value'\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"string\\"
},
\\"description\\": \\"\\"
},
\\"importedReference\\": {
\\"defaultValue\\": {
\\"value\\": \\"imported\\",
\\"computed\\": true
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"string\\"
},
\\"description\\": \\"\\"
},
\\"globalReference\\": {
\\"defaultValue\\": {
\\"value\\": \\"Date\\",
\\"computed\\": true
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"any\\"
},
\\"description\\": \\"\\"
},
\\"stringGlobalName\\": {
\\"defaultValue\\": {
\\"value\\": \\"'top'\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"string\\"
},
\\"description\\": \\"\\"
},
\\"numberRequired\\": {
\\"required\\": true,
\\"tsType\\": {
\\"name\\": \\"number\\"
},
\\"description\\": \\"Description\\"
},
\\"stringRequired\\": {
\\"required\\": true,
\\"tsType\\": {
\\"name\\": \\"string\\"
},
\\"description\\": \\"\\"
},
\\"booleanRequired\\": {
\\"required\\": true,
\\"tsType\\": {
\\"name\\": \\"boolean\\"
},
\\"description\\": \\"\\"
},
\\"arrayRequired\\": {
\\"required\\": true,
\\"tsType\\": {
\\"name\\": \\"Array\\",
\\"elements\\": [{
\\"name\\": \\"string\\"
}],
\\"raw\\": \\"string[]\\"
},
\\"description\\": \\"\\"
},
\\"objectRequired\\": {
\\"required\\": true,
\\"tsType\\": {
\\"name\\": \\"Record\\",
\\"elements\\": [{
\\"name\\": \\"string\\"
}, {
\\"name\\": \\"string\\"
}],
\\"raw\\": \\"Record<string, string>\\"
},
\\"description\\": \\"\\"
},
\\"functionRequired\\": {
\\"required\\": true,
\\"tsType\\": {
\\"name\\": \\"signature\\",
\\"type\\": \\"function\\",
\\"raw\\": \\"() => string\\",
\\"signature\\": {
\\"arguments\\": [],
\\"return\\": {
\\"name\\": \\"string\\"
}
}
},
\\"description\\": \\"\\"
},
\\"dateRequired\\": {
\\"required\\": true,
\\"tsType\\": {
\\"name\\": \\"Date\\"
},
\\"description\\": \\"\\"
}
}
};"

264
addons/docs/src/frameworks/react/__testfixtures__/ts-function-component-inline-defaults/properties.snapshot
View File

@ -1,15 +1,47 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`react component properties ts-function-component 1`] = `
exports[`react component properties ts-function-component-inline-defaults 1`] = `
Object {
"rows": Array [
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "true",
"summary": "1",
},
"description": "Is primary?",
"name": "primary",
"description": "",
"name": "numberOptional",
"required": false,
"sbType": Object {
"name": "number",
},
"type": Object {
"detail": undefined,
"summary": "number",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "'stringOptional'",
},
"description": "",
"name": "stringOptional",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "false",
},
"description": "",
"name": "booleanOptional",
"required": false,
"sbType": Object {
"name": "boolean",
@ -22,11 +54,173 @@ Object {
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "false",
"summary": "['array', 'optional']",
},
"description": "default is false",
"name": "secondary",
"description": "",
"name": "arrayOptional",
"required": false,
"sbType": Object {
"name": "array",
"raw": "string[]",
"value": Array [
Object {
"name": "string",
},
],
},
"type": Object {
"detail": undefined,
"summary": "Array",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "{ object: 'optional' }",
},
"description": "",
"name": "objectOptional",
"required": false,
"sbType": Object {
"name": "other",
"raw": "Record<string, string>",
"value": "Record",
},
"type": Object {
"detail": undefined,
"summary": "Record",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "() => 'foo'",
},
"description": "",
"name": "functionOptional",
"required": false,
"sbType": Object {
"name": "function",
"raw": "() => string",
},
"type": Object {
"detail": undefined,
"summary": "signature",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "new Date()",
},
"description": "",
"name": "dateOptional",
"required": false,
"sbType": Object {
"name": "other",
"value": "Date",
},
"type": Object {
"detail": undefined,
"summary": "Date",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "'local-value'",
},
"description": "",
"name": "localReference",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "imported",
},
"description": "",
"name": "importedReference",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "Date",
},
"description": "",
"name": "globalReference",
"required": false,
"sbType": Object {
"name": "other",
"value": "any",
},
"type": Object {
"detail": undefined,
"summary": "any",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "'top'",
},
"description": "",
"name": "stringGlobalName",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": null,
"description": "Description",
"name": "numberRequired",
"required": true,
"sbType": Object {
"name": "number",
},
"type": Object {
"detail": undefined,
"summary": "number",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "stringRequired",
"required": true,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "booleanRequired",
"required": true,
"sbType": Object {
"name": "boolean",
},
@ -37,18 +231,66 @@ Object {
},
Object {
"defaultValue": null,
"description": "Simple click handler",
"name": "onClick",
"required": false,
"description": "",
"name": "arrayRequired",
"required": true,
"sbType": Object {
"name": "array",
"raw": "string[]",
"value": Array [
Object {
"name": "string",
},
],
},
"type": Object {
"detail": undefined,
"summary": "Array",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "objectRequired",
"required": true,
"sbType": Object {
"name": "other",
"raw": "Record<string, string>",
"value": "Record",
},
"type": Object {
"detail": undefined,
"summary": "Record",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "functionRequired",
"required": true,
"sbType": Object {
"name": "function",
"raw": "() => void",
"raw": "() => string",
},
"type": Object {
"detail": undefined,
"summary": "signature",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "dateRequired",
"required": true,
"sbType": Object {
"name": "other",
"value": "Date",
},
"type": Object {
"detail": undefined,
"summary": "Date",
},
},
],
}
`;

225
addons/docs/src/frameworks/react/__testfixtures__/ts-function-component/docgen.snapshot
View File

@ -2,38 +2,57 @@
exports[`react component properties ts-function-component 1`] = `
"import React from 'react';
import { imported } from '../imported';
const local = 'local-value';
/**
* The world's most _basic_ button
* A component that renders its props
*/
export const Button = ({
onClick
}) => /*#__PURE__*/React.createElement(\\"button\\", {
onClick: onClick,
type: \\"button\\"
}, \\"hello\\");
Button.defaultProps = {
primary: true,
secondary: false
export const PropsWriter = props => /*#__PURE__*/React.createElement(\\"pre\\", null, JSON.stringify(props));
PropsWriter.defaultProps = {
numberOptional: 1,
stringOptional: 'stringOptional',
booleanOptional: false,
arrayOptional: ['array', 'optional'],
objectOptional: {
object: 'optional'
},
functionOptional: () => 'foo',
dateOptional: new Date(),
localReference: local,
importedReference: imported,
globalReference: Date,
stringGlobalName: 'top'
};
export const component = Button;
Button.__docgenInfo = {
\\"description\\": \\"The world's most _basic_ button\\",
export const component = PropsWriter;
PropsWriter.__docgenInfo = {
\\"description\\": \\"A component that renders its props\\",
\\"methods\\": [],
\\"displayName\\": \\"Button\\",
\\"displayName\\": \\"PropsWriter\\",
\\"props\\": {
\\"primary\\": {
\\"numberOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"true\\",
\\"value\\": \\"1\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"boolean\\"
\\"name\\": \\"number\\"
},
\\"description\\": \\"Is primary?\\"
\\"description\\": \\"\\"
},
\\"secondary\\": {
\\"stringOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"'stringOptional'\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"string\\"
},
\\"description\\": \\"\\"
},
\\"booleanOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"false\\",
\\"computed\\": false
@ -42,22 +61,180 @@ Button.__docgenInfo = {
\\"tsType\\": {
\\"name\\": \\"boolean\\"
},
\\"description\\": \\"default is false\\"
\\"description\\": \\"\\"
},
\\"onClick\\": {
\\"arrayOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"['array', 'optional']\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"Array\\",
\\"elements\\": [{
\\"name\\": \\"string\\"
}],
\\"raw\\": \\"string[]\\"
},
\\"description\\": \\"\\"
},
\\"objectOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"{ object: 'optional' }\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"Record\\",
\\"elements\\": [{
\\"name\\": \\"string\\"
}, {
\\"name\\": \\"string\\"
}],
\\"raw\\": \\"Record<string, string>\\"
},
\\"description\\": \\"\\"
},
\\"functionOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"() => 'foo'\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"signature\\",
\\"type\\": \\"function\\",
\\"raw\\": \\"() => void\\",
\\"raw\\": \\"() => string\\",
\\"signature\\": {
\\"arguments\\": [],
\\"return\\": {
\\"name\\": \\"void\\"
\\"name\\": \\"string\\"
}
}
},
\\"description\\": \\"Simple click handler\\"
\\"description\\": \\"\\"
},
\\"dateOptional\\": {
\\"defaultValue\\": {
\\"value\\": \\"new Date()\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"Date\\"
},
\\"description\\": \\"\\"
},
\\"localReference\\": {
\\"defaultValue\\": {
\\"value\\": \\"'local-value'\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"string\\"
},
\\"description\\": \\"\\"
},
\\"importedReference\\": {
\\"defaultValue\\": {
\\"value\\": \\"imported\\",
\\"computed\\": true
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"string\\"
},
\\"description\\": \\"\\"
},
\\"globalReference\\": {
\\"defaultValue\\": {
\\"value\\": \\"Date\\",
\\"computed\\": true
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"any\\"
},
\\"description\\": \\"\\"
},
\\"stringGlobalName\\": {
\\"defaultValue\\": {
\\"value\\": \\"'top'\\",
\\"computed\\": false
},
\\"required\\": false,
\\"tsType\\": {
\\"name\\": \\"string\\"
},
\\"description\\": \\"\\"
},
\\"numberRequired\\": {
\\"required\\": true,
\\"tsType\\": {
\\"name\\": \\"number\\"
},
\\"description\\": \\"Description\\"
},
\\"stringRequired\\": {
\\"required\\": true,
\\"tsType\\": {
\\"name\\": \\"string\\"
},
\\"description\\": \\"\\"
},
\\"booleanRequired\\": {
\\"required\\": true,
\\"tsType\\": {
\\"name\\": \\"boolean\\"
},
\\"description\\": \\"\\"
},
\\"arrayRequired\\": {
\\"required\\": true,
\\"tsType\\": {
\\"name\\": \\"Array\\",
\\"elements\\": [{
\\"name\\": \\"string\\"
}],
\\"raw\\": \\"string[]\\"
},
\\"description\\": \\"\\"
},
\\"objectRequired\\": {
\\"required\\": true,
\\"tsType\\": {
\\"name\\": \\"Record\\",
\\"elements\\": [{
\\"name\\": \\"string\\"
}, {
\\"name\\": \\"string\\"
}],
\\"raw\\": \\"Record<string, string>\\"
},
\\"description\\": \\"\\"
},
\\"functionRequired\\": {
\\"required\\": true,
\\"tsType\\": {
\\"name\\": \\"signature\\",
\\"type\\": \\"function\\",
\\"raw\\": \\"() => string\\",
\\"signature\\": {
\\"arguments\\": [],
\\"return\\": {
\\"name\\": \\"string\\"
}
}
},
\\"description\\": \\"\\"
},
\\"dateRequired\\": {
\\"required\\": true,
\\"tsType\\": {
\\"name\\": \\"Date\\"
},
\\"description\\": \\"\\"
}
}
};"

262
addons/docs/src/frameworks/react/__testfixtures__/ts-function-component/properties.snapshot
View File

@ -6,10 +6,42 @@ Object {
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "true",
"summary": "1",
},
"description": "Is primary?",
"name": "primary",
"description": "",
"name": "numberOptional",
"required": false,
"sbType": Object {
"name": "number",
},
"type": Object {
"detail": undefined,
"summary": "number",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "'stringOptional'",
},
"description": "",
"name": "stringOptional",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "false",
},
"description": "",
"name": "booleanOptional",
"required": false,
"sbType": Object {
"name": "boolean",
@ -22,11 +54,173 @@ Object {
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "false",
"summary": "['array', 'optional']",
},
"description": "default is false",
"name": "secondary",
"description": "",
"name": "arrayOptional",
"required": false,
"sbType": Object {
"name": "array",
"raw": "string[]",
"value": Array [
Object {
"name": "string",
},
],
},
"type": Object {
"detail": undefined,
"summary": "Array",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "{ object: 'optional' }",
},
"description": "",
"name": "objectOptional",
"required": false,
"sbType": Object {
"name": "other",
"raw": "Record<string, string>",
"value": "Record",
},
"type": Object {
"detail": undefined,
"summary": "Record",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "() => 'foo'",
},
"description": "",
"name": "functionOptional",
"required": false,
"sbType": Object {
"name": "function",
"raw": "() => string",
},
"type": Object {
"detail": undefined,
"summary": "signature",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "new Date()",
},
"description": "",
"name": "dateOptional",
"required": false,
"sbType": Object {
"name": "other",
"value": "Date",
},
"type": Object {
"detail": undefined,
"summary": "Date",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "'local-value'",
},
"description": "",
"name": "localReference",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "imported",
},
"description": "",
"name": "importedReference",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "Date",
},
"description": "",
"name": "globalReference",
"required": false,
"sbType": Object {
"name": "other",
"value": "any",
},
"type": Object {
"detail": undefined,
"summary": "any",
},
},
Object {
"defaultValue": Object {
"detail": undefined,
"summary": "'top'",
},
"description": "",
"name": "stringGlobalName",
"required": false,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": null,
"description": "Description",
"name": "numberRequired",
"required": true,
"sbType": Object {
"name": "number",
},
"type": Object {
"detail": undefined,
"summary": "number",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "stringRequired",
"required": true,
"sbType": Object {
"name": "string",
},
"type": Object {
"detail": undefined,
"summary": "string",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "booleanRequired",
"required": true,
"sbType": Object {
"name": "boolean",
},
@ -37,18 +231,66 @@ Object {
},
Object {
"defaultValue": null,
"description": "Simple click handler",
"name": "onClick",
"required": false,
"description": "",
"name": "arrayRequired",
"required": true,
"sbType": Object {
"name": "array",
"raw": "string[]",
"value": Array [
Object {
"name": "string",
},
],
},
"type": Object {
"detail": undefined,
"summary": "Array",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "objectRequired",
"required": true,
"sbType": Object {
"name": "other",
"raw": "Record<string, string>",
"value": "Record",
},
"type": Object {
"detail": undefined,
"summary": "Record",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "functionRequired",
"required": true,
"sbType": Object {
"name": "function",
"raw": "() => void",
"raw": "() => string",
},
"type": Object {
"detail": undefined,
"summary": "signature",
},
},
Object {
"defaultValue": null,
"description": "",
"name": "dateRequired",
"required": true,
"sbType": Object {
"name": "other",
"value": "Date",
},
"type": Object {
"detail": undefined,
"summary": "Date",
},
},
],
}
`;

4
addons/docs/src/frameworks/react/react-properties.test.ts
View File

@ -8,6 +8,8 @@ import requireFromString from 'require-from-string';
import { extractProps } from './extractProps';
import { normalizeNewlines } from '../../lib/utils';
// jest.mock('../imported', () => () => ({ imported: 'imported-value' }), { virtual: true });
// File hierarchy:
// __testfixtures__ / some-test-case / input.*
const inputRegExp = /^input\..*$/;
@ -57,7 +59,7 @@ describe('react component properties', () => {
const docgenModule = transformToModule(docgenPretty);
// snapshot the output of component-properties/react
const { component } = requireFromString(docgenModule);
const { component } = requireFromString(docgenModule, inputPath);
const properties = extractProps(component);
expect(properties).toMatchSpecificSnapshot(path.join(testDir, 'properties.snapshot'));
});