Merge pull request #11 from Xvezda/feature/factory-pattern

Add factory pattern support

Author: Xvezda

examples/fixed.js

@@ -47,3 +47,13 @@ const lol = () => {
   } catch {}
 };
 lol();
+
+function factory() {
+  /**
+   * @throws {Error}
+   */
+  return function () {
+    throw new Error();
+  }
+}
+factory();

examples/unsafe.js

@@ -33,3 +33,10 @@ const lol = () => {
   console.log(egg.ham.spam);
 };
 lol();
+
+function factory() {
+  return function () {
+    throw new Error();
+  }
+}
+factory();

src/rules/no-undocumented-throws.js

@@ -75,8 +75,8 @@ module.exports = createRule({
       const isCommented = 
         comments.length &&
         comments
-        .map(({ value }) => value)
-        .some(hasThrowsTag);
+          .map(({ value }) => value)
+          .some(hasThrowsTag);
 
       /** @type {import('typescript').Type[]} */
       const throwTypes = throwStatementNodes
@@ -176,11 +176,13 @@ module.exports = createRule({
       'VariableDeclaration > VariableDeclarator[id.type="Identifier"] > ArrowFunctionExpression:exit': visitOnExit,
       'Property > ArrowFunctionExpression:exit': visitOnExit,
       'PropertyDefinition > ArrowFunctionExpression:exit': visitOnExit,
+      'ReturnStatement > ArrowFunctionExpression:exit': visitOnExit,
 
       'VariableDeclaration > VariableDeclarator[id.type="Identifier"] > FunctionExpression:exit': visitOnExit,
       'Property > FunctionExpression:exit': visitOnExit,
       'PropertyDefinition > FunctionExpression:exit': visitOnExit,
       'MethodDefinition > FunctionExpression:exit': visitOnExit,
+      'ReturnStatement > FunctionExpression:exit': visitOnExit,
     };
   },
 });

src/rules/no-undocumented-throws.test.js

@@ -568,6 +568,74 @@ ruleTester.run(
           { messageId: 'missingThrowsTag' },
         ],
       },
+      {
+        code: `
+          function factory() {
+            return function () {
+              throw new Error();
+            }
+          }
+        `,
+        output: `
+          function factory() {
+            /**
+             * @throws {Error}
+             */
+            return function () {
+              throw new Error();
+            }
+          }
+        `,
+        errors: [
+          { messageId: 'missingThrowsTag' },
+        ],
+      },
+      {
+        code: `
+          function factory() {
+            return () => {
+              throw new Error();
+            }
+          }
+        `,
+        output: `
+          function factory() {
+            /**
+             * @throws {Error}
+             */
+            return () => {
+              throw new Error();
+            }
+          }
+        `,
+        errors: [
+          { messageId: 'missingThrowsTag' },
+        ],
+      },
+      {
+        code: `
+          function factory() {
+            function inner() {
+              throw new Error();
+            }
+            return inner;
+          }
+        `,
+        output: `
+          function factory() {
+            /**
+             * @throws {Error}
+             */
+            function inner() {
+              throw new Error();
+            }
+            return inner;
+          }
+        `,
+        errors: [
+          { messageId: 'missingThrowsTag' },
+        ],
+      },
     ],
   },
 );

src/utils.js

@@ -239,7 +239,17 @@ const findNodeToComment = (node) => {
          * const target = () => { ... };
          * ```
          */
-        findParent(node, (n) => n.type === AST_NODE_TYPES.VariableDeclaration)
+        findParent(node, (n) => n.type === AST_NODE_TYPES.VariableDeclaration) ??
+        /**
+         * @example
+         * ```
+         * function factory() {
+         *   // here
+         *   return function target() { ... };
+         * }
+         * ```
+         */
+        findParent(node, (n) => n.type === AST_NODE_TYPES.ReturnStatement)
       );
     default:
       break;