Merge pull request #69 from storybookjs/fix/no-redundant-story-name-c…

…sf-tool no-redundant-story-name: use same naming algorithm as storybook
storybookjs · Dec 20, 2021 · bec472c · bec472c
2 parents 83d00fa + 6d185a7
commit bec472c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 17 deletions.
diff --git a/lib/rules/no-redundant-story-name.ts b/lib/rules/no-redundant-story-name.ts
@@ -3,6 +3,8 @@
  * @author Yann Braga
  */
 
+import { storyNameFromExport } from '@storybook/csf'
+
 import {
   isExpressionStatement,
   isLiteral,
@@ -39,21 +41,6 @@ export = createStorybookRule({
   },
 
   create(context: any) {
-    // variables should be defined here
-
-    //----------------------------------------------------------------------
-    // Helpers
-    //----------------------------------------------------------------------
-
-    //@TODO use the correct name resolver (equivalent to lodash.startcase used in @storybook/csf)
-    const resolveStoryName = (str: any) =>
-      str
-        .replace(/([A-Z]{1,})/g, ' $1')
-        .replace(/(^\w|\s\w)/g, (m: any) => m.toUpperCase())
-        .split(' ')
-        .filter(Boolean)
-        .join(' ')
-
     //----------------------------------------------------------------------
     // Public
     //----------------------------------------------------------------------
@@ -80,7 +67,7 @@ export = createStorybookRule({
             }
 
             const { name } = id
-            const resolvedStoryName = resolveStoryName(name)
+            const resolvedStoryName = storyNameFromExport(name)
 
             //@ts-ignore
             if (isLiteral(storyNameNode.value) && storyNameNode.value.value === resolvedStoryName) {
@@ -108,7 +95,7 @@ export = createStorybookRule({
         if (isIdentifier(left.property) && left.property.name === 'storyName') {
           const propertyName = left.object.name
           const propertyValue = right.value
-          const resolvedStoryName = resolveStoryName(propertyName)
+          const resolvedStoryName = storyNameFromExport(propertyName)
 
           if (propertyValue === resolvedStoryName) {
             context.report({

diff --git a/tests/lib/rules/no-redundant-story-name.test.ts b/tests/lib/rules/no-redundant-story-name.test.ts
@@ -35,6 +35,12 @@ ruleTester.run('no-redundant-story-name', rule, {
       }
       PrimaryButton.storyName = 'The Primary Button'
     `,
+    `
+      export function H1 () {
+        return <h1>Hello</h1>
+      }
+      H1.storyName = 'H1'
+    `,
   ],
 
   invalid: [