reactjs / reactjs/react-docgen

Component that returns an array is not recognised

Offen
#365 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

component-detection
Vorherrschende Sprache
TypeScript
Sterne
3.8k
Forks
316
Ø Merge
5 Std. 7 Min.
Gemergte PRs (30 T.)
4

Beschreibung

Current behavior

Components that return an array lead to the following error (via react-styleguidist):

Warning: some/folder/index.jsx matches a pattern defined in “components” or “sections” options in your style guide config but doesn’t export a component.

It usually happens when using third-party libraries, see possible solutions here: https://react-styleguidist.js.org/docs/thirdparties.html

To reproduce

/**
 * @param {Props} props props
 * @property {Array.<Etcetera>} etc
 * @returns {React.Node} ...
 */
const Contents = ({ contents }: Props) =>
	contents.map(data => {
		switch (data.__typename) {
			case 'Something':
				return (
					<Something children={data.children} key={data.id} />
				)
		}
	})

Expected behavior

No warning

Originally posted here

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Die Reproduktion ist in some/folder/index.jsx dargestellt und tritt durch die react-styleguidist-Integration auf; beginne damit nachzuverfolgen, wie Komponenten erkannt werden, die Arrays zurückgeben. Füge einen Regressionstestfall für diese Komponentenform hinzu und verifiziere, dass keine Warnung über eine fehlende Komponente ausgegeben wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
react, typescript
Bereich
documentation, tooling
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.