eslint-plugin-jsdoc - npm Package Compare versions

Comparing version 46.7.0 to 46.8.0

dist/iterateJsdoc.js

@@ -683,3 +683,5 @@ "use strict";
   const ancestors = /** @type {import('eslint').Rule.Node[]} */context.getAncestors();
-  const sourceCode = context.getSourceCode();
+  const {
+    sourceCode
+  } = context;
   const utils = /** @type {Utils} */getBasicUtils(context, settings);
@@ -1848,4 +1850,6 @@ const {
   const callIterator = (context, node, jsdocNodes, state, lastCall) => {
-    const sourceCode = context.getSourceCode();
     const {
+      sourceCode
+    } = context;
+    const {
       lines
@@ -1913,3 +1917,5 @@ } = sourceCode;
     create(context) {
-      const sourceCode = context.getSourceCode();
+      const {
+        sourceCode
+      } = context;
       settings = getSettings(context);
@@ -1973,3 +1979,5 @@ if (!settings) {
     create(context) {
-      const sourceCode = context.getSourceCode();
+      const {
+        sourceCode
+      } = context;
       const settings = getSettings(context);
@@ -2064,4 +2072,6 @@ if (!settings) {
       }
-      const sourceCode = context.getSourceCode();
       const {
+        sourceCode
+      } = context;
+      const {
         lines
@@ -2068,0 +2078,0 @@ } = sourceCode;

dist/rules/requireJsdoc.js

@@ -238,3 +238,5 @@ "use strict";
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const {
+      sourceCode
+    } = context;
     const settings = (0, _iterateJsdoc.getSettings)(context);
@@ -241,0 +243,0 @@ if (!settings) {

dist/rules/requireReturns.js

@@ -7,2 +7,3 @@ "use strict";
 exports.default = void 0;
+var _exportParser = _interopRequireDefault(require("../exportParser.js"));
 var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.js"));
@@ -40,3 +41,5 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
   },
+  node,
   report,
+  settings,
   utils,
@@ -49,3 +52,4 @@ context
     forceRequireReturn = false,
-    forceReturnsWithAsync = false
+    forceReturnsWithAsync = false,
+    publicOnly = false
   } = context.options[0] || {};
@@ -88,2 +92,18 @@
     }
+    if (publicOnly) {
+      /** @type {import('./requireJsdoc.js').RequireJsdocOpts} */
+      const opt = {
+        ancestorsOnly: Boolean((publicOnly === null || publicOnly === void 0 ? void 0 : publicOnly.ancestorsOnly) ?? false),
+        esm: Boolean((publicOnly === null || publicOnly === void 0 ? void 0 : publicOnly.esm) ?? true),
+        initModuleExports: Boolean((publicOnly === null || publicOnly === void 0 ? void 0 : publicOnly.cjs) ?? true),
+        initWindow: Boolean((publicOnly === null || publicOnly === void 0 ? void 0 : publicOnly.window) ?? false)
+      };
+      const {
+        sourceCode
+      } = context;
+      const exported = _exportParser.default.isUncommentedExport( /** @type {import('eslint').Rule.Node} */node, sourceCode, opt, settings);
+      if (!exported) {
+        return false;
+      }
+    }
     if ((forceRequireReturn || forceRequireReturnContext) && (iteratingFunction || utils.isVirtualFunction())) {
@@ -160,2 +180,26 @@ return true;
           type: 'boolean'
+        },
+        publicOnly: {
+          oneOf: [{
+            default: false,
+            type: 'boolean'
+          }, {
+            additionalProperties: false,
+            default: {},
+            properties: {
+              ancestorsOnly: {
+                type: 'boolean'
+              },
+              cjs: {
+                type: 'boolean'
+              },
+              esm: {
+                type: 'boolean'
+              },
+              window: {
+                type: 'boolean'
+              }
+            },
+            type: 'object'
+          }]
         }
@@ -162,0 +206,0 @@ },

package.json

@@ -143,3 +143,3 @@ {
   },
-  "version": "46.7.0"
+  "version": "46.8.0"
 }

No alert changes

Improved metrics

Total package byte prevSize

1380764

increased by0.3%

Lines of code

14038

increased by0.4%

No dependency changes