Using `Readonly<T>` utility type results in losing pieces of `T`'s information
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 45/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- typescript
- 领域
- tooling
调研方向
使用两个组件示例在链接的 playground 中重现该问题，并比较 Props 和 Readonly 的提取结果。当 Readonly 的结果保留 Props 中显示的 prop 描述和 tsType 信息时，修复即完成。
由索引模型根据 Issue 内容生成。
描述
You can paste the code below in the playground and see that description and tsType are lost.
interface Props {
/** The name to greet */
name: string
}
/**
* Hello world component
*/
const MyComponent = ({name = 'world'}: Props) => {
return <div />;
}
/**
* Hello world Readonly
*/
const MyReadonlyPropsComponent = ({name = 'world'}: Readonly<Props>)=> {
return <div />;
}
I noticed this behaviour while digging through an issue that appeared after the latest Storybook's major update, which uses this package by default to extract information from the components.
- 主要语言
- TypeScript
- 星标
- 3.8k
- 派生
- 316
- 平均合并
- 2 小时 29 分钟
- 30 天内合并 PR
- 5
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
reactjs/react-docgen 的其他 Issue
-
Support Babel 8 in babelParser (loadPartialConfigSync)可能已有人在做 @Stanzilla 于 83 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
reactjs/react-docgen#1102 ·
-
难度 5/5 一周以上 新手友好度 20/100
reactjs/react-docgen#1005 · 4 个 reaction ·
-
难度 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
-
level/task reporter/qa type/bug
难度 2/5 1-3 小时 新手友好度 85/100
wazuh/wazuh-dashboard-plugins#9310 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 75/100
cybersemics/treecrdt#267 ·
-
难度 1/5 1-3 小时 新手友好度 85/100
wiz-sec-public/backstage-plugin-wiz#16 · 1 条评论 ·
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
-
难度 2/5 1-3 小时 新手友好度 72/100
solana-foundation/solana-com#2245 ·
维护者通常 1 天内回复