Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
react-docgen-displayname-handler
Advanced tools
A handler for react-docgen that tries to infer the displayName of a component
Weekly downloads
Readme
A handler for react-docgen that tries to infer the displayName of a component.
react-docgen is a CLI and API toolbox to help extract information from React components and generate documentation from it.
react-docgen-displayname-handler
is a custom handler for react-docgen
and can be
used to infer the displayName for a given component.
The handler tries to infer the displayName from the following sources:
displayName
property on the object / classUnknownComponent
Install react-docgen-displayname-handler
from npm
npm install --save react-docgen-displayname-handler
Unfortunately there is currently no easy way to use custom handlers with the react-docgen CLI.
Discussions and Ideas about how to make this easier are happening in the react-docgen issue discussions.
If you want to use this module programmatically check out the react-docgen API docs for more information about
the react-docgen
API.
Below is a small example that demonstrates how to
integrate react-docgen-displayname-handler
.
import reactDocs from 'react-docgen';
import displayNameHandler from 'react-docgen-displayname-handler';
const resolver = reactDocs.resolver.findExportedComponentDefinition;
const handlers = reactDocs.handlers.concat(displayNameHandler);
const documentation = reactDocs.parse(src, resolver, handlers);
If you want to use the filepath for displayName resolution too, check out the following example:
import reactDocs from 'react-docgen';
import { createDisplayNameHandler } from 'react-docgen-displayname-handler';
const resolver = reactDocs.resolver.findExportedComponentDefinition;
const handlers = reactDocs.handlers.concat(createDisplayNameHandler(filePath));
const documentation = reactDocs.parse(src, resolver, handlers);
In order to use the file path too, you need to import the named export
createDisplayNameHandler
which takes as an argument the file path and returns
a handler function that can be passed to react-docgen.
When using this custom handler with react-docgen
it will try to find the
displayName of the component as outlined above.
import React from 'react';
export default class X extends React.Component {
static displayName = 'MyComponent';
render() {
return <div />;
}
}
{
"displayName": "MyComponent",
"props": {...}
}
import React from 'react';
export default class MyComponent extends React.Component {
render() {
return <div />;
}
}
{
"displayName": "MyComponent",
"props": {...}
}
For more information about the data format see the react-docgen readme
FAQs
A handler for react-docgen that tries to infer the displayName of a component
The npm package react-docgen-displayname-handler receives a total of 55,799 weekly downloads. As such, react-docgen-displayname-handler popularity was classified as popular.
We found that react-docgen-displayname-handler demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.