eslint-plugin-jsdoc 48.8.3 → 48.9.1

package/dist/jsdocUtils.cjs

@@ -3,7 +3,21 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.hasParams = exports.hasATag = exports.getTagsByType = exports.getTags = exports.getTagStructureForMode = exports.getTagDescription = exports.getRegexFromString = exports.getPreferredTagNameSimple = exports.getPreferredTagName = exports.getJsdocTagsDeep = exports.getIndent = exports.getFunctionParameterNames = 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 () {
+    return _hasReturnValue.hasReturnValue;
+  }
+});
+exports.hasThrowValue = exports.hasTag = void 0;
+Object.defineProperty(exports, "hasValueOrExecutorHasNonEmptyResolveValue", {
+  enumerable: true,
+  get: function () {
+    return _hasReturnValue.hasValueOrExecutorHasNonEmptyResolveValue;
+  }
+});
+exports.tagMustHaveTypePosition = exports.tagMustHaveNamePosition = exports.tagMissingRequiredTypeOrNamepath = exports.tagMightHaveTypePosition = exports.tagMightHaveNamepath = exports.tagMightHaveNamePosition = exports.tagMightHaveEitherTypeOrNamePosition = exports.setTagStructure = exports.pathDoesNotBeginWith = exports.parseClosureTemplateTag = exports.overrideTagStructure = exports.mayBeUndefinedTypeTag = exports.isValidTag = exports.isSetter = exports.isNamepathReferencingTag = exports.isNamepathOrUrlReferencingTag = exports.isNamepathDefiningTag = exports.isGetter = exports.isConstructor = exports.hasYieldValue = void 0;
 var _getDefaultTagStructureForMode = _interopRequireDefault(require("./getDefaultTagStructureForMode.cjs"));
 var _tagNames = require("./tagNames.cjs");
 var _hasReturnValue = require("./utils/hasReturnValue.cjs");
