reactjs / reactjs/react-docgen
react-docgen is not compatible with react-like libraries
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 3.8k
- Forks
- 316
- Ø Merge
- 5 Std. 7 Min.
- Gemergte PRs (30 T.)
- 4
Beschreibung
There are some react-like libraries such as react-lite, preact-compat and other which use API of React for components including PropTypes. All react-docgen methods work well with these libraries. But [this module](react-docgen disables work with react-like libraries) disallows using it.
I have a preact-compat component:
import { h, Component, PropTypes } from 'preact-compat';
export default class MyComponent extends Component {
render() {
return <div>{this.props.children}</div>;
}
}
MyComponent.propTypes = {
myProp: PropTypes.func
};
Actual react-docgen returns this value for type of myProp:
{
name: 'custom',
raw: 'PropTypes.func'
}
If I add preact-compat to whitelist react-docgen returns expected result:
{
type: 'func'
}
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, das Modul zu finden, das React-ähnliche Bibliotheken mithilfe einer Whitelist einschränkt, und reproduziere dann das Problem mit der bereitgestellten preact-compat-Komponente. Überprüfe das bestehende Verhalten für PropTypes.func und vergleiche es mit der erwarteten Ausgabe; abgeschlossen ist die Aufgabe, wenn React-ähnliche Bibliotheken dieselben Typinformationen liefern, ohne explizit auf der Whitelist zu stehen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- react, typescript
- Bereich
- documentation, tooling
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100