react-docgen
生成的文档与 react-docgen-typescript
不同且不完整;一旦 #24165 落地,Storybook 生成的默认文档对于使用 TypeScript 路径别名和枚举的 TypeScript 用户将显著地“糟糕”。
编辑(@valentinpalkovic):
- Storybook 在与
react-docgen
一起使用时添加了 TypeScript 路径别名支持。 - 最初由 @csantos1113 在 #24165(评论)中发布。
要重现
- 转到 https://stackblitz.com/edit/github-aca5uv-867pnb (注意:路径别名现已支持)
- 备注:
- 此示例使用了相当常见的 typescript 路径别名。
- 它还使用
vite-tsconfig-paths
在 vite 中解析这些路径。 - 它使用
react-docgen
(一旦 React: Setreact-docgen
to default TS docgen #24165 合并,8.0 版本中将成为默认值) - ⚠️ 注意:
- 文档显示为“未知”
- “控件”损坏
- 属性文档丢失
- 必需的属性丢失
- 备注:
- 此示例 不 使用 typescript 路径别名。它只是相对导入。
- 它使用
react-docgen
(一旦 React: Setreact-docgen
to default TS docgen #24165 合并,8.0 版本中将成为默认值) - ⚠️ 注意:
- 文档出现
- 必需的属性出现
- “控件”对于枚举值仍然损坏
- 备注:
- 此示例与 第 1 个示例 具有路径别名和
vite-tsconfig-paths
,但它使用react-docgen-typescript
而不是。 - 😍 注意:
- 文档出现
- 必需的属性出现
- “控件”对于所有类型甚至枚举值都正常工作
4条答案
按热度按时间ki1q1bka1#
如果我们能在
react-docgen
解析器中支持webpack和vite的tsconfig路径,那将是非常棒的。WDYT?gev0vcfq2#
与reactjs/react-docgen#456相关。
@shilman 我们确实可以尝试提供一个自定义导入器,它处理路径别名,或者有人/我们直接为react-docgen做出贡献。
w46czmvw3#
至少在Storybook中,通过调整react-docgen的默认解析器,将reactjs/react-docgen#456设置为fixed。它将成为下一个8.0.0-rc.2预发布版本的一部分!
d6kp6zgx4#
react-docgen似乎在我的环境中也无法正常工作:
我不确定这是否类似于reactjs/react-docgen#456的问题或其他问题。