eslint-plugin-jsdoc 63.0.0 → 63.0.2

package/dist/cjs/jsdocUtils.d.ts

@@ -173,6 +173,11 @@ export function getAllTags(jsdoc: import("./iterateJsdoc.js").JsdocBlockWithInli
  * @returns {import('eslint').Rule.RuleListener}
  */
 export function getContextObject(contexts: import("./iterateJsdoc.js").Context[], checkJsdoc: import("./iterateJsdoc.js").CheckJsdoc, handler?: import("@es-joy/jsdoccomment").CommentHandler): import("eslint").Rule.RuleListener;
+/**
+ * @param {import('eslint').SourceCode} sourceCode
+ * @returns {import('comment-parser').Spec[]}
+ */
+export function getDocumentNamepathDefiningTags(sourceCode: import("eslint").SourceCode): import("comment-parser").Spec[];
 /**
  * @param {ESTreeOrTypeScriptNode|null} functionNode
  * @param {boolean} [checkDefaultObjects]
@@ -202,6 +207,11 @@ export function getInlineTags(jsdoc: import("./iterateJsdoc.js").JsdocBlockWithI
     line?: number | undefined;
     column?: number | undefined;
 }))[];
+/**
+ * @param {import('eslint').SourceCode} sourceCode
+ * @returns {import('@es-joy/jsdoccomment').JsdocBlockWithInline[]}
+ */
+export function getJSDocCommentBlocks(sourceCode: import("eslint").SourceCode): import("@es-joy/jsdoccomment").JsdocBlockWithInline[];
 /**
  * Gets all names of the target type, including those that refer to a path, e.g.
  * `foo` or `foo.bar`.

package/dist/jsdocUtils.cjs

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.hasParams = exports.hasATag = exports.getTagsByType = exports.getTags = exports.getTagStructureForMode = exports.getTagDescription = exports.getRegexFromString = exports.getPreferredTagNameSimple = exports.getPreferredTagName = exports.getJsdocTagsDeep = exports.getInlineTags = exports.getIndent = exports.getFunctionParameterNames = exports.getContextObject = exports.getAllTags = exports.forEachPreferredTag = exports.flattenRoots = exports.filterTags = exports.exemptSpeciaMethods = exports.enforcedContexts = exports.dropPathSegmentQuotes = exports.comparePaths = void 0;
+exports.hasParams = exports.hasATag = exports.getTagsByType = exports.getTags = exports.getTagStructureForMode = exports.getTagDescription = exports.getRegexFromString = exports.getPreferredTagNameSimple = exports.getPreferredTagName = exports.getJsdocTagsDeep = exports.getJSDocCommentBlocks = exports.getInlineTags = exports.getIndent = exports.getFunctionParameterNames = exports.getDocumentNamepathDefiningTags = exports.getContextObject = exports.getAllTags = exports.forEachPreferredTag = exports.flattenRoots = exports.filterTags = exports.exemptSpeciaMethods = exports.enforcedContexts = exports.dropPathSegmentQuotes = exports.comparePaths = void 0;
 Object.defineProperty(exports, "hasReturnValue", {
   enumerable: true,
   get: function () {
@@ -869,12 +869,40 @@ const isNameOrNamepathDefiningTag = (tag, tagMap = tagStructure) => {
   tagStruct.get('namepathRole'));
 };
 
+/**
+ * @param {import('eslint').SourceCode} sourceCode
+ * @returns {import('@es-joy/jsdoccomment').JsdocBlockWithInline[]}
+ */
+exports.isNameOrNamepathDefiningTag = isNameOrNamepathDefiningTag;
+const getJSDocCommentBlocks = sourceCode => {
+  return sourceCode.getAllComments().filter(comment => {
+    return /^\*(?!\*)/v.test(comment.value);
+  }).map(commentNode => {
+    return (0, _jsdoccomment.parseComment)(commentNode, '');
+  });
+};
+
+/**
+ * @param {import('eslint').SourceCode} sourceCode
+ * @returns {import('comment-parser').Spec[]}
+ */
+exports.getJSDocCommentBlocks = getJSDocCommentBlocks;
+const getDocumentNamepathDefiningTags = sourceCode => {
+  return getJSDocCommentBlocks(sourceCode).flatMap(doc => {
+    return doc.tags.filter(({
+      tag
+    }) => {
+      return isNameOrNamepathDefiningTag(tag) && !['arg', 'argument', 'param', 'prop', 'property'].includes(tag);
+    });
+  });
+};
+
 /**
  * @param {string} tag
  * @param {import('./getDefaultTagStructureForMode.js').TagStructure} tagMap
  * @returns {boolean}
  */
-exports.isNameOrNamepathDefiningTag = isNameOrNamepathDefiningTag;
+exports.getDocumentNamepathDefiningTags = getDocumentNamepathDefiningTags;
 const isNamepathReferencingTag = (tag, tagMap = tagStructure) => {
   const tagStruct = ensureMap(tagMap, tag);
   return tagStruct.get('namepathRole') === 'namepath-referencing';