The enum value of oneOf doesn't recognize description.
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 45/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- react, typescript
調査の方向性
報告された Box コンポーネントとその PropTypes.oneOf の例から始め、生成された JSON を各 enum 値のインラインコメントと比較します。oneOf の値がどのように表現されるかを追跡し、prop レベルの説明を保持したまま、出力にそれらの説明が含まれていることを確認します。ドキュメント化された例が “row” と “column” の両方について説明を生成すれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Hi,react-docgen does't recognize description for oneOf enum value.Sometimes enum value will make people so confused.It's good to show the comment in description.
Example Component
import React, { Component } from 'react'
import PropTypes from 'prop-types'
class Box extends Component {
render() {
return <div>box</div>
}
}
Box.propTypes = {
/** 排列 */
flexDirection: PropTypes.oneOf([
/** 横向 */
'row',
/** 纵向 */
'column',
]),
}
export default Box;
Output Docgen
The comment "横向, 纵向" doesn't show in description.
{
"description": "",
"displayName": "Box",
"methods": [],
"props": {
"name": {
"flexDirection": {
"defaultValue": {
"value": "'column'",
"computed": false
},
"type": {
"name": "enum",
"value": [{
"value": "'row'",
"computed": false
}, {
"value": "'column'",
"computed": false
}]
},
"required": false,
"description": "排列"
}
}
}
}
- 主要言語
- TypeScript
- スター
- 3.8k
- フォーク
- 316
- 平均マージ
- 3時間 28分
- マージ済み PR（30日）
- 6
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
reactjs/react-docgen のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
reactjs/react-docgen#1102 ·
-
Typescript Status オープン
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
reactjs/react-docgen#1005 · リアクション 4 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 48/100
reactjs/react-docgen#997 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 42/100
reactjs/react-docgen#994 · コメント 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
reactjs/react-docgen#982 · コメント 2 件 ·
reactjs/react-docgen の issue をすべて見る
似ている issue
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
Crush オープン
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md オープン
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
ElementsProject/cln-application#167 · コメント 1 件 · リアクション 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
Quantco/pnpm-licenses#17 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100