@@ -82,6 +96,7 @@ const setTagStructure = mode => {
  */
 
 /** @type {FlattenRoots} */
+exports.setTagStructure = setTagStructure;
 const flattenRoots = (params, root = '') => {
   let hasRestElement = false;
   let hasPropertyRest = false;
@@ -153,6 +168,7 @@ const flattenRoots = (params, root = '') => {
  *  import('@typescript-eslint/types').TSESTree.TSPropertySignature} propSignature
  * @returns {undefined|string|[string, string[]]}
  */
+exports.flattenRoots = flattenRoots;
 const getPropertiesFromPropertySignature = propSignature => {
   if (propSignature.type === 'TSIndexSignature' || propSignature.type === 'TSConstructSignatureDeclaration' || propSignature.type === 'TSCallSignatureDeclaration') {
     return undefined;
@@ -337,6 +353,7 @@ const getFunctionParameterNames = (functionNode, checkDefaultObjects) => {
  * @param {ESTreeOrTypeScriptNode} functionNode
  * @returns {Integer}
  */
+exports.getFunctionParameterNames = getFunctionParameterNames;
 const hasParams = functionNode => {
   // Should also check `functionNode.value.params` if supporting `MethodDefinition`
   return /** @type {import('@typescript-eslint/types').TSESTree.FunctionDeclaration} */functionNode.params.length;
@@ -353,6 +370,7 @@ const hasParams = functionNode => {
  *   type: string
  * }[]}
  */
+exports.hasParams = hasParams;
 const getJsdocTagsDeep = (jsdoc, targetTagName) => {
   const ret = [];
   for (const [idx, {
@@ -371,11 +389,12 @@ const getJsdocTagsDeep = (jsdoc, targetTagName) => {
   }
   return ret;
 };
+exports.getJsdocTagsDeep = getJsdocTagsDeep;
 const modeWarnSettings = (0, _WarnSettings.default)();
 
 /**
  * @param {ParserMode|undefined} mode
- * @param {import('eslint').Rule.RuleContext} context
+ * @param {Reporter} context
  * @returns {import('./tagNames.js').AliasedTags}
  */
 const getTagNamesForMode = (mode, context) => {
@@ -411,16 +430,65 @@ const getTagNamesForMode = (mode, context) => {
 };
 
 /**
- * @param {import('eslint').Rule.RuleContext} context
- * @param {ParserMode|undefined} mode
+ * @param {import('comment-parser').Spec} tg
+ * @param {boolean} [returnArray]
+ * @returns {string[]|string}
+ */
+const getTagDescription = (tg, returnArray) => {
+  /**
+   * @type {string[]}
+   */
+  const descriptions = [];
+  tg.source.some(({
+    tokens: {
+      end,
+      lineEnd,
+      postDelimiter,
+      tag,
+      postTag,
+      name,
+      type,
+      description
+    }
+  }) => {
+    const desc = (tag && postTag || !tag && !name && !type && postDelimiter || ''
+
+    // Remove space
+    ).slice(1) + (description || '') + (lineEnd || '');
+    if (end) {
+      if (desc) {
+        descriptions.push(desc);
+      }
+      return true;
+    }
+    descriptions.push(desc);
+    return false;
+  });
+  return returnArray ? descriptions : descriptions.join('\n');
+};
+
+/**
+ * @typedef {{
+ *   report: (descriptor: import('eslint').Rule.ReportDescriptor) => void
+ * }} Reporter
+ */
+
+/**
  * @param {string} name
+ * @param {ParserMode|undefined} mode
  * @param {TagNamePreference} tagPreference
+ * @param {Reporter} context
  * @returns {string|false|{
  *   message: string;
  *   replacement?: string|undefined;
  * }}
  */
-const getPreferredTagName = (context, mode, name, tagPreference = {}) => {
+exports.getTagDescription = getTagDescription;
+const getPreferredTagNameSimple = (name, mode, tagPreference = {}, context = {
+  report() {
+    // No-op
+  }
+}) => {
   var _Object$entries$find;
   const prefValues = Object.values(tagPreference);
   if (prefValues.includes(name) || prefValues.some(prefVal => {
@@ -457,6 +525,7 @@ const getPreferredTagName = (context, mode, name, tagPreference = {}) => {
  * @param {string[]} definedTags
  * @returns {boolean}
  */
+exports.getPreferredTagNameSimple = getPreferredTagNameSimple;
 const isValidTag = (context, mode, name, definedTags) => {
   const tagNames = getTagNamesForMode(mode, context);
   const validTagNames = Object.keys(tagNames).concat(Object.values(tagNames).flat());
@@ -470,6 +539,7 @@ const isValidTag = (context, mode, name, definedTags) => {
  * @param {string} targetTagName
  * @returns {boolean}
  */
+exports.isValidTag = isValidTag;
 const hasTag = (jsdoc, targetTagName) => {
   const targetTagLower = targetTagName.toLowerCase();
   return jsdoc.tags.some(doc => {
@@ -477,12 +547,133 @@ const hasTag = (jsdoc, targetTagName) => {
   });
 };
 
+/**
+ * @param {import('./iterateJsdoc.js').JsdocBlockWithInline} jsdoc
+ * @param {(tag: import('@es-joy/jsdoccomment').JsdocTagWithInline) => boolean} filter
+ * @returns {import('@es-joy/jsdoccomment').JsdocTagWithInline[]}
+ */
+exports.hasTag = hasTag;
+const filterTags = (jsdoc, filter) => {
+  return jsdoc.tags.filter(tag => {
+    return filter(tag);
+  });
+};
+
+/**
+ * @param {import('./iterateJsdoc.js').JsdocBlockWithInline} jsdoc
+ * @param {string} tagName
+ * @returns {import('comment-parser').Spec[]}
+ */
+exports.filterTags = filterTags;
+const getTags = (jsdoc, tagName) => {
+  return filterTags(jsdoc, item => {
+    return item.tag === tagName;
+  });
+};
+
+/**
+ * @param {import('./iterateJsdoc.js').JsdocBlockWithInline} jsdoc
+ * @param {{
+ *   tagName: string,
+ *   context?: import('eslint').Rule.RuleContext,
+ *   mode?: ParserMode,
+ *   report?: import('./iterateJsdoc.js').Report
+ *   tagNamePreference?: TagNamePreference
+ *   skipReportingBlockedTag?: boolean,
+ *   allowObjectReturn?: boolean,
+ *   defaultMessage?: string,
+ * }} cfg
+ * @returns {string|undefined|false|{
+ *   message: string;
+ *   replacement?: string|undefined;
+ * }|{
+ *   blocked: true,
+ *   tagName: string
+ * }}
+ */
+exports.getTags = getTags;
+const getPreferredTagName = (jsdoc, {
+  tagName,
+  context,
+  mode,
+  tagNamePreference,
+  report = () => {},
+  skipReportingBlockedTag = false,
+  allowObjectReturn = false,
+  defaultMessage = `Unexpected tag \`@${tagName}\``
+}) => {
+  const ret = getPreferredTagNameSimple(tagName, mode, tagNamePreference, context);
+  const isObject = ret && typeof ret === 'object';
+  if (hasTag(jsdoc, tagName) && (ret === false || isObject && !ret.replacement)) {
+    if (skipReportingBlockedTag) {
+      return {
+        blocked: true,
+        tagName
+      };
+    }
+    const message = isObject && ret.message || defaultMessage;
+    report(message, null, getTags(jsdoc, tagName)[0]);
+    return false;
+  }
+  return isObject && !allowObjectReturn ? ret.replacement : ret;
+};
+
+/**
+ * @param {import('./iterateJsdoc.js').JsdocBlockWithInline} jsdoc
+ * @param {string} tagName
+ * @param {(
+ *   matchingJsdocTag: import('@es-joy/jsdoccomment').JsdocTagWithInline,
+ *   targetTagName: string
+ * ) => void} arrayHandler
+ * @param {object} cfg
+ * @param {import('eslint').Rule.RuleContext} [cfg.context]
+ * @param {ParserMode} [cfg.mode]
+ * @param {import('./iterateJsdoc.js').Report} [cfg.report]
+ * @param {TagNamePreference} [cfg.tagNamePreference]
+ * @param {boolean} [cfg.skipReportingBlockedTag]
+ * @returns {void}
+ */
+exports.getPreferredTagName = getPreferredTagName;
+const forEachPreferredTag = (jsdoc, tagName, arrayHandler, {
+  context,
+  mode,
+  report,
+  tagNamePreference,
+  skipReportingBlockedTag = false
+} = {}) => {
+  const targetTagName = /** @type {string|false} */
+  getPreferredTagName(jsdoc, {
+    skipReportingBlockedTag,
+    tagName,
+    context,
+    mode,
+    report,
+    tagNamePreference
+  });
+  if (!targetTagName || skipReportingBlockedTag && targetTagName && typeof targetTagName === 'object') {
+    return;
+  }
+  const matchingJsdocTags = jsdoc.tags.filter(({
+    tag
+  }) => {
+    return tag === targetTagName;
+  });
+  for (const matchingJsdocTag of matchingJsdocTags) {
+    arrayHandler(
+    /**
+     * @type {import('@es-joy/jsdoccomment').JsdocTagWithInline}
+     */
+    matchingJsdocTag, targetTagName);
+  }
+};
+
 /**
  * Get all tags, inline tags and inline tags in tags
  * @param {import('./iterateJsdoc.js').JsdocBlockWithInline} jsdoc
  * @returns {(import('comment-parser').Spec|
  *   import('@es-joy/jsdoccomment').JsdocInlineTagNoType)[]}
  */
+exports.forEachPreferredTag = forEachPreferredTag;
 const getAllTags = jsdoc => {
   return [...jsdoc.tags, ...jsdoc.inlineTags.map(inlineTag => {
     // Tags don't have source or line numbers, so add before returning
@@ -543,6 +734,7 @@ const getAllTags = jsdoc => {
  * @param {string[]} targetTagNames
  * @returns {boolean}
  */
+exports.getAllTags = getAllTags;
 const hasATag = (jsdoc, targetTagNames) => {
   return targetTagNames.some(targetTagName => {
     return hasTag(jsdoc, targetTagName);
@@ -557,6 +749,7 @@ const hasATag = (jsdoc, targetTagNames) => {
  * @returns {boolean}
  *   true in case a defined type is undeclared; otherwise false.
  */
+exports.hasATag = hasATag;
 const mayBeUndefinedTypeTag = (tag, mode) => {
   // The function should not continue in the event the type is not defined...
   if (typeof tag === 'undefined' || tag === null) {
@@ -593,6 +786,7 @@ const mayBeUndefinedTypeTag = (tag, mode) => {
  * @param {string} tag
  * @returns {Map<string, string|string[]|boolean|undefined>}
  */
+exports.mayBeUndefinedTypeTag = mayBeUndefinedTypeTag;
 const ensureMap = (map, tag) => {
   if (!map.has(tag)) {
     map.set(tag, new Map());
@@ -640,6 +834,7 @@ const overrideTagStructure = (structuredTags, tagMap = tagStructure) => {
  * @param {import('./iterateJsdoc.js').StructuredTags} structuredTags
  * @returns {import('./getDefaultTagStructureForMode.js').TagStructure}
  */
+exports.overrideTagStructure = overrideTagStructure;
 const getTagStructureForMode = (mode, structuredTags) => {
   const tagStruct = (0, _getDefaultTagStructureForMode.default)(mode);
   try {
@@ -656,6 +851,7 @@ const getTagStructureForMode = (mode, structuredTags) => {
  * @param {import('./getDefaultTagStructureForMode.js').TagStructure} tagMap
  * @returns {boolean}
  */
+exports.getTagStructureForMode = getTagStructureForMode;
 const isNamepathDefiningTag = (tag, tagMap = tagStructure) => {
   const tagStruct = ensureMap(tagMap, tag);
   return tagStruct.get('namepathRole') === 'namepath-defining';
@@ -666,6 +862,7 @@ const isNamepathDefiningTag = (tag, tagMap = tagStructure) => {
  * @param {import('./getDefaultTagStructureForMode.js').TagStructure} tagMap
  * @returns {boolean}
  */
+exports.isNamepathDefiningTag = isNamepathDefiningTag;
 const isNamepathReferencingTag = (tag, tagMap = tagStructure) => {
   const tagStruct = ensureMap(tagMap, tag);
   return tagStruct.get('namepathRole') === 'namepath-referencing';
@@ -676,6 +873,7 @@ const isNamepathReferencingTag = (tag, tagMap = tagStructure) => {
  * @param {import('./getDefaultTagStructureForMode.js').TagStructure} tagMap
  * @returns {boolean}
  */
+exports.isNamepathReferencingTag = isNamepathReferencingTag;
 const isNamepathOrUrlReferencingTag = (tag, tagMap = tagStructure) => {
   const tagStruct = ensureMap(tagMap, tag);
   return tagStruct.get('namepathRole') === 'namepath-or-url-referencing';
@@ -686,6 +884,7 @@ const isNamepathOrUrlReferencingTag = (tag, tagMap = tagStructure) => {
  * @param {import('./getDefaultTagStructureForMode.js').TagStructure} tagMap
  * @returns {boolean|undefined}
  */
+exports.isNamepathOrUrlReferencingTag = isNamepathOrUrlReferencingTag;
 const tagMustHaveTypePosition = (tag, tagMap = tagStructure) => {
   const tagStruct = ensureMap(tagMap, tag);
   return /** @type {boolean|undefined} */tagStruct.get('typeRequired');
@@ -696,6 +895,7 @@ const tagMustHaveTypePosition = (tag, tagMap = tagStructure) => {
  * @param {import('./getDefaultTagStructureForMode.js').TagStructure} tagMap
  * @returns {boolean|string}
  */
+exports.tagMustHaveTypePosition = tagMustHaveTypePosition;
 const tagMightHaveTypePosition = (tag, tagMap = tagStructure) => {
   if (tagMustHaveTypePosition(tag, tagMap)) {
     return true;
@@ -704,6 +904,7 @@ const tagMightHaveTypePosition = (tag, tagMap = tagStructure) => {
   const ret = /** @type {boolean|undefined} */tagStruct.get('typeAllowed');
   return ret === undefined ? true : ret;
 };
+exports.tagMightHaveTypePosition = tagMightHaveTypePosition;
 const namepathTypes = new Set(['namepath-defining', 'namepath-referencing']);
 
 /**
@@ -722,6 +923,7 @@ const tagMightHaveNamePosition = (tag, tagMap = tagStructure) => {
  * @param {import('./getDefaultTagStructureForMode.js').TagStructure} tagMap
  * @returns {boolean}
  */
+exports.tagMightHaveNamePosition = tagMightHaveNamePosition;
 const tagMightHaveNamepath = (tag, tagMap = tagStructure) => {
   const tagStruct = ensureMap(tagMap, tag);
   const nampathRole = tagStruct.get('namepathRole');
@@ -733,6 +935,7 @@ const tagMightHaveNamepath = (tag, tagMap = tagStructure) => {
  * @param {import('./getDefaultTagStructureForMode.js').TagStructure} tagMap
  * @returns {boolean|undefined}
  */
+exports.tagMightHaveNamepath = tagMightHaveNamepath;
 const tagMustHaveNamePosition = (tag, tagMap = tagStructure) => {
   const tagStruct = ensureMap(tagMap, tag);
   return /** @type {boolean|undefined} */tagStruct.get('nameRequired');
@@ -743,6 +946,7 @@ const tagMustHaveNamePosition = (tag, tagMap = tagStructure) => {
  * @param {import('./getDefaultTagStructureForMode.js').TagStructure} tagMap
  * @returns {boolean}
  */
+exports.tagMustHaveNamePosition = tagMustHaveNamePosition;
 const tagMightHaveEitherTypeOrNamePosition = (tag, tagMap) => {
   return Boolean(tagMightHaveTypePosition(tag, tagMap)) || tagMightHaveNamepath(tag, tagMap);
 };
@@ -752,6 +956,7 @@ const tagMightHaveEitherTypeOrNamePosition = (tag, tagMap) => {
  * @param {import('./getDefaultTagStructureForMode.js').TagStructure} tagMap
  * @returns {boolean|undefined}
  */
+exports.tagMightHaveEitherTypeOrNamePosition = tagMightHaveEitherTypeOrNamePosition;
 const tagMustHaveEitherTypeOrNamePosition = (tag, tagMap) => {
   const tagStruct = ensureMap(tagMap, tag);
   return /** @type {boolean} */tagStruct.get('typeOrNameRequired');
@@ -778,6 +983,7 @@ const tagMissingRequiredTypeOrNamepath = (tag, tagMap = tagStructure) => {
  * @param {boolean} [checkYieldReturnValue]
  * @returns {boolean}
  */
+exports.tagMissingRequiredTypeOrNamepath = tagMissingRequiredTypeOrNamepath;
 const hasNonFunctionYield = (node, checkYieldReturnValue) => {
   /* eslint-enable complexity -- Temporary */
   if (!node) {
@@ -954,6 +1160,7 @@ const hasYieldValue = (node, checkYieldReturnValue) => {
  * @returns {boolean}
  */
 // eslint-disable-next-line complexity
+exports.hasYieldValue = hasYieldValue;
 const hasThrowValue = (node, innerFunction) => {
   if (!node) {
     return false;
@@ -1030,6 +1237,7 @@ const isInlineTag = (tag) => {
  * @param {import('comment-parser').Spec} tag
  * @returns {string[]}
  */
+exports.hasThrowValue = hasThrowValue;
 const parseClosureTemplateTag = tag => {
   return tag.name.split(',').map(type => {
     return type.trim().replace(/^\[(?<name>.*?)=.*\]$/u, '$<name>');
@@ -1051,6 +1259,7 @@ const parseClosureTemplateTag = tag => {
  * }} settings
  * @returns {(string|import('./iterateJsdoc.js').ContextObject)[]}
  */
+exports.parseClosureTemplateTag = parseClosureTemplateTag;
 const enforcedContexts = (context, defaultContexts, settings) => {
   var _context$options$;
   const contexts = ((_context$options$ = context.options[0]) === null || _context$options$ === void 0 ? void 0 : _context$options$.contexts) || settings.contexts || (defaultContexts === true ? ['ArrowFunctionExpression', 'FunctionDeclaration', 'FunctionExpression', 'TSDeclareFunction'] : defaultContexts);
@@ -1063,6 +1272,7 @@ const enforcedContexts = (context, defaultContexts, settings) => {
  * @param {import('@es-joy/jsdoccomment').CommentHandler} [handler]
  * @returns {import('eslint').Rule.RuleListener}
  */
+exports.enforcedContexts = enforcedContexts;
 const getContextObject = (contexts, checkJsdoc, handler) => {
   /** @type {import('eslint').Rule.RuleListener} */
   const properties = {};
@@ -1116,6 +1326,7 @@ const getContextObject = (contexts, checkJsdoc, handler) => {
   }
   return properties;
 };
+exports.getContextObject = getContextObject;
 const tagsWithNamesAndDescriptions = new Set(['param', 'arg', 'argument', 'property', 'prop', 'template',
 // These two are parsed by our custom parser as though having a `name`
 'returns', 'return']);
@@ -1163,6 +1374,7 @@ const getTagsByType = (context, mode, tags) => {
  * }} sourceCode
  * @returns {string}
  */
+exports.getTagsByType = getTagsByType;
 const getIndent = sourceCode => {
   var _sourceCode$text$matc;
   return (((_sourceCode$text$matc = sourceCode.text.match(/^\n*([ \t]+)/u)) === null || _sourceCode$text$matc === void 0 ? void 0 : _sourceCode$text$matc[1]) ?? '') + ' ';
@@ -1172,6 +1384,7 @@ const getIndent = sourceCode => {
  * @param {import('eslint').Rule.Node|null} node
  * @returns {boolean}
  */
+exports.getIndent = getIndent;
 const isConstructor = node => {
   var _node$parent;
   return (node === null || node === void 0 ? void 0 : node.type) === 'MethodDefinition' && node.kind === 'constructor' || /** @type {import('@typescript-eslint/types').TSESTree.MethodDefinition} */(node === null || node === void 0 || (_node$parent = node.parent) === null || _node$parent === void 0 ? void 0 : _node$parent.kind) === 'constructor';
@@ -1181,6 +1394,7 @@ const isConstructor = node => {
  * @param {import('eslint').Rule.Node|null} node
  * @returns {boolean}
  */
+exports.isConstructor = isConstructor;
 const isGetter = node => {
   var _node$parent2;
   return node !== null &&
@@ -1195,6 +1409,7 @@ const isGetter = node => {
  * @param {import('eslint').Rule.Node|null} node
  * @returns {boolean}
  */
+exports.isGetter = isGetter;
 const isSetter = node => {
   var _node$parent3;
   return node !== null &&
@@ -1209,6 +1424,7 @@ const isSetter = node => {
  * @param {import('eslint').Rule.Node} node
  * @returns {boolean}
  */
+exports.isSetter = isSetter;
 const hasAccessorPair = node => {
   const {
     type,
@@ -1268,6 +1484,7 @@ const exemptSpeciaMethods = (jsdoc, node, context, schema) => {
  * @param {string} str
  * @returns {string}
  */
+exports.exemptSpeciaMethods = exemptSpeciaMethods;
 const dropPathSegmentQuotes = str => {
   return str.replaceAll(/\.(['"])(.*)\1/gu, '.$2');
 };
@@ -1276,6 +1493,7 @@ const dropPathSegmentQuotes = str => {
  * @param {string} name
  * @returns {(otherPathName: string) => boolean}
  */
+exports.dropPathSegmentQuotes = dropPathSegmentQuotes;
 const comparePaths = name => {
   return otherPathName => {
     return otherPathName === name || dropPathSegmentQuotes(otherPathName) === dropPathSegmentQuotes(name);
@@ -1290,6 +1508,7 @@ const comparePaths = name => {
  */
 
 /** @type {PathDoesNotBeginWith} */
+exports.comparePaths = comparePaths;
 const pathDoesNotBeginWith = (name, otherPathName) => {
   return !name.startsWith(otherPathName) && !dropPathSegmentQuotes(name).startsWith(dropPathSegmentQuotes(otherPathName));
 };
@@ -1299,6 +1518,7 @@ const pathDoesNotBeginWith = (name, otherPathName) => {
  * @param {string} [requiredFlags]
  * @returns {RegExp}
  */
+exports.pathDoesNotBeginWith = pathDoesNotBeginWith;
 const getRegexFromString = (regexString, requiredFlags) => {
   const match = regexString.match(/^\/(.*)\/([gimyus]*)$/us);
   let flags = 'u';
@@ -1313,47 +1533,5 @@ const getRegexFromString = (regexString, requiredFlags) => {
   flags = uniqueFlags.join('');
   return new RegExp(regex, flags);
 };
-var _default = exports.default = {
-  comparePaths,
-  dropPathSegmentQuotes,
-  enforcedContexts,
-  exemptSpeciaMethods,
-  flattenRoots,
-  getAllTags,
-  getContextObject,
-  getFunctionParameterNames,
-  getIndent,
-  getJsdocTagsDeep,
-  getPreferredTagName,
-  getRegexFromString,
-  getTagsByType,
-  getTagStructureForMode,
-  hasATag,
-  hasParams,
-  hasReturnValue: _hasReturnValue.hasReturnValue,
-  hasTag,
-  hasThrowValue,
-  hasValueOrExecutorHasNonEmptyResolveValue: _hasReturnValue.hasValueOrExecutorHasNonEmptyResolveValue,
-  hasYieldValue,
-  isConstructor,
-  isGetter,
-  isNamepathDefiningTag,
-  isNamepathOrUrlReferencingTag,
-  isNamepathReferencingTag,
-  isSetter,
-  isValidTag,
-  mayBeUndefinedTypeTag,
-  overrideTagStructure,
-  parseClosureTemplateTag,
-  pathDoesNotBeginWith,
-  setTagStructure,
-  tagMightHaveEitherTypeOrNamePosition,
-  tagMightHaveNamepath,
-  tagMightHaveNamePosition,
-  tagMightHaveTypePosition,
-  tagMissingRequiredTypeOrNamepath,
-  tagMustHaveNamePosition,
-  tagMustHaveTypePosition
-};
-module.exports = exports.default;
+exports.getRegexFromString = getRegexFromString;
 //# sourceMappingURL=jsdocUtils.cjs.map