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.

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

Using private fields in components breaks getNameOrValue #980

Open
pvdstel opened this issue Mar 24, 2025 · 0 comments
Open

Using private fields in components breaks getNameOrValue #980

pvdstel opened this issue Mar 24, 2025 · 0 comments

Comments

@pvdstel
Copy link

pvdstel commented Mar 24, 2025

The utility function getNameOrValue breaks when a private name is used in a class component.

I encountered this while using Storybook, as it uses this package to generate documentation.

Related issues: #921 (still open), #346 (resolved, but this appears to be a different issue).

I would create a PR to resolve this, but I'm not sure what the best way forward is. Please let me know if you need more information! 😄

Stack trace:

[storybook:react-docgen-plugin] Argument must be Identifier, Literal, QualifiedTypeIdentifier or TSQualifiedName. Received 'PrivateName'
file: [redacted].tsx
    at getNameOrValue ([project]/node_modules/react-docgen/dist/utils/getNameOrValue.js:24:11)
    at Object.enter ([project]/node_modules/react-docgen/dist/utils/getMemberExpressionValuePath.js:61:17)
    at NodePath._call ([project]\node_modules\@babel\traverse\lib\path\context.js:49:20)
    at NodePath.call ([project]\node_modules\@babel\traverse\lib\path\context.js:39:18)
    at NodePath.visit ([project]\node_modules\@babel\traverse\lib\path\context.js:88:31)
    at TraversalContext.visitQueue ([project]\node_modules\@babel\traverse\lib\context.js:90:16)
    at TraversalContext.visitSingle ([project]\node_modules\@babel\traverse\lib\context.js:66:19)
    at TraversalContext.visit ([project]\node_modules\@babel\traverse\lib\context.js:113:19)
    at traverseNode ([project]\node_modules\@babel\traverse\lib\traverse-node.js:22:17)
    at NodePath.visit ([project]\node_modules\@babel\traverse\lib\path\context.js:94:52)
    at TraversalContext.visitQueue ([project]\node_modules\@babel\traverse\lib\context.js:90:16)
    at TraversalContext.visitMultiple ([project]\node_modules\@babel\traverse\lib\context.js:62:17)
    at TraversalContext.visit ([project]\node_modules\@babel\traverse\lib\context.js:111:19)
    at traverseNode ([project]\node_modules\@babel\traverse\lib\traverse-node.js:22:17)
    at NodePath.visit ([project]\node_modules\@babel\traverse\lib\path\context.js:94:52)
    at TraversalContext.visitQueue ([project]\node_modules\@babel\traverse\lib\context.js:90:16)
    at TraversalContext.visitSingle ([project]\node_modules\@babel\traverse\lib\context.js:66:19)
    at TraversalContext.visit ([project]\node_modules\@babel\traverse\lib\context.js:113:19)
    at traverseNode ([project]\node_modules\@babel\traverse\lib\traverse-node.js:22:17)
    at NodePath.visit ([project]\node_modules\@babel\traverse\lib\path\context.js:94:52)
    at TraversalContext.visitQueue ([project]\node_modules\@babel\traverse\lib\context.js:90:16)
    at TraversalContext.visitMultiple ([project]\node_modules\@babel\traverse\lib\context.js:62:17)
    at TraversalContext.visit ([project]\node_modules\@babel\traverse\lib\context.js:111:19)
    at traverseNode ([project]\node_modules\@babel\traverse\lib\traverse-node.js:22:17)
    at NodePath.visit ([project]\node_modules\@babel\traverse\lib\path\context.js:94:52)
    at TraversalContext.visitQueue ([project]\node_modules\@babel\traverse\lib\context.js:90:16)
    at TraversalContext.visitSingle ([project]\node_modules\@babel\traverse\lib\context.js:66:19)
    at TraversalContext.visit ([project]\node_modules\@babel\traverse\lib\context.js:113:19)
    at traverseNode ([project]\node_modules\@babel\traverse\lib\traverse-node.js:22:17)
    at NodePath.visit ([project]\node_modules\@babel\traverse\lib\path\context.js:94:52)
    at TraversalContext.visitQueue ([project]\node_modules\@babel\traverse\lib\context.js:90:16)
    at TraversalContext.visitSingle ([project]\node_modules\@babel\traverse\lib\context.js:66:19)
    at TraversalContext.visit ([project]\node_modules\@babel\traverse\lib\context.js:113:19)
    at traverseNode ([project]\node_modules\@babel\traverse\lib\traverse-node.js:22:17)
    at NodePath.visit ([project]\node_modules\@babel\traverse\lib\path\context.js:94:52)
    at TraversalContext.visitQueue ([project]\node_modules\@babel\traverse\lib\context.js:90:16)
    at TraversalContext.visitMultiple ([project]\node_modules\@babel\traverse\lib\context.js:62:17)
    at TraversalContext.visit ([project]\node_modules\@babel\traverse\lib\context.js:111:19)
    at traverseNode ([project]\node_modules\@babel\traverse\lib\traverse-node.js:22:17)
    at NodePath.visit ([project]\node_modules\@babel\traverse\lib\path\context.js:94:52)
    at TraversalContext.visitQueue ([project]\node_modules\@babel\traverse\lib\context.js:90:16)
    at TraversalContext.visitSingle ([project]\node_modules\@babel\traverse\lib\context.js:66:19)
    at TraversalContext.visit ([project]\node_modules\@babel\traverse\lib\context.js:113:19)
    at traverseNode ([project]\node_modules\@babel\traverse\lib\traverse-node.js:22:17)
    at traverse ([project]\node_modules\@babel\traverse\lib\index.js:53:34)
    at FileState.traverse ([project]/node_modules/react-docgen/dist/FileState.js:73:9)
    at getMemberExpressionValuePath ([project]/node_modules/react-docgen/dist/utils/getMemberExpressionVa…
    at getMemberValuePath ([project]/node_modules/react-docgen/dist/utils/getMemberValuePath.js:75:18)
    at [project]/node_modules/react-docgen/dist/handlers/propTypeHandler.js:47:29
    at [project]/node_modules/react-docgen/dist/parse.js:10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant