Demonstration of description

[xeho91]

Issues

1. JSDoc meta descriptions are lost with lang="ts". [Bug] JSDoc description disappears with lang="ts" addon-svelte-csf#175
2. Encountered issue with setting the description in the Svelte CSF format, above the export const meta.
3. In the Svelte CSF format, setting explicitly the description inside the <Story /> component via parameter prop doesn't work, nor override the comment.
4. In the current version of @storybook/addon-svelte-csf <Story> and <Template /> component, it doesn't have typings for tags prop, so the TypeScript will complain - which is unrelated to the subject of this demonstration.
5. Might need to wait for Tags: Add project tags, negation, dev/autodocs/test system tags storybook#26634 to be released, so we can improve the examples showcase for this case.

[xeho91]

FYI.

Regarding the issue 1. and 3., I have solved them while I was working on the experimental support for Svelte v5 (on @storybook/addon-svelte-csf). I had to refactor the parser.

[JReinhold]

Thank you! ❤️

Added some very minor comments

Encountered issue with setting the description in the Svelte CSF format, above the export const meta

Could you elaborate on this?

In the Svelte CSF format, setting explicitly the description inside the component via parameter prop doesn't work, nor override the comment.

Great find! Sounds like a regular bug.

In the current version of @storybook/addon-svelte-csf <Story> and <Template /> component, it doesn't have typings for tags prop, so the TypeScript will complain - which is unrelated to the subject of this demonstration.

Thanks!

Might need to wait for storybookjs/storybook#26634 to be released, so we can improve the examples showcase for this case.

This is already in the 8.1.0 beta which we're using in this repo, so it should be fine.

[xeho91]

Encountered issue with setting the description in the Svelte CSF format, above the export const meta

Could you elaborate on this?

What I recall from refactoring the parser in @storybook/addon-svelte-csf, there was a small issue with not being able to read the leading comment while using lang=ts. I don't remember the exact reason of what caused it, but I think it was execution order with preprocess at compile. I can take a look at it tomorrow.