reactjs / reactjs/react-docgen

feature request. Allow to analyze reexported components

オープン
#73 コメント 4 件 リアクション 4 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

help wanted idea
主要言語
TypeScript
スター
3.8k
フォーク
316
平均マージ
5時間 7分
マージ済み PR(30日)
4

説明

AnyComponent.jsx

import * as React from 'react';

export default class AnyComponent extends React.Component {
    anyMethod(){
       //..
    }
    render(){
       return (<div></div>)
    }
}

Test.jsx

export {AnyComponent} from './AnyComponent';
react-docgen Test.jsx
throws exception "No suitable component definition found"

But should analysis content of AnyComponent.jsx.

What do you think about it?

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

Test.jsx の再エクスポート例と AnyComponent.jsx のコンポーネント定義から始め、次に issue に示されている react-docgen コマンドを実行して例外を再現します。CLI が再エクスポートをどのように処理するかを追跡し、コンポーネントを直接解析する場合と比較します。Test.jsx が "No suitable component definition found" エラーなしで解析され、AnyComponent のドキュメントデータが公開されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
javascript, react
領域
documentation, tooling
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
38/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。