react-docgen generates platform specific structure

オープン

#199 2017年7月29日に作成コメント 5 件リアクション 0 件担当者 0 名 GitHub で見る

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

評価

難易度: 2/5
見積もり時間: 1〜3時間
初心者へのやさしさ: 45/100

issue の種類: バグ
明瞭さ: おおむね明確
活発さ: 停滞
技術スタック: react
領域: cli

調査の方向性

src/components と lib/metadata.json を使用する react-docgen CLI の呼び出しから始め、次にコンポーネントパスがどこでシリアライズされるかを追跡します。Windows と Linux の例を比較し、生成されるキーをプラットフォームに依存しないものにしてください。両方の環境で同じ構造が生成されることを確認します。

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

説明

needs-discussion

react-docgen --pretty -o lib/metadata.json src/components

On Windows produces:

{
  "src\\components\\ExampleComponent.react.js": {
    "description": "ExampleComponent is an example component.\r\nIt takes a single property, `label`, and\r\ndisplays it.",
    "methods": [],
    "props": {
      "label": {
        "type": {
          "name": "string"
        },
        "required": true,
        "description": "A label that will be printed when this component is rendered."
      }
    }
  }
}

On Linux produces:

{
  "src/components/ExampleComponent.react.js": {
    "description": "ExampleComponent is an example component.\r\nIt takes a single property, `label`, and\r\ndisplays it.",
    "methods": [],
    "props": {
      "label": {
        "type": {
          "name": "string"
        },
        "required": true,
        "description": "A label that will be printed when this component is rendered."
      }
    }
  }
}

This makes some scripts which use results of react-docgen for code generation fail. One example is plotly/dash component generator. Would you consider this is as a bug?

主要言語: TypeScript
スター: 3.8k
フォーク: 316
平均マージ: 3時間 28分
マージ済み PR（30日）: 6

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

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

はじめの一歩

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

reactjs/react-docgen のほかの issue

Support Babel 8 in babelParser (loadPartialConfigSync) オープン

難易度 2/5 1〜3時間初心者へのやさしさ 78/100

reactjs/react-docgen#1102 · 2026年7月14日に作成
Typescript Status オープン

難易度 5/5 1週間以上初心者へのやさしさ 20/100

reactjs/react-docgen#1005 · リアクション 4 件 · 2025年7月5日に作成
The description of extended Props is not output correctly オープン

難易度 3/5 1〜2日初心者へのやさしさ 48/100

reactjs/react-docgen#997 · 2025年5月14日に作成
Functions showing as "unknown" when encased in parentheses オープン

難易度 3/5 1〜2日初心者へのやさしさ 42/100

reactjs/react-docgen#994 · コメント 1 件 · 2025年5月1日に作成
Can't reuse Babel plugins from Storybook オープン

難易度 4/5 3〜5日初心者へのやさしさ 25/100

reactjs/react-docgen#982 · コメント 2 件 · 2025年3月30日に作成

reactjs/react-docgen の issue をすべて見る

似ている issue

False positive: TurkScan.com / TurkChain network オープン

blocklist removal

難易度 2/5 1〜3時間初心者へのやさしさ 65/100

MetaMask/eth-phishing-detect#296544 · 2026年9月23日に作成
Package recommendation for React inline SVG loaders オープン

難易度 2/5 1〜3時間初心者へのやさしさ 70/100

pastelsky/bundlephobia#1122 · 2026年9月23日に作成
[Dashboard] Prevent opening the upstream list when its limit is off オープン

難易度 2/5 1〜3時間初心者へのやさしさ 70/100

Menci/Floway#533 · 2026年9月23日に作成
save-artifact's isSameFile overwrite guard has no hard-link witness (follow-up from #11848) オープン

category/development priority/P2 scope/file-operations scope/testing type/enhancement

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

QwenLM/qwen-code#12578 · コメント 3 件 · 2026年9月23日に作成
Enatega Customer and Rider app: Add-ons price is not visible to customer after order is placed. オープン

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

Margaret-Petersen/grocery-delivery-app-for-ios#1334 · 2026年9月23日に作成

TypeScript の issue をもっと見る