eslint-plugin-jsdoc 57.0.5 → 57.0.7

package/src/buildForbidRuleDefinition.js

@@ -0,0 +1,86 @@
+import iterateJsdoc from './iterateJsdoc.js';
+
+/**
+ * @param {{
+ *   contexts: (string|{
+ *     comment: string,
+ *     context: string,
+ *     message: string
+ *   })[],
+ *   description?: string,
+ *   contextName?: string
+ *   url?: string,
+ * }} cfg
+ * @returns {import('@eslint/core').RuleDefinition<
+ *   import('@eslint/core').RuleDefinitionTypeOptions
+ * >}
+ */
+export const buildForbidRuleDefinition = ({
+  contextName,
+  contexts,
+  description,
+  url,
+}) => {
+  return iterateJsdoc(({
+    // context,
+    info: {
+      comment,
+    },
+    report,
+    utils,
+  }) => {
+    const {
+      contextStr,
+      foundContext,
+    } = utils.findContext(contexts, comment);
+
+    // We are not on the *particular* matching context/comment, so don't assume
+    //   we need reporting
+    if (!foundContext) {
+      return;
+    }
+
+    const message = /** @type {import('./iterateJsdoc.js').ContextObject} */ (
+      foundContext
+    )?.message ??
+      'Syntax is restricted: {{context}}' +
+        (comment ? ' with {{comment}}' : '');
+
+    report(message, null, null, comment ? {
+      comment,
+      context: contextStr,
+    } : {
+      context: contextStr,
+    });
+  }, {
+    contextSelected: true,
+    meta: {
+      docs: {
+        description: description ?? contextName ?? 'Reports when certain comment structures are present.',
+        url: url ?? 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/advanced.md#user-content-advanced-creating-your-own-rules',
+      },
+      fixable: 'code',
+      schema: [],
+      type: 'suggestion',
+    },
+    modifyContext: (context) => {
+      // Reproduce context object with our own `contexts`
+      const propertyDescriptors = Object.getOwnPropertyDescriptors(context);
+      return Object.create(
+        Object.getPrototypeOf(context),
+        {
+          ...propertyDescriptors,
+          options: {
+            ...propertyDescriptors.options,
+            value: [
+              {
+                contexts,
+              },
+            ],
+          },
+        },
+      );
+    },
+    nonGlobalSettings: true,
+  });
+};

package/src/index-cjs.js

@@ -1,7 +1,9 @@
+import {
+  buildForbidRuleDefinition,
+} from './buildForbidRuleDefinition.js';
 import {
   getJsdocProcessorPlugin,
 } from './getJsdocProcessorPlugin.js';
-import iterateJsdoc from './iterateJsdoc.js';
 import checkAccess from './rules/checkAccess.js';
 import checkAlignment from './rules/checkAlignment.js';
 import checkExamples from './rules/checkExamples.js';
@@ -61,91 +63,6 @@ import textEscaping from './rules/textEscaping.js';
 import typeFormatting from './rules/typeFormatting.js';
 import validTypes from './rules/validTypes.js';
 
