storybook 在'Docs'中缺少对具有顶级{#if}的Svelte组件的描述,

zazmityj  于 6个月前  发布在  其他
关注(0)|答案(1)|浏览(66)

描述bug

当 Svelte 组件包含顶层的 {#if ...} 时,'docs' 插件在 'Docs' 标签页中无法显示该组件的描述。请注意,这种情况只发生在 HTML 注解中的组件描述(推荐的组件文档方法)。如果描述位于 JSDoc 块中,则在 'Docs' 标签页中正确显示描述。

重现

请按照 this reproduction repo 中的安装说明进行操作。

系统

Environment Info:
  System:
    OS: macOS 11.6.7
    CPU: <removed>
  Binaries:
    Node: 16.9.1 - ~/.nvm/versions/node/v16.9.1/bin/node
    Yarn: 1.22.19 - ~/.nvm/versions/node/v17.9.1/bin/yarn
    npm: 7.21.1 - ~/.nvm/versions/node/v16.9.1/bin/npm
  Browsers:
    Chrome: 103.0.5060.134
    Firefox: 102.0.1
    Safari: 15.5
  npmPackages:
    @storybook/addon-actions: ^6.5.9 => 6.5.9
    @storybook/addon-essentials: ^6.5.9 => 6.5.9
    @storybook/addon-interactions: ^6.5.9 => 6.5.9
    @storybook/addon-links: ^6.5.9 => 6.5.9
    @storybook/addon-svelte-csf: ^2.0.4 => 2.0.4
    @storybook/svelte: ^6.5.9 => 6.5.9
    @storybook/testing-library: ^0.0.13 => 0.0.13
d5vmydt9

d5vmydt91#

我还注意到,这个问题同样适用于只包含一个 empty element 的组件,例如:

<!--
  Horizontal rule component foo bar. This description doesn't appear in 'Docs'! 
  @component
-->

<hr/>

相关问题