+> = React.FunctionComponent;
+
+export type MenuItemProps<
+ D extends React.ElementType,
+ P = {}
+> = MatMenuItemProps;
+
+const MenuItem = React.forwardRef>(
+ (
+ props: MenuItemProps,
+ ref: React.Ref
+ ) => {
+ return (
+ props: MenuItemProps
+) => React.ReactElement;
+
+(MenuItem as ComponentObjectOf).propTypes = {
+ /** Menu item contents. */
+ children: PropTypes.node,
+ /** Override or extend the styles applied to the component. See CSS API below for more details. */
+ classes: PropTypes.object,
+};
+
+(MenuItem as ComponentObjectOf).defaultProps = {
+ component: 'li',
+ disableGutters: false,
+};
+
+export default MenuItem;
diff --git a/src/__tests__/parse-test.js b/src/__tests__/parse-test.js
index 75d07628c7c..0bc4411d0d6 100644
--- a/src/__tests__/parse-test.js
+++ b/src/__tests__/parse-test.js
@@ -66,7 +66,7 @@ describe('parse', () => {
],
},
}),
- ).toThrowError(/.*Unexpected token \(1:13\).*/);
+ ).toThrowError(/.*Missing initializer in const declaration. \(1:13\).*/);
});
it('supports custom parserOptions without plugins', () => {
diff --git a/src/handlers/__tests__/componentDocblockHandler-test.js b/src/handlers/__tests__/componentDocblockHandler-test.js
index 61952acc5ef..356e6450a0e 100644
--- a/src/handlers/__tests__/componentDocblockHandler-test.js
+++ b/src/handlers/__tests__/componentDocblockHandler-test.js
@@ -245,6 +245,13 @@ describe('componentDocblockHandler', () => {
);
});
+ describe('inline implementation with memo', () => {
+ test(`
+ React.memo(React.forwardRef((props, ref) => {}));
+ import React from "react";`, src =>
+ beforeLastStatement(src).get('expression'));
+ });
+
describe('out of line implementation', () => {
test(
[
diff --git a/src/handlers/__tests__/componentMethodsHandler-test.js b/src/handlers/__tests__/componentMethodsHandler-test.js
index da27ef77ab0..812329937aa 100644
--- a/src/handlers/__tests__/componentMethodsHandler-test.js
+++ b/src/handlers/__tests__/componentMethodsHandler-test.js
@@ -156,6 +156,25 @@ describe('componentMethodsHandler', () => {
expect(documentation.methods).toMatchSnapshot();
});
+ it('should handle and ignore private properties', () => {
+ const src = `
+ class Test extends React.Component {
+ #privateProperty = () => {
+ console.log('Do something');
+ }
+
+ componentDidMount() {}
+
+ render() {
+ return null;
+ }
+ }
+ `;
+
+ componentMethodsHandler(documentation, parse(src).get('body', 0));
+ expect(documentation.methods.length).toBe(0);
+ });
+
describe('function components', () => {
it('no methods', () => {
const src = `
diff --git a/src/handlers/__tests__/propTypeCompositionHandler-test.js b/src/handlers/__tests__/propTypeCompositionHandler-test.js
index b77ea521d7c..3eacd3a1785 100644
--- a/src/handlers/__tests__/propTypeCompositionHandler-test.js
+++ b/src/handlers/__tests__/propTypeCompositionHandler-test.js
@@ -21,8 +21,8 @@ describe('propTypeCompositionHandler', () => {
jest.mock('../../utils/getPropType');
documentation = new (require('../../Documentation'))();
- propTypeCompositionHandler = require('../propTypeCompositionHandler')
- .default;
+ propTypeCompositionHandler =
+ require('../propTypeCompositionHandler').default;
});
function test(getSrc, parse) {
diff --git a/src/handlers/componentMethodsHandler.js b/src/handlers/componentMethodsHandler.js
index 31f3a11b4bb..9e4e3a6f836 100644
--- a/src/handlers/componentMethodsHandler.js
+++ b/src/handlers/componentMethodsHandler.js
@@ -17,6 +17,11 @@ import match from '../utils/match';
import { traverseShallow } from '../utils/traverse';
import resolveToValue from '../utils/resolveToValue';
+function isPublicClassProperty(path) {
+ return (
+ t.ClassProperty.check(path.node) && !t.ClassPrivateProperty.check(path.node)
+ );
+}
/**
* The following values/constructs are considered methods:
*
@@ -28,7 +33,7 @@ import resolveToValue from '../utils/resolveToValue';
function isMethod(path) {
const isProbablyMethod =
(t.MethodDefinition.check(path.node) && path.node.kind !== 'constructor') ||
- ((t.ClassProperty.check(path.node) || t.Property.check(path.node)) &&
+ ((isPublicClassProperty(path) || t.Property.check(path.node)) &&
t.Function.check(path.get('value').node));
return isProbablyMethod && !isReactComponentMethod(path);
@@ -45,7 +50,7 @@ function findAssignedMethods(scope, idPath) {
const idScope = idPath.scope.lookup(idPath.node.name);
traverseShallow((scope: any).path, {
- visitAssignmentExpression: function(path) {
+ visitAssignmentExpression: function (path) {
const node = path.node;
if (
match(node.left, {
diff --git a/src/handlers/defaultPropsHandler.js b/src/handlers/defaultPropsHandler.js
index 638f08d7781..17acd90321a 100644
--- a/src/handlers/defaultPropsHandler.js
+++ b/src/handlers/defaultPropsHandler.js
@@ -49,11 +49,11 @@ function getDefaultValue(path: NodePath) {
}
function getStatelessPropsPath(componentDefinition): NodePath {
- const value = resolveToValue(componentDefinition);
+ let value = resolveToValue(componentDefinition);
if (isReactForwardRefCall(value)) {
- const inner = resolveToValue(value.get('arguments', 0));
- return inner.get('params', 0);
+ value = resolveToValue(value.get('arguments', 0));
}
+
return value.get('params', 0);
}
@@ -74,9 +74,8 @@ function getDefaultPropsPath(componentDefinition: NodePath): ?NodePath {
if (t.FunctionExpression.check(defaultPropsPath.node)) {
// Find the value that is returned from the function and process it if it is
// an object literal.
- const returnValue = resolveFunctionDefinitionToReturnValue(
- defaultPropsPath,
- );
+ const returnValue =
+ resolveFunctionDefinitionToReturnValue(defaultPropsPath);
if (returnValue && t.ObjectExpression.check(returnValue.node)) {
defaultPropsPath = returnValue;
}
diff --git a/src/handlers/propTypeCompositionHandler.js b/src/handlers/propTypeCompositionHandler.js
index 17d289e32a5..bce9bd7d268 100644
--- a/src/handlers/propTypeCompositionHandler.js
+++ b/src/handlers/propTypeCompositionHandler.js
@@ -25,7 +25,7 @@ function amendComposes(documentation, path) {
}
function processObjectExpression(documentation, path) {
- path.get('properties').each(function(propertyPath) {
+ path.get('properties').each(function (propertyPath) {
switch (propertyPath.node.type) {
case t.SpreadElement.name:
amendComposes(
diff --git a/src/handlers/propTypeHandler.js b/src/handlers/propTypeHandler.js
index 5aa5b7e5816..30c5e1eddd7 100644
--- a/src/handlers/propTypeHandler.js
+++ b/src/handlers/propTypeHandler.js
@@ -64,7 +64,7 @@ function amendPropTypes(getDescriptor, path) {
}
function getPropTypeHandler(propName: string) {
- return function(documentation: Documentation, path: NodePath) {
+ return function (documentation: Documentation, path: NodePath) {
let propTypesPath = getMemberValuePath(path, propName);
if (!propTypesPath) {
return;
diff --git a/src/resolver/findAllComponentDefinitions.js b/src/resolver/findAllComponentDefinitions.js
index 3e3396e8c7e..900860153ca 100644
--- a/src/resolver/findAllComponentDefinitions.js
+++ b/src/resolver/findAllComponentDefinitions.js
@@ -45,7 +45,7 @@ export default function findAllReactCreateClassCalls(
visitArrowFunctionExpression: statelessVisitor,
visitClassExpression: classVisitor,
visitClassDeclaration: classVisitor,
- visitCallExpression: function(path) {
+ visitCallExpression: function (path) {
if (isReactForwardRefCall(path)) {
// If the the inner function was previously identified as a component
// replace it with the parent node
diff --git a/src/resolver/findAllExportedComponentDefinitions.js b/src/resolver/findAllExportedComponentDefinitions.js
index a0f26d02b53..f2924d8ad15 100644
--- a/src/resolver/findAllExportedComponentDefinitions.js
+++ b/src/resolver/findAllExportedComponentDefinitions.js
@@ -114,7 +114,7 @@ export default function findExportedComponentDefinitions(
visitExportNamedDeclaration: exportDeclaration,
visitExportDefaultDeclaration: exportDeclaration,
- visitAssignmentExpression: function(path: NodePath): ?boolean {
+ visitAssignmentExpression: function (path: NodePath): ?boolean {
// Ignore anything that is not `exports.X = ...;` or
// `module.exports = ...;`
if (!isExportsOrModuleAssignment(path)) {
diff --git a/src/resolver/findExportedComponentDefinition.js b/src/resolver/findExportedComponentDefinition.js
index 0ad8b0028a0..2211383fbb9 100644
--- a/src/resolver/findExportedComponentDefinition.js
+++ b/src/resolver/findExportedComponentDefinition.js
@@ -118,7 +118,7 @@ export default function findExportedComponentDefinition(
visitExportNamedDeclaration: exportDeclaration,
visitExportDefaultDeclaration: exportDeclaration,
- visitAssignmentExpression: function(path) {
+ visitAssignmentExpression: function (path) {
// Ignore anything that is not `exports.X = ...;` or
// `module.exports = ...;`
if (!isExportsOrModuleAssignment(path)) {
diff --git a/src/utils/__tests__/__snapshots__/getFlowType-test.js.snap b/src/utils/__tests__/__snapshots__/getFlowType-test.js.snap
new file mode 100644
index 00000000000..e1e91b901bb
--- /dev/null
+++ b/src/utils/__tests__/__snapshots__/getFlowType-test.js.snap
@@ -0,0 +1,107 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`getFlowType handles ObjectTypeSpreadProperty 1`] = `
+Object {
+ "name": "signature",
+ "raw": "{| apple: string, banana: string, ...OtherFruits |}",
+ "signature": Object {
+ "properties": Array [
+ Object {
+ "key": "apple",
+ "value": Object {
+ "name": "string",
+ "required": true,
+ },
+ },
+ Object {
+ "key": "banana",
+ "value": Object {
+ "name": "string",
+ "required": true,
+ },
+ },
+ Object {
+ "key": "orange",
+ "value": Object {
+ "name": "string",
+ "required": true,
+ },
+ },
+ ],
+ },
+ "type": "object",
+}
+`;
+
+exports[`getFlowType handles nested ObjectTypeSpreadProperty 1`] = `
+Object {
+ "name": "signature",
+ "raw": "{| apple: string, banana: string, ...BreakfastFruits |}",
+ "signature": Object {
+ "properties": Array [
+ Object {
+ "key": "apple",
+ "value": Object {
+ "name": "string",
+ "required": true,
+ },
+ },
+ Object {
+ "key": "banana",
+ "value": Object {
+ "name": "string",
+ "required": true,
+ },
+ },
+ Object {
+ "key": "mango",
+ "value": Object {
+ "name": "string",
+ "required": true,
+ },
+ },
+ Object {
+ "key": "orange",
+ "value": Object {
+ "name": "string",
+ "required": true,
+ },
+ },
+ Object {
+ "key": "lemon",
+ "value": Object {
+ "name": "string",
+ "required": true,
+ },
+ },
+ ],
+ },
+ "type": "object",
+}
+`;
+
+exports[`getFlowType handles unresolved ObjectTypeSpreadProperty 1`] = `
+Object {
+ "name": "signature",
+ "raw": "{| apple: string, banana: string, ...MyType |}",
+ "signature": Object {
+ "properties": Array [
+ Object {
+ "key": "apple",
+ "value": Object {
+ "name": "string",
+ "required": true,
+ },
+ },
+ Object {
+ "key": "banana",
+ "value": Object {
+ "name": "string",
+ "required": true,
+ },
+ },
+ ],
+ },
+ "type": "object",
+}
+`;
diff --git a/src/utils/__tests__/__snapshots__/getMembers-test.js.snap b/src/utils/__tests__/__snapshots__/getMembers-test.js.snap
index 685744318fb..8014dac0dc9 100644
--- a/src/utils/__tests__/__snapshots__/getMembers-test.js.snap
+++ b/src/utils/__tests__/__snapshots__/getMembers-test.js.snap
@@ -12,6 +12,8 @@ Array [
"column": 12,
"line": 1,
},
+ "filename": undefined,
+ "identifierName": undefined,
"start": Position {
"column": 9,
"line": 1,
@@ -31,6 +33,8 @@ Array [
"column": 8,
"line": 1,
},
+ "filename": undefined,
+ "identifierName": undefined,
"start": Position {
"column": 1,
"line": 1,
@@ -43,6 +47,7 @@ Array [
"column": 4,
"line": 1,
},
+ "filename": undefined,
"identifierName": "foo",
"start": Position {
"column": 1,
@@ -53,6 +58,7 @@ Array [
"start": 1,
"type": "Identifier",
},
+ "optional": false,
"property": Node {
"end": 8,
"loc": SourceLocation {
@@ -60,6 +66,7 @@ Array [
"column": 8,
"line": 1,
},
+ "filename": undefined,
"identifierName": "bar",
"start": Position {
"column": 5,
@@ -79,11 +86,14 @@ Array [
"column": 13,
"line": 1,
},
+ "filename": undefined,
+ "identifierName": undefined,
"start": Position {
"column": 1,
"line": 1,
},
},
+ "optional": false,
"start": 1,
"type": "CallExpression",
},
@@ -95,6 +105,7 @@ Array [
"column": 8,
"line": 1,
},
+ "filename": undefined,
"identifierName": "bar",
"start": Position {
"column": 5,
@@ -116,6 +127,7 @@ Array [
"column": 22,
"line": 1,
},
+ "filename": undefined,
"identifierName": "baz",
"start": Position {
"column": 19,
@@ -137,6 +149,8 @@ Array [
"column": 26,
"line": 1,
},
+ "filename": undefined,
+ "identifierName": undefined,
"start": Position {
"column": 24,
"line": 1,
diff --git a/src/utils/__tests__/__snapshots__/resolveGenericTypeAnnotations-test.js.snap b/src/utils/__tests__/__snapshots__/resolveGenericTypeAnnotations-test.js.snap
new file mode 100644
index 00000000000..49f80e5323b
--- /dev/null
+++ b/src/utils/__tests__/__snapshots__/resolveGenericTypeAnnotations-test.js.snap
@@ -0,0 +1,86 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`resolveGenericTypeAnnotation resolves type 1`] = `
+Node {
+ "callProperties": Array [],
+ "end": 57,
+ "exact": false,
+ "indexers": Array [],
+ "inexact": false,
+ "internalSlots": Array [],
+ "loc": SourceLocation {
+ "end": Position {
+ "column": 34,
+ "line": 3,
+ },
+ "filename": undefined,
+ "identifierName": undefined,
+ "start": Position {
+ "column": 21,
+ "line": 3,
+ },
+ },
+ "properties": Array [
+ Node {
+ "end": 55,
+ "key": Node {
+ "end": 47,
+ "loc": SourceLocation {
+ "end": Position {
+ "column": 24,
+ "line": 3,
+ },
+ "filename": undefined,
+ "identifierName": "x",
+ "start": Position {
+ "column": 23,
+ "line": 3,
+ },
+ },
+ "name": "x",
+ "start": 46,
+ "type": "Identifier",
+ },
+ "kind": "init",
+ "loc": SourceLocation {
+ "end": Position {
+ "column": 32,
+ "line": 3,
+ },
+ "filename": undefined,
+ "identifierName": undefined,
+ "start": Position {
+ "column": 23,
+ "line": 3,
+ },
+ },
+ "method": false,
+ "optional": false,
+ "proto": false,
+ "start": 46,
+ "static": false,
+ "type": "ObjectTypeProperty",
+ "value": Node {
+ "end": 55,
+ "loc": SourceLocation {
+ "end": Position {
+ "column": 32,
+ "line": 3,
+ },
+ "filename": undefined,
+ "identifierName": undefined,
+ "start": Position {
+ "column": 26,
+ "line": 3,
+ },
+ },
+ "start": 49,
+ "type": "StringTypeAnnotation",
+ },
+ "variance": null,
+ },
+ ],
+ "start": 44,
+ "type": "ObjectTypeAnnotation",
+}
+`;
diff --git a/src/utils/__tests__/expressionTo-test.js b/src/utils/__tests__/expressionTo-test.js
new file mode 100644
index 00000000000..44b5a142e23
--- /dev/null
+++ b/src/utils/__tests__/expressionTo-test.js
@@ -0,0 +1,54 @@
+import { expression, noopImporter } from '../../../tests/utils';
+import { Array as expressionToArray } from '../expressionTo';
+
+describe('expressionTo', () => {
+ describe('MemberExpression', () => {
+ it('with only identifiers', () => {
+ expect(
+ expressionToArray(expression('foo.bar.baz'), noopImporter),
+ ).toEqual(['foo', 'bar', 'baz']);
+ });
+
+ it('with one computed literal', () => {
+ expect(
+ expressionToArray(expression('foo["bar"].baz'), noopImporter),
+ ).toEqual(['foo', '"bar"', 'baz']);
+ });
+
+ it('with one computed identifier', () => {
+ expect(
+ expressionToArray(expression('foo[bar].baz'), noopImporter),
+ ).toEqual(['foo', 'bar', 'baz']);
+ });
+
+ it('with one computed object', () => {
+ expect(
+ expressionToArray(expression('foo[{ a: "true"}].baz'), noopImporter),
+ ).toEqual(['foo', '{a: "true"}', 'baz']);
+ });
+
+ it('with one computed object with spread', () => {
+ expect(
+ expressionToArray(expression('foo[{ ...a }].baz'), noopImporter),
+ ).toEqual(['foo', '{...a}', 'baz']);
+ });
+
+ it('with one computed object with method', () => {
+ expect(
+ expressionToArray(expression('foo[{ a(){} }].baz'), noopImporter),
+ ).toEqual(['foo', '{a: }', 'baz']);
+ });
+
+ it('with TSAsExpression', () => {
+ expect(
+ expressionToArray(
+ expression('(baz as X).prop', {
+ filename: 'file.ts',
+ parserOptions: { plugins: ['typescript'] },
+ }),
+ noopImporter,
+ ),
+ ).toEqual(['baz', 'prop']);
+ });
+ });
+});
diff --git a/src/utils/__tests__/getFlowType-test.js b/src/utils/__tests__/getFlowType-test.js
index 367c974ecb4..41207f3427d 100644
--- a/src/utils/__tests__/getFlowType-test.js
+++ b/src/utils/__tests__/getFlowType-test.js
@@ -745,4 +745,43 @@ describe('getFlowType', () => {
raw: '{ subAction: SubAction }',
});
});
+
+ it('handles ObjectTypeSpreadProperty', () => {
+ const typePath = statement(`
+ var x: {| apple: string, banana: string, ...OtherFruits |} = 2;
+ type OtherFruits = { orange: string }
+ `)
+ .get('declarations', 0)
+ .get('id')
+ .get('typeAnnotation')
+ .get('typeAnnotation');
+
+ expect(getFlowType(typePath)).toMatchSnapshot();
+ });
+
+ it('handles unresolved ObjectTypeSpreadProperty', () => {
+ const typePath = statement(`
+ var x: {| apple: string, banana: string, ...MyType |} = 2;
+ `)
+ .get('declarations', 0)
+ .get('id')
+ .get('typeAnnotation')
+ .get('typeAnnotation');
+
+ expect(getFlowType(typePath)).toMatchSnapshot();
+ });
+
+ it('handles nested ObjectTypeSpreadProperty', () => {
+ const typePath = statement(`
+ var x: {| apple: string, banana: string, ...BreakfastFruits |} = 2;
+ type BreakfastFruits = { mango: string, ...CitrusFruits };
+ type CitrusFruits = { orange: string, lemon: string };
+ `)
+ .get('declarations', 0)
+ .get('id')
+ .get('typeAnnotation')
+ .get('typeAnnotation');
+
+ expect(getFlowType(typePath)).toMatchSnapshot();
+ });
});
diff --git a/src/utils/__tests__/getTSType-test.js b/src/utils/__tests__/getTSType-test.js
index bc8a8914814..80216689f6c 100644
--- a/src/utils/__tests__/getTSType-test.js
+++ b/src/utils/__tests__/getTSType-test.js
@@ -377,6 +377,26 @@ describe('getTSType', () => {
});
});
+ it('resolves indexed access of array', () => {
+ const typePath = statement(`
+ var x: typeof STRING_VALS[number];
+
+ const STRING_VALS = [
+ 'one',
+ 'two',
+ 'three'
+ ];
+ `)
+ .get('declarations', 0)
+ .get('id')
+ .get('typeAnnotation')
+ .get('typeAnnotation');
+ expect(getTSType(typePath)).toEqual({
+ name: 'STRING_VALS[number]',
+ raw: 'typeof STRING_VALS[number]',
+ });
+ });
+
it('resolves types in scope', () => {
const typePath = statement(`
var x: MyType = 2;
diff --git a/src/utils/__tests__/isReactForwardRefCall-test.js b/src/utils/__tests__/isReactForwardRefCall-test.js
index 2395f7cba9d..d0e63e9b595 100644
--- a/src/utils/__tests__/isReactForwardRefCall-test.js
+++ b/src/utils/__tests__/isReactForwardRefCall-test.js
@@ -78,6 +78,14 @@ describe('isReactForwardRefCall', () => {
expect(isReactForwardRefCall(def)).toBe(true);
});
+ it('does not accept forwardRef if not outer call', () => {
+ const def = parsePath(`
+ import { forwardRef, memo } from "react";
+ memo(forwardRef({}));
+ `);
+ expect(isReactForwardRefCall(def)).toBe(false);
+ });
+
it('accepts forwardRef called on imported aliased value', () => {
const def = parsePath(`
import { forwardRef as foo } from "react";
diff --git a/src/utils/__tests__/isStatelessComponent-test.js b/src/utils/__tests__/isStatelessComponent-test.js
index 10de014a609..b020bed8a1f 100644
--- a/src/utils/__tests__/isStatelessComponent-test.js
+++ b/src/utils/__tests__/isStatelessComponent-test.js
@@ -88,9 +88,8 @@ describe('isStatelessComponent', () => {
const returnExpr = componentIdentifiers[componentIdentifierName];
describe(componentIdentifierName, () => {
Object.keys(componentStyle).forEach(componentName => {
- const [componentFactory, componentSelector] = componentStyle[
- componentName
- ];
+ const [componentFactory, componentSelector] =
+ componentStyle[componentName];
describe(componentName, () => {
Object.keys(modifiers).forEach(modifierName => {
const modifierFactory = modifiers[modifierName];
diff --git a/src/utils/__tests__/isUnreachableFlowType-test.js b/src/utils/__tests__/isUnreachableFlowType-test.js
new file mode 100644
index 00000000000..6edd0df1e45
--- /dev/null
+++ b/src/utils/__tests__/isUnreachableFlowType-test.js
@@ -0,0 +1,20 @@
+import { expression, statement } from '../../../tests/utils';
+import isUnreachableFlowType from '../isUnreachableFlowType';
+
+describe('isUnreachableFlowType', () => {
+ it('considers Identifier as unreachable', () => {
+ expect(isUnreachableFlowType(expression('foo'))).toBe(true);
+ });
+
+ it('considers ImportDeclaration as unreachable', () => {
+ expect(isUnreachableFlowType(statement('import x from "";'))).toBe(true);
+ });
+
+ it('considers CallExpression as unreachable', () => {
+ expect(isUnreachableFlowType(expression('foo()'))).toBe(true);
+ });
+
+ it('considers VariableDeclaration not as unreachable', () => {
+ expect(isUnreachableFlowType(statement('const x = 1;'))).toBe(false);
+ });
+});
diff --git a/src/utils/__tests__/printValue-test.js b/src/utils/__tests__/printValue-test.js
index b5856c71770..bcbd29d1efa 100644
--- a/src/utils/__tests__/printValue-test.js
+++ b/src/utils/__tests__/printValue-test.js
@@ -6,6 +6,7 @@
*
*/
+import { builders, NodePath } from 'ast-types';
import { parse } from '../../../tests/utils';
import printValue from '../printValue';
@@ -21,4 +22,32 @@ describe('printValue', () => {
it('does not print trailing comments', () => {
expect(printValue(pathFromSource('bar//foo'))).toEqual('bar');
});
+
+ it('handles arbitrary generated nodes', () => {
+ expect(
+ printValue(
+ new NodePath(
+ builders.arrayExpression([
+ builders.literal('bar'),
+ builders.literal('foo'),
+ builders.literal(1),
+ builders.literal(2),
+ builders.literal(3),
+ builders.literal(null),
+ builders.memberExpression(
+ builders.identifier('foo'),
+ builders.identifier('bar'),
+ ),
+ builders.jsxElement(
+ builders.jsxOpeningElement(
+ builders.jsxIdentifier('Baz'),
+ [],
+ true,
+ ),
+ ),
+ ]),
+ ),
+ ),
+ ).toEqual('["bar", "foo", 1, 2, 3, null, foo.bar, {
} else if (t.Identifier.check(node)) {
result.push(node.name);
continue;
+ } else if (t.TSAsExpression.check(node)) {
+ if (t.Identifier.check(node.expression)) {
+ result.push(node.expression.name);
+ }
+ continue;
} else if (t.Literal.check(node)) {
result.push(node.raw);
continue;
+ } else if (t.FunctionExpression.check(node)) {
+ result.push('');
+ continue;
} else if (t.ThisExpression.check(node)) {
result.push('this');
continue;
} else if (t.ObjectExpression.check(node)) {
- const properties = path.get('properties').map(function(property) {
- return (
- toString(property.get('key')) + ': ' + toString(property.get('value'))
- );
+ const properties = path.get('properties').map(function (property) {
+ if (t.SpreadElement.check(property.node)) {
+ return `...${toString(property.get('argument'))}`;
+ } else {
+ return (
+ toString(property.get('key')) +
+ ': ' +
+ toString(property.get('value'))
+ );
+ }
});
result.push('{' + properties.join(', ') + '}');
continue;
} else if (t.ArrayExpression.check(node)) {
- result.push(
- '[' +
- path
- .get('elements')
- .map(toString)
- .join(', ') +
- ']',
- );
+ result.push('[' + path.get('elements').map(toString).join(', ') + ']');
continue;
}
}
diff --git a/src/utils/getFlowType.js b/src/utils/getFlowType.js
index 5eb1ad7ff7c..621c5d46310 100644
--- a/src/utils/getFlowType.js
+++ b/src/utils/getFlowType.js
@@ -201,6 +201,18 @@ function handleObjectTypeAnnotation(
key: ((getPropertyName(param): any): string),
value: getFlowTypeWithRequirements(param.get('value'), typeParams),
});
+ } else if (t.ObjectTypeSpreadProperty.check(param.node)) {
+ let spreadObject = resolveToValue(param.get('argument'));
+ if (t.GenericTypeAnnotation.check(spreadObject.node)) {
+ const typeAlias = resolveToValue(spreadObject.get('id'));
+ if (t.ObjectTypeAnnotation.check(typeAlias.get('right').node)) {
+ spreadObject = resolveToValue(typeAlias.get('right'));
+ }
+ }
+ if (t.ObjectTypeAnnotation.check(spreadObject.node)) {
+ const props = handleObjectTypeAnnotation(spreadObject, typeParams);
+ type.signature.properties.push(...props.signature.properties);
+ }
}
});
diff --git a/src/utils/getPropType.js b/src/utils/getPropType.js
index febf24e65f4..85ce4084013 100644
--- a/src/utils/getPropType.js
+++ b/src/utils/getPropType.js
@@ -23,7 +23,7 @@ import type { PropTypeDescriptor, PropDescriptor } from '../types';
function getEnumValues(path) {
const values = [];
- path.get('elements').each(function(elementPath) {
+ path.get('elements').each(function (elementPath) {
if (t.SpreadElement.check(elementPath.node)) {
const value = resolveToValue(elementPath.get('argument'));
@@ -75,7 +75,7 @@ function getPropTypeOneOfType(argumentPath) {
type.computed = true;
type.value = printValue(argumentPath);
} else {
- type.value = argumentPath.get('elements').map(function(itemPath) {
+ type.value = argumentPath.get('elements').map(function (itemPath) {
const descriptor: PropTypeDescriptor = getPropType(itemPath);
const docs = getDocblock(itemPath);
if (docs) {
@@ -136,7 +136,7 @@ function getPropTypeShapish(name, argumentPath) {
if (t.ObjectExpression.check(argumentPath.node)) {
const value = {};
- argumentPath.get('properties').each(function(propertyPath) {
+ argumentPath.get('properties').each(function (propertyPath) {
if (propertyPath.get('type').value === t.SpreadElement.name) {
// It is impossible to resolve a name for a spread element
return;
diff --git a/src/utils/getTSType.js b/src/utils/getTSType.js
index 83f9117e56d..0a78f6f1049 100644
--- a/src/utils/getTSType.js
+++ b/src/utils/getTSType.js
@@ -164,10 +164,7 @@ function handleTSTypeLiteral(
} else if (t.TSIndexSignature.check(param.node)) {
type.signature.properties.push({
key: getTSTypeWithResolvedTypes(
- param
- .get('parameters')
- .get(0)
- .get('typeAnnotation'),
+ param.get('parameters').get(0).get('typeAnnotation'),
typeParams,
),
value: getTSTypeWithRequirements(
@@ -352,10 +349,8 @@ function handleTSIndexedAccessType(
typeParams: ?TypeParameters,
): FlowSimpleType {
// eslint-disable-next-line no-undef
- const objectType: $Shape = getTSTypeWithResolvedTypes(
- path.get('objectType'),
- typeParams,
- );
+ const objectType: $Shape =
+ getTSTypeWithResolvedTypes(path.get('objectType'), typeParams);
// eslint-disable-next-line no-undef
const indexType: $Shape = getTSTypeWithResolvedTypes(
path.get('indexType'),
@@ -365,12 +360,14 @@ function handleTSIndexedAccessType(
// We only get the signature if the objectType is a type (vs interface)
if (!objectType.signature)
return {
- name: `${objectType.name}[${indexType.value.toString()}]`,
+ name: `${objectType.name}[${
+ indexType.value ? indexType.value.toString() : indexType.name
+ }]`,
raw: printValue(path),
};
const resolvedType = objectType.signature.properties.find(p => {
// indexType.value = "'foo'"
- return p.key === indexType.value.replace(/['"]+/g, '');
+ return indexType.value && p.key === indexType.value.replace(/['"]+/g, '');
});
if (!resolvedType) {
return { name: 'unknown' };
diff --git a/src/utils/isReactBuiltinCall.js b/src/utils/isReactBuiltinCall.js
index 2cd492f808a..e3bd77e7033 100644
--- a/src/utils/isReactBuiltinCall.js
+++ b/src/utils/isReactBuiltinCall.js
@@ -42,10 +42,13 @@ export default function isReactBuiltinCall(
// `import { createElement } from 'react'`
(t.ImportDeclaration.check(value.node) &&
value.node.specifiers.some(
- specifier => specifier.imported && specifier.imported.name === name,
+ specifier =>
+ specifier.imported?.name === name &&
+ specifier.local?.name === path.node.callee.name,
))
) {
const module = resolveToModule(value);
+
return Boolean(module && isReactModuleName(module));
}
}
diff --git a/src/utils/isReactComponentClass.js b/src/utils/isReactComponentClass.js
index 6bf3c682a14..6abf342a32e 100644
--- a/src/utils/isReactComponentClass.js
+++ b/src/utils/isReactComponentClass.js
@@ -59,7 +59,7 @@ export default function isReactComponentClass(path: NodePath): boolean {
// check for @extends React.Component in docblock
if (path.parentPath && path.parentPath.value) {
const classDeclaration = Array.isArray(path.parentPath.value)
- ? path.parentPath.value.find(function(declaration) {
+ ? path.parentPath.value.find(function (declaration) {
return declaration.type === 'ClassDeclaration';
})
: path.parentPath.value;
@@ -67,7 +67,7 @@ export default function isReactComponentClass(path: NodePath): boolean {
if (
classDeclaration &&
classDeclaration.leadingComments &&
- classDeclaration.leadingComments.some(function(comment) {
+ classDeclaration.leadingComments.some(function (comment) {
return /@extends\s+React\.Component/.test(comment.value);
})
) {
diff --git a/src/utils/isReactComponentMethod.js b/src/utils/isReactComponentMethod.js
index d568f523a10..9dffc68403f 100644
--- a/src/utils/isReactComponentMethod.js
+++ b/src/utils/isReactComponentMethod.js
@@ -35,7 +35,7 @@ const componentMethods = [
/**
* Returns if the method path is a Component method.
*/
-export default function(methodPath: NodePath): boolean {
+export default function (methodPath: NodePath): boolean {
if (
!t.MethodDefinition.check(methodPath.node) &&
!t.Property.check(methodPath.node)
diff --git a/src/utils/isReactCreateClassCall.js b/src/utils/isReactCreateClassCall.js
index 1bdabce18c6..31b0243fae4 100644
--- a/src/utils/isReactCreateClassCall.js
+++ b/src/utils/isReactCreateClassCall.js
@@ -8,7 +8,6 @@
*/
import { namedTypes as t } from 'ast-types';
-import match from './match';
import resolveToModule from './resolveToModule';
import isReactBuiltinCall from './isReactBuiltinCall';
@@ -24,7 +23,7 @@ function isReactCreateClassCallModular(path: NodePath): boolean {
path = path.get('expression');
}
- if (!match(path.node, { type: 'CallExpression' })) {
+ if (!t.CallExpression.check(path.node)) {
return false;
}
const module = resolveToModule(path);
diff --git a/src/utils/isReactModuleName.js b/src/utils/isReactModuleName.js
index 2b2c0d2288c..c45f596ae62 100644
--- a/src/utils/isReactModuleName.js
+++ b/src/utils/isReactModuleName.js
@@ -20,7 +20,7 @@ const reactModules = [
* module name.
*/
export default function isReactModuleName(moduleName: string): boolean {
- return reactModules.some(function(reactModuleName) {
+ return reactModules.some(function (reactModuleName) {
return reactModuleName === moduleName.toLowerCase();
});
}
diff --git a/src/utils/normalizeClassDefinition.js b/src/utils/normalizeClassDefinition.js
index 9ccc04e1fe9..085279d4bc1 100644
--- a/src/utils/normalizeClassDefinition.js
+++ b/src/utils/normalizeClassDefinition.js
@@ -75,7 +75,7 @@ export default function normalizeClassDefinition(
visitClassExpression: ignore,
visitForInStatement: ignore,
visitForStatement: ignore,
- visitAssignmentExpression: function(path) {
+ visitAssignmentExpression: function (path) {
if (t.MemberExpression.check(path.node.left)) {
const first = getMemberExpressionRoot(path.get('left'));
if (
diff --git a/src/utils/postProcessDocumentation.js b/src/utils/postProcessDocumentation.js
index a624ea09fe0..21b6d82dfb4 100644
--- a/src/utils/postProcessDocumentation.js
+++ b/src/utils/postProcessDocumentation.js
@@ -20,7 +20,7 @@ function postProcessProps(props) {
});
}
-export default function(
+export default function (
documentation: DocumentationObject,
): DocumentationObject {
const props = documentation.props;
diff --git a/src/utils/printValue.js b/src/utils/printValue.js
index 288bc42023d..bcf0cc19867 100644
--- a/src/utils/printValue.js
+++ b/src/utils/printValue.js
@@ -8,6 +8,8 @@
*/
import strip from 'strip-indent';
+import toBabel from 'estree-to-babel';
+import generate from '@babel/generator';
function deindent(code: string): string {
const firstNewLine = code.indexOf('\n');
@@ -35,15 +37,28 @@ function getSrcFromAst(path: NodePath): string {
*/
export default function printValue(path: NodePath): string {
if (path.node.start == null) {
- // This only happens when we use AST builders to create nodes that do not actually
- // exist in the source (e.g. when resolving Object.keys()). We might need to enhance
- // this if we start using builders from `ast-types` more.
- if (path.node.type === 'Literal') {
- return `"${path.node.value}"`;
+ try {
+ const nodeCopy = {
+ ...path.node,
+ };
+
+ // `estree-to-babel` expects the `comments` property to exist on the top-level node
+ if (!nodeCopy.comments) {
+ nodeCopy.comments = [];
+ }
+
+ return generate(toBabel(nodeCopy), {
+ comments: false,
+ concise: true,
+ }).code;
+ } catch (err) {
+ throw new Error(
+ `Cannot print raw value for type '${path.node.type}'. Please report this with an example at https://github.com/reactjs/react-docgen/issues.
+
+Original error:
+${err.stack}`,
+ );
}
- throw new Error(
- `Cannot print raw value for type '${path.node.type}'. Please report this with an example at https://github.com/reactjs/react-docgen/issues`,
- );
}
const src = getSrcFromAst(path);
diff --git a/src/utils/resolveObjectValuesToArray.js b/src/utils/resolveObjectValuesToArray.js
index fa9caed7dd4..6984fb2ce1d 100644
--- a/src/utils/resolveObjectValuesToArray.js
+++ b/src/utils/resolveObjectValuesToArray.js
@@ -67,7 +67,9 @@ export function resolveObjectToPropMap(
if (error) return;
const prop = propPath.value;
- if (prop.kind === 'get' || prop.kind === 'set') return;
+ if (prop.kind === 'get' || prop.kind === 'set' || prop.method === true) {
+ return;
+ }
if (
t.Property.check(prop) ||
diff --git a/src/utils/resolveToValue.js b/src/utils/resolveToValue.js
index 039092c08d7..aee2edbdbc3 100644
--- a/src/utils/resolveToValue.js
+++ b/src/utils/resolveToValue.js
@@ -77,7 +77,7 @@ function findLastAssignedValue(scope, idPath) {
const name = idPath.node.name;
traverseShallow(scope.path, {
- visitAssignmentExpression: function(path) {
+ visitAssignmentExpression: function (path) {
const node = path.node;
// Skip anything that is not an assignment to a variable with the
// passed name.
diff --git a/tests/setupTestFramework.js b/tests/setupTestFramework.js
index be09e4733e0..8945089921e 100644
--- a/tests/setupTestFramework.js
+++ b/tests/setupTestFramework.js
@@ -5,7 +5,7 @@ const diff = require('jest-diff');
const utils = require('jest-matcher-utils');
const matchers = {
- toEqualASTNode: function(received, expected) {
+ toEqualASTNode: function (received, expected) {
if (!expected || typeof expected !== 'object') {
throw new Error(
'Expected value must be an object representing an AST node.\n' +
diff --git a/website/.browserslistrc b/website/.browserslistrc
deleted file mode 100644
index 7304b74e548..00000000000
--- a/website/.browserslistrc
+++ /dev/null
@@ -1,7 +0,0 @@
-# Browsers that we support
-last 2 Chrome versions
-last 2 Firefox versions
-last 2 Edge versions
-last 2 Safari versions
-last 2 Opera versions
-Firefox ESR
diff --git a/website/babel.config.js b/website/babel.config.js
deleted file mode 100644
index bb789e23845..00000000000
--- a/website/babel.config.js
+++ /dev/null
@@ -1,4 +0,0 @@
-module.exports = {
- presets: ['@babel/preset-env', '@babel/preset-react', '@babel/preset-flow'],
- plugins: ['@babel/plugin-proposal-class-properties'],
-};
diff --git a/website/package.json b/website/package.json
deleted file mode 100644
index 1306dea6e5b..00000000000
--- a/website/package.json
+++ /dev/null
@@ -1,37 +0,0 @@
-{
- "name": "react-docgen-website",
- "private": true,
- "description": "Website of react-docgen",
- "repository": {
- "type": "git",
- "url": "https://github.com/reactjs/react-docgen.git"
- },
- "bugs": "https://github.com/reactjs/react-docgen/issues",
- "scripts": {
- "build": "NODE_ENV=production webpack",
- "start": "webpack-dev-server --open"
- },
- "dependencies": {},
- "devDependencies": {
- "@babel/core": "^7.8.4",
- "@babel/plugin-proposal-class-properties": "^7.8.3",
- "@babel/preset-env": "^7.8.4",
- "@babel/preset-flow": "^7.8.3",
- "@babel/preset-react": "^7.8.3",
- "babel-loader": "^8.0.6",
- "codemirror": "^5.51.0",
- "css-loader": "^3.4.2",
- "html-loader": "^0.5.5",
- "html-webpack-plugin": "^3.2.0",
- "less": "^3.10.3",
- "less-loader": "^5.0.0",
- "mini-css-extract-plugin": "^0.9.0",
- "optimize-css-assets-webpack-plugin": "^5.0.3",
- "react": "^16.12.0",
- "react-dom": "^16.12.0",
- "terser-webpack-plugin": "^2.3.4",
- "webpack": "^4.41.5",
- "webpack-cli": "^3.3.10",
- "webpack-dev-server": "^3.10.3"
- }
-}
diff --git a/website/src/components/App.js b/website/src/components/App.js
deleted file mode 100644
index 843eeb8d8a8..00000000000
--- a/website/src/components/App.js
+++ /dev/null
@@ -1,150 +0,0 @@
-import React from 'react';
-import Panel from './CodeMirrorPanel';
-import Header from './Header';
-import { parse } from 'react-docgen';
-
-const codeSample = `import React, { Component } from 'react';
-import PropTypes from 'prop-types';
-
-/**
- * General component description.
- */
-class MyComponent extends Component {
- render() {
- // ...
- }
-}
-
-MyComponent.propTypes = {
- /**
- * Description of prop "foo".
- */
- foo: PropTypes.number,
- /**
- * Description of prop "bar" (a custom validation function).
- */
- bar: function(props, propName, componentName) {
- // ...
- },
- baz: PropTypes.oneOfType([
- PropTypes.number,
- PropTypes.string
- ]).isRequired,
-};
-
-MyComponent.defaultProps = {
- foo: 42,
- bar: 21
-};
-
-export default MyComponent;
-`;
-
-const defaultPlugins = [
- 'jsx',
- 'asyncGenerators',
- 'bigInt',
- 'classProperties',
- 'classPrivateProperties',
- 'classPrivateMethods',
- ['decorators', { decoratorsBeforeExport: false }],
- 'doExpressions',
- 'dynamicImport',
- 'exportDefaultFrom',
- 'exportNamespaceFrom',
- 'functionBind',
- 'functionSent',
- 'importMeta',
- 'logicalAssignment',
- 'nullishCoalescingOperator',
- 'numericSeparator',
- 'objectRestSpread',
- 'optionalCatchBinding',
- 'optionalChaining',
- ['pipelineOperator', { proposal: 'minimal' }],
- 'throwExpressions',
- 'topLevelAwait',
-];
-
-export default class App extends React.Component {
- constructor() {
- super();
- this._jsonRef = React.createRef();
-
- const options = this.buildOptions('js');
- this.state = {
- value: this.compile(codeSample, options),
- mode: 'application/json',
- content: codeSample,
- options,
- };
- }
-
- compile(value, options) {
- return JSON.stringify(parse(value, null, null, options), null, 2);
- }
-
- handleChange = value => {
- let result;
- let mode = 'text/plain';
-
- try {
- result = this.compile(value, this.state.options);
- mode = 'application/json';
- } catch (err) {
- result = String(err);
- }
- this.setState({ value: result, mode, content: value });
- };
-
- buildOptions(language) {
- const options = {
- babelrc: false,
- babelrcRoots: false,
- configFile: false,
- filename: 'playground.js',
- parserOptions: {
- plugins: [...defaultPlugins],
- },
- };
- switch (language) {
- case 'ts':
- options.parserOptions.plugins.push('typescript');
- options.filename = 'playground.tsx';
- break;
- case 'flow':
- options.parserOptions.plugins.push('flow');
- break;
- }
-
- return options;
- }
-
- handleLanguageChange = language => {
- this.setState({ options: this.buildOptions(language) }, () =>
- this.handleChange(this.state.content),
- );
- };
-
- render() {
- return (
- <>
-
-
-
- );
- }
-}
diff --git a/website/src/components/CodeMirrorPanel.js b/website/src/components/CodeMirrorPanel.js
deleted file mode 100644
index 642d83a7274..00000000000
--- a/website/src/components/CodeMirrorPanel.js
+++ /dev/null
@@ -1,90 +0,0 @@
-import React from 'react';
-import CodeMirror from 'codemirror';
-import 'codemirror/mode/javascript/javascript';
-import 'codemirror/mode/jsx/jsx';
-
-import 'codemirror/addon/fold/foldgutter';
-import 'codemirror/addon/fold/brace-fold';
-import 'codemirror/addon/fold/comment-fold';
-import 'codemirror/addon/fold/xml-fold';
-import 'codemirror/addon/fold/foldgutter.css';
-
-export default class CodeMirrorPanel extends React.Component {
- static defaultProps = {
- lineNumbers: true,
- tabSize: 2,
- showCursorWhenSelecting: true,
- autoCloseBrackets: true,
- matchBrackets: true,
- //keyMap: 'sublime',
- };
- constructor() {
- super();
- this._textareaRef = React.createRef();
- this._codeMirror = null;
- this._cached = '';
- this.handleChange = this.handleChange.bind(this);
- this.handleFocus = this.handleFocus.bind(this);
- }
-
- componentDidMount() {
- const options = Object.assign(
- {
- foldGutter: true,
- gutters: ['CodeMirror-linenumbers', 'CodeMirror-foldgutter'],
- },
- this.props,
- );
- delete options.value;
- delete options.onChange;
- delete options.codeSample;
-
- this._codeMirror = CodeMirror.fromTextArea(
- this._textareaRef.current,
- options,
- );
- this._codeMirror.on('change', this.handleChange);
- this._codeMirror.on('focus', this.handleFocus);
-
- this.updateValue(this.props.value || '');
- }
-
- componentWillUnmount() {
- this._codeMirror && this._codeMirror.toTextArea();
- }
-
- componentDidUpdate(prevProps) {
- if (this.props.value !== this._cached && this.props.value != null) {
- this.updateValue(this.props.value);
- }
- if (this.props.mode !== prevProps.mode && this.props.mode != null) {
- this._codeMirror.setOption('mode', this.props.mode);
- }
- }
-
- updateValue(value) {
- this._cached = value;
- this._codeMirror.setValue(value);
- }
-
- handleFocus(/* codeMirror, event */) {
- if (this._codeMirror.getValue() === this.props.codeSample) {
- this._codeMirror.execCommand('selectAll');
- }
- }
-
- handleChange(doc, change) {
- if (change.origin !== 'setValue') {
- this._cached = doc.getValue();
- this.props.onChange(this._cached);
- }
- }
-
- render() {
- return (
-
-
-
- );
- }
-}
diff --git a/website/src/components/Header.js b/website/src/components/Header.js
deleted file mode 100644
index 0a5ff1ee646..00000000000
--- a/website/src/components/Header.js
+++ /dev/null
@@ -1,37 +0,0 @@
-import React from 'react';
-
-export default class Header extends React.Component {
- render() {
- return (
-
-
- react-docgen: PLAYGROUND {' '}
- this.props.onLanguageChange(event.target.value)}
- >
- JavaScript
- TypeScript
- Flow
-
-
-
- View on Github
-
-
-
-
- );
- }
-}
diff --git a/website/src/index.html b/website/src/index.html
deleted file mode 100644
index 98c387b0dd8..00000000000
--- a/website/src/index.html
+++ /dev/null
@@ -1,16 +0,0 @@
-
-
- react-docgen Playground
-
-
diff --git a/website/src/index.js b/website/src/index.js
deleted file mode 100644
index b20fd07433e..00000000000
--- a/website/src/index.js
+++ /dev/null
@@ -1,8 +0,0 @@
-import React from 'react';
-import ReactDOM from 'react-dom';
-import App from './components/App';
-
-import 'codemirror/lib/codemirror.css';
-import './react-docgen.less';
-
-ReactDOM.render(