-/**
- * @param {{
- *   contexts: (string|{
- *     comment: string,
- *     context: string,
- *     message: string
- *   })[],
- *   description?: string,
- *   contextName?: string
- *   url?: string,
- * }} cfg
- * @returns {import('@eslint/core').RuleDefinition<
- *   import('@eslint/core').RuleDefinitionTypeOptions
- * >}
- */
-export const buildForbidRuleDefinition = ({
-  contextName,
-  contexts,
-  description,
-  url,
-}) => {
-  return iterateJsdoc(({
-    // context,
-    info: {
-      comment,
-    },
-    report,
-    utils,
-  }) => {
-    const {
-      contextStr,
-      foundContext,
-    } = utils.findContext(contexts, comment);
-
-    // We are not on the *particular* matching context/comment, so don't assume
-    //   we need reporting
-    if (!foundContext) {
-      return;
-    }
-
-    const message = /** @type {import('./iterateJsdoc.js').ContextObject} */ (
-      foundContext
-    )?.message ??
-      'Syntax is restricted: {{context}}' +
-        (comment ? ' with {{comment}}' : '');
-
-    report(message, null, null, comment ? {
-      comment,
-      context: contextStr,
-    } : {
-      context: contextStr,
-    });
-  }, {
-    contextSelected: true,
-    meta: {
-      docs: {
-        description: description ?? contextName ?? 'Reports when certain comment structures are present.',
-        url: url ?? 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/advanced.md#user-content-advanced-creating-your-own-rules',
-      },
-      fixable: 'code',
-      schema: [],
-      type: 'suggestion',
-    },
-    modifyContext: (context) => {
-      // Reproduce context object with our own `contexts`
-      const propertyDescriptors = Object.getOwnPropertyDescriptors(context);
-      return Object.create(
-        Object.getPrototypeOf(context),
-        {
-          ...propertyDescriptors,
-          options: {
-            ...propertyDescriptors.options,
-            value: [
-              {
-                contexts,
-              },
-            ],
-          },
-        },
-      );
-    },
-    nonGlobalSettings: true,
-  });
-};
-
 /* eslint-disable jsdoc/valid-types -- Bug */
 /**
  * @typedef {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups
@@ -563,6 +480,8 @@ index.configs.examples = /** @type {import('eslint').Linter.Config[]} */ ([
       // Can generally look nicer to pad a little even if code imposes more stringency
       '@stylistic/padded-blocks': 0,
 
+      '@typescript-eslint/no-unused-vars': 0,
+
       // "always" newline rule at end unlikely in sample code
       'eol-last': 0,
 

package/src/index-esm.js

@@ -4,9 +4,10 @@ import {
 } from 'object-deep-merge';
 
 // BEGIN REPLACE
-import index, {
+import index from './index-cjs.js';
+import {
   buildForbidRuleDefinition,
-} from './index-cjs.js';
+} from './buildForbidRuleDefinition.js';
 
 // eslint-disable-next-line unicorn/prefer-export-from --- Reusing `index`
 export default index;

package/src/index.js

@@ -4,10 +4,12 @@ import {
   merge,
 } from 'object-deep-merge';
 
+import {
+  buildForbidRuleDefinition,
+} from './buildForbidRuleDefinition.js';
 import {
   getJsdocProcessorPlugin,
 } from './getJsdocProcessorPlugin.js';
-import iterateJsdoc from './iterateJsdoc.js';
 import checkAccess from './rules/checkAccess.js';
 import checkAlignment from './rules/checkAlignment.js';
 import checkExamples from './rules/checkExamples.js';
@@ -67,91 +69,6 @@ import textEscaping from './rules/textEscaping.js';
 import typeFormatting from './rules/typeFormatting.js';
 import validTypes from './rules/validTypes.js';
 
-/**
- * @param {{
- *   contexts: (string|{
- *     comment: string,
- *     context: string,
- *     message: string
- *   })[],
- *   description?: string,
- *   contextName?: string
- *   url?: string,
- * }} cfg
- * @returns {import('@eslint/core').RuleDefinition<
- *   import('@eslint/core').RuleDefinitionTypeOptions
- * >}
- */
-export const buildForbidRuleDefinition = ({
-  contextName,
-  contexts,
-  description,
-  url,
-}) => {
-  return iterateJsdoc(({
-    // context,
-    info: {
-      comment,
-    },
-    report,
-    utils,
-  }) => {
-    const {
-      contextStr,
-      foundContext,
-    } = utils.findContext(contexts, comment);
-
-    // We are not on the *particular* matching context/comment, so don't assume
-    //   we need reporting
-    if (!foundContext) {
-      return;
-    }
-
-    const message = /** @type {import('./iterateJsdoc.js').ContextObject} */ (
-      foundContext
-    )?.message ??
-      'Syntax is restricted: {{context}}' +
-        (comment ? ' with {{comment}}' : '');
-
-    report(message, null, null, comment ? {
-      comment,
-      context: contextStr,
-    } : {
-      context: contextStr,
-    });
-  }, {
-    contextSelected: true,
-    meta: {
-      docs: {
-        description: description ?? contextName ?? 'Reports when certain comment structures are present.',
-        url: url ?? 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/advanced.md#user-content-advanced-creating-your-own-rules',
-      },
-      fixable: 'code',
-      schema: [],
-      type: 'suggestion',
-    },
-    modifyContext: (context) => {
-      // Reproduce context object with our own `contexts`
-      const propertyDescriptors = Object.getOwnPropertyDescriptors(context);
-      return Object.create(
-        Object.getPrototypeOf(context),
-        {
-          ...propertyDescriptors,
-          options: {
-            ...propertyDescriptors.options,
-            value: [
-              {
-                contexts,
-              },
-            ],
-          },
-        },
-      );
-    },
-    nonGlobalSettings: true,
-  });
-};
-
 /* eslint-disable jsdoc/valid-types -- Bug */
 /**
  * @typedef {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups
@@ -569,6 +486,8 @@ index.configs.examples = /** @type {import('eslint').Linter.Config[]} */ ([
       // Can generally look nicer to pad a little even if code imposes more stringency
       '@stylistic/padded-blocks': 0,
 
+      '@typescript-eslint/no-unused-vars': 0,
+
       // "always" newline rule at end unlikely in sample code
       'eol-last': 0,
 

package/src/rules/checkExamples.js

@@ -47,6 +47,8 @@ const defaultMdRules = {
   // Can generally look nicer to pad a little even if code imposes more stringency
   '@stylistic/padded-blocks': 0,
 
+  '@typescript-eslint/no-unused-vars': 0,
+
   // "always" newline rule at end unlikely in sample code
   'eol-last': 0,