Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for forwardRef<generics> #923

Merged
merged 8 commits into from
Aug 31, 2024
Merged

Add support for forwardRef<generics> #923

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f2176a8
Add support for generic types on forwardRef
rvetere May 27, 2024
9bb0a54
Reset file
rvetere May 27, 2024
45b9a89
Merge branch 'main' into feature/forward-ref-generics
rvetere May 27, 2024
165715d
Add new test
rvetere May 28, 2024
644b49e
Merge branch 'main' into feature/forward-ref-generics
rvetere May 28, 2024
3cf7bde
Simplify code, better types
danez Aug 31, 2024
bb1a9af
Add test to verify it does not randomly find types on non forwardRef
danez Aug 31, 2024
a763a90
Add changeset
danez Aug 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add new test
  • Loading branch information
@rvetere
rvetere committed May 28, 2024
commit 165715d4ab25c79865a90b6500c02cb4cc7faaeb
12 changes: 12 additions & 0 deletions ...ges/react-docgen/src/utils/__tests__/__snapshots__/getTypeFromReactComponent-test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,18 @@ exports[`getTypeFromReactComponent > TypeScript > classes > finds props type in
]
`;

exports[`getTypeFromReactComponent > TypeScript > stateless > finds generic forwardRef type annotation 1`] = `
[
Node {
"type": "TSTypeReference",
"typeName": Node {
"name": "Props",
"type": "Identifier",
},
},
]
`;

exports[`getTypeFromReactComponent > TypeScript > stateless > finds multiple variable type annotation 1`] = `
[
Node {
Expand Down
12 changes: 12 additions & 0 deletions packages/react-docgen/src/utils/__tests__/getTypeFromReactComponent-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,18 @@ describe('getTypeFromReactComponent', () => {
expect(getTypeFromReactComponent(path)).toMatchSnapshot();
});

test('finds generic forwardRef type annotation', () => {
const path = parseTypescript
.statementLast<VariableDeclaration>(
`import React from 'react';
const x = React.forwardRef<HTMLDivElement, React.PropsWithChildren<Props>>((props, ref) => {})`,
)
.get('declarations')[0]
.get('init') as NodePath<ArrowFunctionExpression>;

expect(getTypeFromReactComponent(path)).toMatchSnapshot();
});

test('finds param inline type', () => {
const path = parseTypescript
.statementLast<VariableDeclaration>(
Expand Down