fix: Temporarily disable save from UI feature

[xeho91]

Resolves #240

[xeho91]

I wonder if we should also create a separate issue to restore this feature in the future. Whenever it is feasible to do so.

I mean, the part where Storybook addons are able to control/override what is being inserted into the original code of the stories file(s). This would need exploration on the Storybook core internals.

[JReinhold]

Nice! I think we can simplify it. Parameters don't have to be statically analysable (and they can't be, because they're very dynamic), so maybe we should be able to get away with this by just setting the parameter at runtime here: https://github.com/storybookjs/addon-svelte-csf/blob/next/src/runtime/create-runtime-stories.ts#L51

Which seems a lot simpler to me than the current AST-based approach?

(I know this context is a little late to give now, sorry 🙇)

I'm fine with the refactor you did to the AST parsing for the parameters/description though, if you still want to keep that around.

I wonder if we should also create a separate issue to restore this feature in the future. Whenever it is feasible to do so.

Yes we can do that.

[xeho91]

Nice! I think we can simplify it. Parameters don't have to be statically analysable (and they can't be, because they're very dynamic), so maybe we should be able to get away with this by just setting the parameter at runtime here: https://github.com/storybookjs/addon-svelte-csf/blob/next/src/runtime/create-runtime-stories.ts#L51

Hm, I haven't though of that 🤔.
I'm a little puzzled by what you meant that parameters (I think we're talking about both in defineMeta and <Story>) are very dynamic?
In my mind, I'm stuck at example with inserting description either from JSDoc comment above defineMeta or HTML comment above every <Story />. I don't know if that's just one unique case.

(I know this context is a little late to give now, sorry 🙇)

No worries ❤️!
I should've communicated firstly how I planned to solve this solution. It seems like I got too comfortable solving through AST transformation, which can lead to overcomplicating 😆

[JReinhold]

I'm a little puzzled by what you meant that parameters (I think we're talking about both in defineMeta and <Story>) are very dynamic? In my mind, I'm stuck at example with inserting description either from JSDoc comment above defineMeta or HTML comment above every <Story />. I don't know if that's just one unique case.

By parameters I mean parameters that you can set on either meta or story. They can be anything, users are free to set whatever they want, and however they want - such as functions that calls other stuff or imports variables. The point is, they are so dynamic that Storybook will most likely never try to statically analyse them for whatever reason (that's actually why we introduced tags, a statically analysable version of parameters).

My point is, that there is no need to set the parameter directly in the source using AST, it's totally fine to do it at runtime, which I'd expect to be simpler here.

The problem with the description is that to get the description from the comments, you have to do static analysis with the AST, but when you have that information you don't need to set parameters.docs.description statically, it's fine to set it at runtime. But in this specific case with the description, given you're already doing AST stuff to read it, it might just be easier to also set it with the AST - that's up to you.

Am I making any sense? 😅

[xeho91]

@JReinhold

Am I making any sense? 😅

Yes, thank you!

I've pushed the latest commit, with mutating meta inside the createRuntimeStories. However, I think the only way I can test it is manually.
I've noticed that neither AST solution, nor mutating at runtime works. I've used pnpm install to make sure my dependencies are up to date.

I also tried manually adding parameters.disableSaveFromUI: true to defineMeta, as well <Story parameters={{ disableSaveFromUI: true }} />.

I'm missing something, do you see it?

[JReinhold]

Haha, it's really subtle in the docs, but it's actually parameters.controls.disableSaveFromUI 😅

https://storybook.js.org/docs/essentials/controls#parameters-1
https://storybook.js.org/docs/essentials/controls#disable-creating-and-editing-of-stories