Support more options for CSF autoTitle

storybookjs · Jul 28, 2021 · 11e078d · 11e078d
1 parent 360c6e2
commit 11e078d
Show file tree

Hide file tree

Showing 26 changed files with 27 additions and 38 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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/...chen-sink/stories/addon-a11y.stories.json → ...hen-sink/stories/addons/a11y.stories.json b/...chen-sink/stories/addon-a11y.stories.json → ...hen-sink/stories/addons/a11y.stories.json
@@ -1,5 +1,4 @@
 {
-  "title": "Addons/a11y",
   "parameters": {
     "options": {
       "selectedPanel": "storybook/a11y/panel"

diff --git a/...n-sink/stories/addon-actions.stories.json → ...-sink/stories/addons/actions.stories.json b/...n-sink/stories/addon-actions.stories.json → ...-sink/stories/addons/actions.stories.json
@@ -1,5 +1,4 @@
  {
-  "title": "Addons/Actions",
   "parameters": {
     "options": { "selectedPanel": "storybook/actions/panel" }
   },

diff --git a/...nk/stories/addon-backgrounds.stories.json → ...k/stories/addons/backgrounds.stories.json b/...nk/stories/addon-backgrounds.stories.json → ...k/stories/addons/backgrounds.stories.json
@@ -1,5 +1,4 @@
 {
-  "title": "Addons/Backgrounds",
   "parameters": {
     "backgrounds": {
       "default": "dark",

diff --git a/...-sink/stories/addon-controls.stories.json → ...sink/stories/addons/controls.stories.json b/...-sink/stories/addon-controls.stories.json → ...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
@@ -1,5 +1,4 @@
 {
-  "title": "Demo",
   "stories": [
     {
       "name": "Heading",

diff --git a/...kitchen-sink/stories/scripts.stories.json → ...stories/html_content/scripts.stories.json b/...kitchen-sink/stories/scripts.stories.json → ...stories/html_content/scripts.stories.json
@@ -1,5 +1,4 @@
 {
-  "title": "Html Content/Scripts",
   "stories": [
     {
       "name": "Head Inline",

diff --git a/...-kitchen-sink/stories/styles.stories.json → .../stories/html_content/styles.stories.json b/...-kitchen-sink/stories/styles.stories.json → .../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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -1,4 +1,3 @@
-title: Demo YML
 stories:
   - name: Heading
     parameters: