fix(informative-docs): check default named declaration

gajus · Feb 6, 2024 · e9a9b74 · e9a9b74
1 parent 6fcb47f
commit e9a9b74
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/docs/rules/informative-docs.md b/docs/rules/informative-docs.md
@@ -263,6 +263,15 @@ export function packageNameFromPath(path) {
   return /^vd+(.d+)?$/.exec(base) || /^tsd.d/.exec(base) ? basename(dirname(path)) : base;
 }
 // Message: This description only repeats the name it describes.
+
+/**
+ * package name from path
+ */
+export default function packageNameFromPath(path) {
+  const base = basename(path);
+  return /^vd+(.d+)?$/.exec(base) || /^tsd.d/.exec(base) ? basename(dirname(path)) : base;
+}
+// Message: This description only repeats the name it describes.
 ````
 
 

diff --git a/src/rules/informativeDocs.js b/src/rules/informativeDocs.js
@@ -39,6 +39,7 @@ const getNamesFromNode = (node) => {
       ),
     ];
 
+  case 'ExportDefaultDeclaration':
   case 'ExportNamedDeclaration':
     return getNamesFromNode(
       /** @type {import('@typescript-eslint/types').TSESTree.ExportNamedDeclaration} */

diff --git a/test/rules/assertions/informativeDocs.js b/test/rules/assertions/informativeDocs.js
@@ -517,6 +517,23 @@ export default {
           message: 'This description only repeats the name it describes.',
         },
       ],
+    },
+    {
+      code: `
+        /**
+         * package name from path
+         */
+        export default function packageNameFromPath(path) {
+          const base = basename(path);
+          return /^v\d+(\.\d+)?$/.exec(base) || /^ts\d\.\d/.exec(base) ? basename(dirname(path)) : base;
+        }
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'This description only repeats the name it describes.',
+        },
+      ],
     }
   ],
   valid: [