storybook 使用TypeScript从Svelte组件自动生成文档表格

qacovj5a  于 3个月前  发布在  TypeScript
关注(0)|答案(3)|浏览(27)

您的功能请求是否与问题相关?请描述

文档插件不能直接从TypeScript获取类型。我不得不用TypeScript描述我的变量/函数,但必须再次用docstring描述。

描述您希望实现的解决方案

我希望文档插件能够从docstring和TypeScript中推断出类型

描述您考虑过的替代方案
您是否能协助将该功能变为现实?

也许可以。我查看了代码,似乎用于storybook sveltedoc-parser的库没有支持分析TypeScript的功能:alexprey/sveltedoc-parser#34

附加上下文

示例:

  1. 使用Svelte和TS创建一个应用,并添加storybook
  2. 将以下代码添加到 main.js
svelteOptions: {
    preprocess: sveltePreprocess(),
  },
  1. 如果我们更改Button.svelte(并将脚本语言设置为'ts'):

  1. 这将生成以下文档表格:

  1. 但如果我们更改Button.svelte以具有docstring:

  1. 这将生成:

vsikbqxv

vsikbqxv1#

sveltedoc-parser包中支持TypeScript的工作

wz8daaqr

wz8daaqr2#

大家好!最近似乎没有太多关于这个问题的进展。如果还有问题、评论或错误,请随时继续讨论。遗憾的是,我们没有时间处理每一个问题。我们始终欢迎贡献,所以如果你想帮忙,请发送一个pull request。30天后未活跃的问题将被关闭。谢谢!

uz75evzq

uz75evzq3#

我也有同样的问题,你找到解决方案了吗?

相关问题