Skip to content

Add VoidPattern #1009

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.

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

Merged
merged 1 commit into from
Jul 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/brave-cases-obey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'react-docgen': patch
---

Do not fail on new VoidPattern type
10 changes: 5 additions & 5 deletions packages/react-docgen/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@
],
"license": "MIT",
"dependencies": {
"@babel/core": "^7.18.9",
"@babel/traverse": "^7.18.9",
"@babel/types": "^7.18.9",
"@types/babel__core": "^7.18.0",
"@types/babel__traverse": "^7.18.0",
"@babel/core": "^7.28.0",
"@babel/traverse": "^7.28.0",
"@babel/types": "^7.28.2",
"@types/babel__core": "^7.20.5",
"@types/babel__traverse": "^7.20.7",
"@types/doctrine": "^0.0.9",
"@types/resolve": "^1.20.2",
"doctrine": "^3.0.0",
Expand Down
23 changes: 6 additions & 17 deletions packages/react-docgen/src/utils/getParameterName.ts
Original file line number Diff line number Diff line change
@@ -1,22 +1,8 @@
import type { NodePath } from '@babel/traverse';
import type {
ArrayPattern,
AssignmentPattern,
Identifier,
ObjectPattern,
RestElement,
TSParameterProperty,
} from '@babel/types';
import type { FunctionParameter, TSParameterProperty } from '@babel/types';
import printValue from './printValue.js';

type ParameterNodePath = NodePath<
| ArrayPattern
| AssignmentPattern
| Identifier
| ObjectPattern
| RestElement
| TSParameterProperty
>;
type ParameterNodePath = NodePath<FunctionParameter | TSParameterProperty>;

export default function getParameterName(
parameterPath: ParameterNodePath,
Expand All @@ -36,10 +22,13 @@ export default function getParameterName(
)}`;
} else if (parameterPath.isTSParameterProperty()) {
return getParameterName(parameterPath.get('parameter'));
// @ts-expect-error isVoidPattern is not yet in types
} else if (parameterPath.isVoidPattern()) {
return 'void';
}

throw new TypeError(
'Parameter name must be one of Identifier, AssignmentPattern, ArrayPattern, ' +
`ObjectPattern or RestElement, instead got ${parameterPath.node.type}`,
`ObjectPattern, RestElement, or VoidPattern instead got ${parameterPath.node.type}`,
);
}
135 changes: 82 additions & 53 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading