From 11e078dca9375861df104da7d1e0bee5f2c74408 Mon Sep 17 00:00:00 2001 From: Jon Palmer <328224+jonspalmer@users.noreply.github.com> Date: Sun, 18 Jul 2021 10:38:31 -0400 Subject: [PATCH] Support more options for CSF autoTitle --- app/server/README.md | 13 +++++++------ .../src/lib/compiler/__testfixtures__/a11y.snapshot | 2 +- .../lib/compiler/__testfixtures__/actions.snapshot | 2 +- .../compiler/__testfixtures__/backgrounds.snapshot | 2 +- .../lib/compiler/__testfixtures__/controls.snapshot | 2 +- .../compiler/__testfixtures__/kitchen_sink.snapshot | 4 ++-- .../lib/compiler/__testfixtures__/links.snapshot | 2 +- .../__testfixtures__/multiple_stories.snapshot | 6 +++--- .../lib/compiler/__testfixtures__/params.snapshot | 2 +- .../__testfixtures__/params_override.snapshot | 2 +- .../src/lib/compiler/__testfixtures__/yaml.snapshot | 6 +++--- .../src/lib/compiler/__testfixtures__/yml.snapshot | 6 +++--- app/server/src/lib/compiler/stringifier.ts | 2 +- examples/server-kitchen-sink/.storybook/main.js | 2 +- .../a11y.stories.json} | 1 - .../actions.stories.json} | 1 - .../backgrounds.stories.json} | 1 - .../controls.stories.json} | 1 - .../server-kitchen-sink/stories/demo.stories.json | 1 - .../stories/{ => html_content}/scripts.stories.json | 1 - .../stories/{ => html_content}/styles.stories.json | 1 - .../stories/kitchen_sink.stories.json | 1 - .../server-kitchen-sink/stories/params.stories.json | 1 - .../stories/welcome.stories.json | 1 - .../server-kitchen-sink/stories/yaml.stories.yaml | 1 - .../server-kitchen-sink/stories/yml.stories.yml | 1 - 26 files changed, 27 insertions(+), 38 deletions(-) rename examples/server-kitchen-sink/stories/{addon-a11y.stories.json => addons/a11y.stories.json} (96%) rename examples/server-kitchen-sink/stories/{addon-actions.stories.json => addons/actions.stories.json} (97%) rename examples/server-kitchen-sink/stories/{addon-backgrounds.stories.json => addons/backgrounds.stories.json} (93%) rename examples/server-kitchen-sink/stories/{addon-controls.stories.json => addons/controls.stories.json} (97%) rename examples/server-kitchen-sink/stories/{ => html_content}/scripts.stories.json (93%) rename examples/server-kitchen-sink/stories/{ => html_content}/styles.stories.json (93%) diff --git a/app/server/README.md b/app/server/README.md index f8586b4fd7fc..4e550a96f05d 100644 --- a/app/server/README.md +++ b/app/server/README.md @@ -62,7 +62,7 @@ module.exports = { Notice that the JSON does not specify a rendering function -- `@storybook/server` will instead call your `parameters.server.url` with the story's server id appended. -For example the JSON story above is requivalent to the CSF definition: +For example the JSON story above is requivalent to the CSF3 definition: ```javascript export default { @@ -74,11 +74,12 @@ export default { }, }; -export const Default = (args) => {}; -Default.storyName = 'Default'; -Default.parameters = { - server: { - id: 'path/of/your/story"', +export const Default = { + name: 'Default', + parameters: { + server: { + id: 'path/of/your/story"', + }, }, }; ``` diff --git a/app/server/src/lib/compiler/__testfixtures__/a11y.snapshot b/app/server/src/lib/compiler/__testfixtures__/a11y.snapshot index 54908c44652b..0057e3dd70c4 100644 --- a/app/server/src/lib/compiler/__testfixtures__/a11y.snapshot +++ b/app/server/src/lib/compiler/__testfixtures__/a11y.snapshot @@ -12,7 +12,7 @@ export default { }; export const Label = { - storyName: \\"Label\\", + name: \\"Label\\", parameters: { server: { id: \\"addons/a11y/label\\" diff --git a/app/server/src/lib/compiler/__testfixtures__/actions.snapshot b/app/server/src/lib/compiler/__testfixtures__/actions.snapshot index 9c081dc4f235..b2f7434f4b0b 100644 --- a/app/server/src/lib/compiler/__testfixtures__/actions.snapshot +++ b/app/server/src/lib/compiler/__testfixtures__/actions.snapshot @@ -12,7 +12,7 @@ export default { }; export const Multiple_actions_config = { - storyName: \\"Multiple actions + config\\", + name: \\"Multiple actions + config\\", parameters: { actions: [ \\"click\\", diff --git a/app/server/src/lib/compiler/__testfixtures__/backgrounds.snapshot b/app/server/src/lib/compiler/__testfixtures__/backgrounds.snapshot index c12b0e1730df..12bac06c25cb 100644 --- a/app/server/src/lib/compiler/__testfixtures__/backgrounds.snapshot +++ b/app/server/src/lib/compiler/__testfixtures__/backgrounds.snapshot @@ -20,7 +20,7 @@ export default { }; export const Story_1 = { - storyName: \\"Story 1\\", + name: \\"Story 1\\", parameters: { server: { id: \\"addons/backgrounds/story1\\" diff --git a/app/server/src/lib/compiler/__testfixtures__/controls.snapshot b/app/server/src/lib/compiler/__testfixtures__/controls.snapshot index f899d3f23b6c..ccbda5cd711c 100644 --- a/app/server/src/lib/compiler/__testfixtures__/controls.snapshot +++ b/app/server/src/lib/compiler/__testfixtures__/controls.snapshot @@ -12,7 +12,7 @@ export default { }; export const Simple = { - storyName: \\"Simple\\", + name: \\"Simple\\", parameters: { server: { id: \\"addons/controls/simple\\" diff --git a/app/server/src/lib/compiler/__testfixtures__/kitchen_sink.snapshot b/app/server/src/lib/compiler/__testfixtures__/kitchen_sink.snapshot index d816163078ed..14b34271465e 100644 --- a/app/server/src/lib/compiler/__testfixtures__/kitchen_sink.snapshot +++ b/app/server/src/lib/compiler/__testfixtures__/kitchen_sink.snapshot @@ -28,7 +28,7 @@ export default { }; export const Heading = { - storyName: \\"Heading\\", + name: \\"Heading\\", parameters: { actions: [ \\"click\\", @@ -51,7 +51,7 @@ export const Heading = { }; export const Button = { - storyName: \\"Button\\", + name: \\"Button\\", parameters: { server: { id: \\"demo/button\\" diff --git a/app/server/src/lib/compiler/__testfixtures__/links.snapshot b/app/server/src/lib/compiler/__testfixtures__/links.snapshot index 4ffbaed697d2..9c269a837cf1 100644 --- a/app/server/src/lib/compiler/__testfixtures__/links.snapshot +++ b/app/server/src/lib/compiler/__testfixtures__/links.snapshot @@ -7,7 +7,7 @@ export default { }; export const Welcome = { - storyName: \\"Welcome\\", + name: \\"Welcome\\", parameters: { server: { id: \\"welcome/welcome\\" diff --git a/app/server/src/lib/compiler/__testfixtures__/multiple_stories.snapshot b/app/server/src/lib/compiler/__testfixtures__/multiple_stories.snapshot index b34b568d0b0f..756da4e91ab6 100644 --- a/app/server/src/lib/compiler/__testfixtures__/multiple_stories.snapshot +++ b/app/server/src/lib/compiler/__testfixtures__/multiple_stories.snapshot @@ -7,7 +7,7 @@ export default { }; export const Heading = { - storyName: \\"Heading\\", + name: \\"Heading\\", parameters: { server: { id: \\"demo/heading\\" @@ -16,7 +16,7 @@ export const Heading = { }; export const Headings = { - storyName: \\"Headings\\", + name: \\"Headings\\", parameters: { server: { id: \\"demo/headings\\" @@ -25,7 +25,7 @@ export const Headings = { }; export const Button = { - storyName: \\"Button\\", + name: \\"Button\\", parameters: { server: { id: \\"demo/button\\" diff --git a/app/server/src/lib/compiler/__testfixtures__/params.snapshot b/app/server/src/lib/compiler/__testfixtures__/params.snapshot index 012d0cfd1f3e..1423ce39b9c5 100644 --- a/app/server/src/lib/compiler/__testfixtures__/params.snapshot +++ b/app/server/src/lib/compiler/__testfixtures__/params.snapshot @@ -14,7 +14,7 @@ export default { }; export const Story = { - storyName: \\"Story\\", + name: \\"Story\\", parameters: { server: { id: \\"params/story\\", diff --git a/app/server/src/lib/compiler/__testfixtures__/params_override.snapshot b/app/server/src/lib/compiler/__testfixtures__/params_override.snapshot index 04696635cdbd..11a59bd1b516 100644 --- a/app/server/src/lib/compiler/__testfixtures__/params_override.snapshot +++ b/app/server/src/lib/compiler/__testfixtures__/params_override.snapshot @@ -14,7 +14,7 @@ export default { }; export const Override = { - storyName: \\"Override\\", + name: \\"Override\\", parameters: { server: { id: \\"params/override\\", diff --git a/app/server/src/lib/compiler/__testfixtures__/yaml.snapshot b/app/server/src/lib/compiler/__testfixtures__/yaml.snapshot index 0f4503d33c23..cde9cda3d0bc 100644 --- a/app/server/src/lib/compiler/__testfixtures__/yaml.snapshot +++ b/app/server/src/lib/compiler/__testfixtures__/yaml.snapshot @@ -7,7 +7,7 @@ export default { }; export const Heading = { - storyName: \\"Heading\\", + name: \\"Heading\\", parameters: { server: { id: \\"yaml/heading\\" @@ -16,7 +16,7 @@ export const Heading = { }; export const Headings = { - storyName: \\"Headings\\", + name: \\"Headings\\", parameters: { server: { id: \\"yaml/headings\\" @@ -25,7 +25,7 @@ export const Headings = { }; export const Button = { - storyName: \\"Button\\", + name: \\"Button\\", parameters: { server: { id: \\"yaml/button\\" diff --git a/app/server/src/lib/compiler/__testfixtures__/yml.snapshot b/app/server/src/lib/compiler/__testfixtures__/yml.snapshot index d8b9d4522152..15c610e2fe6e 100644 --- a/app/server/src/lib/compiler/__testfixtures__/yml.snapshot +++ b/app/server/src/lib/compiler/__testfixtures__/yml.snapshot @@ -7,7 +7,7 @@ export default { }; export const Heading = { - storyName: \\"Heading\\", + name: \\"Heading\\", parameters: { server: { id: \\"yaml/heading\\" @@ -16,7 +16,7 @@ export const Heading = { }; export const Headings = { - storyName: \\"Headings\\", + name: \\"Headings\\", parameters: { server: { id: \\"yaml/headings\\" @@ -25,7 +25,7 @@ export const Headings = { }; export const Button = { - storyName: \\"Button\\", + name: \\"Button\\", parameters: { server: { id: \\"yaml/button\\" diff --git a/app/server/src/lib/compiler/stringifier.ts b/app/server/src/lib/compiler/stringifier.ts index acf54b7b8deb..0dfec11b402a 100644 --- a/app/server/src/lib/compiler/stringifier.ts +++ b/app/server/src/lib/compiler/stringifier.ts @@ -63,7 +63,7 @@ export function stringifyStory(story: StorybookStory): string { const { name, ...options } = story; const storyId = identifier(name); - const exportedStory = { storyName: name, ...options }; + const exportedStory = { name, ...options }; const storyStrings = [`export const ${storyId} = ${stringifyObject(exportedStory)};`, '']; diff --git a/examples/server-kitchen-sink/.storybook/main.js b/examples/server-kitchen-sink/.storybook/main.js index 70c3f234c488..b981eba61bf8 100644 --- a/examples/server-kitchen-sink/.storybook/main.js +++ b/examples/server-kitchen-sink/.storybook/main.js @@ -1,5 +1,5 @@ module.exports = { - stories: ['../stories/**/*.stories.@(json|yaml)'], + stories: ['../stories/**/*.stories.@(json|yaml|yml)'], logLevel: 'debug', addons: [ '@storybook/addon-docs', diff --git a/examples/server-kitchen-sink/stories/addon-a11y.stories.json b/examples/server-kitchen-sink/stories/addons/a11y.stories.json similarity index 96% rename from examples/server-kitchen-sink/stories/addon-a11y.stories.json rename to examples/server-kitchen-sink/stories/addons/a11y.stories.json index 958571aafdfb..49afad6c39f3 100644 --- a/examples/server-kitchen-sink/stories/addon-a11y.stories.json +++ b/examples/server-kitchen-sink/stories/addons/a11y.stories.json @@ -1,5 +1,4 @@ { - "title": "Addons/a11y", "parameters": { "options": { "selectedPanel": "storybook/a11y/panel" diff --git a/examples/server-kitchen-sink/stories/addon-actions.stories.json b/examples/server-kitchen-sink/stories/addons/actions.stories.json similarity index 97% rename from examples/server-kitchen-sink/stories/addon-actions.stories.json rename to examples/server-kitchen-sink/stories/addons/actions.stories.json index b5db602918a9..ea7eae25d5c0 100644 --- a/examples/server-kitchen-sink/stories/addon-actions.stories.json +++ b/examples/server-kitchen-sink/stories/addons/actions.stories.json @@ -1,5 +1,4 @@ { - "title": "Addons/Actions", "parameters": { "options": { "selectedPanel": "storybook/actions/panel" } }, diff --git a/examples/server-kitchen-sink/stories/addon-backgrounds.stories.json b/examples/server-kitchen-sink/stories/addons/backgrounds.stories.json similarity index 93% rename from examples/server-kitchen-sink/stories/addon-backgrounds.stories.json rename to examples/server-kitchen-sink/stories/addons/backgrounds.stories.json index f5fe3529dc23..24fdb9b7fd58 100644 --- a/examples/server-kitchen-sink/stories/addon-backgrounds.stories.json +++ b/examples/server-kitchen-sink/stories/addons/backgrounds.stories.json @@ -1,5 +1,4 @@ { - "title": "Addons/Backgrounds", "parameters": { "backgrounds": { "default": "dark", diff --git a/examples/server-kitchen-sink/stories/addon-controls.stories.json b/examples/server-kitchen-sink/stories/addons/controls.stories.json similarity index 97% rename from examples/server-kitchen-sink/stories/addon-controls.stories.json rename to examples/server-kitchen-sink/stories/addons/controls.stories.json index 522fa1818e14..f91b59af9fc8 100644 --- a/examples/server-kitchen-sink/stories/addon-controls.stories.json +++ b/examples/server-kitchen-sink/stories/addons/controls.stories.json @@ -1,5 +1,4 @@ { - "title": "Addons/Controls", "parameters": { "options": { "selectedPanel": "storybook/controls/panel" } }, diff --git a/examples/server-kitchen-sink/stories/demo.stories.json b/examples/server-kitchen-sink/stories/demo.stories.json index 207332142d29..e335d37445df 100644 --- a/examples/server-kitchen-sink/stories/demo.stories.json +++ b/examples/server-kitchen-sink/stories/demo.stories.json @@ -1,5 +1,4 @@ { - "title": "Demo", "stories": [ { "name": "Heading", diff --git a/examples/server-kitchen-sink/stories/scripts.stories.json b/examples/server-kitchen-sink/stories/html_content/scripts.stories.json similarity index 93% rename from examples/server-kitchen-sink/stories/scripts.stories.json rename to examples/server-kitchen-sink/stories/html_content/scripts.stories.json index 8edb51ffafd6..34a55ec8c2b4 100644 --- a/examples/server-kitchen-sink/stories/scripts.stories.json +++ b/examples/server-kitchen-sink/stories/html_content/scripts.stories.json @@ -1,5 +1,4 @@ { - "title": "Html Content/Scripts", "stories": [ { "name": "Head Inline", diff --git a/examples/server-kitchen-sink/stories/styles.stories.json b/examples/server-kitchen-sink/stories/html_content/styles.stories.json similarity index 93% rename from examples/server-kitchen-sink/stories/styles.stories.json rename to examples/server-kitchen-sink/stories/html_content/styles.stories.json index 8a81304b8566..377372d5b7ee 100644 --- a/examples/server-kitchen-sink/stories/styles.stories.json +++ b/examples/server-kitchen-sink/stories/html_content/styles.stories.json @@ -1,5 +1,4 @@ { - "title": "Html Content/Styles", "stories": [ { "name": "Head Inline", diff --git a/examples/server-kitchen-sink/stories/kitchen_sink.stories.json b/examples/server-kitchen-sink/stories/kitchen_sink.stories.json index 87f09c3ce26c..69baaf12ab1a 100644 --- a/examples/server-kitchen-sink/stories/kitchen_sink.stories.json +++ b/examples/server-kitchen-sink/stories/kitchen_sink.stories.json @@ -1,5 +1,4 @@ { - "title": "Kitchen Sink", "addons": ["knobs"], "parameters": { "backgrounds": { diff --git a/examples/server-kitchen-sink/stories/params.stories.json b/examples/server-kitchen-sink/stories/params.stories.json index c714b0a562df..3744bfd02f51 100644 --- a/examples/server-kitchen-sink/stories/params.stories.json +++ b/examples/server-kitchen-sink/stories/params.stories.json @@ -1,5 +1,4 @@ { - "title": "Params", "parameters": { "server": { "params": { "color": "red" } diff --git a/examples/server-kitchen-sink/stories/welcome.stories.json b/examples/server-kitchen-sink/stories/welcome.stories.json index 976e10c37cc5..401ef4b0a314 100644 --- a/examples/server-kitchen-sink/stories/welcome.stories.json +++ b/examples/server-kitchen-sink/stories/welcome.stories.json @@ -1,5 +1,4 @@ { - "title": "Welcome", "stories": [ { "name": "Welcome", diff --git a/examples/server-kitchen-sink/stories/yaml.stories.yaml b/examples/server-kitchen-sink/stories/yaml.stories.yaml index 1eb8c906e054..7511de2da854 100644 --- a/examples/server-kitchen-sink/stories/yaml.stories.yaml +++ b/examples/server-kitchen-sink/stories/yaml.stories.yaml @@ -1,4 +1,3 @@ -title: Demo YAML stories: - name: Heading parameters: diff --git a/examples/server-kitchen-sink/stories/yml.stories.yml b/examples/server-kitchen-sink/stories/yml.stories.yml index bc334cb8949f..7511de2da854 100644 --- a/examples/server-kitchen-sink/stories/yml.stories.yml +++ b/examples/server-kitchen-sink/stories/yml.stories.yml @@ -1,4 +1,3 @@ -title: Demo YML stories: - name: Heading parameters: