eslint-plugin-jsdoc 63.3.2 → 64.0.0

package/dist/alignTransform.cjs

@@ -1,402 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _commentParser = require("comment-parser");
-/**
- * Transform based on https://github.com/syavorsky/comment-parser/blob/master/src/transforms/align.ts
- *
- * It contains some customizations to align based on the tags, and some custom options.
- */
-
-/**
- * Detects if a line starts with a markdown list marker
- * Supports: -, *, numbered lists (1., 2., etc.)
- * This explicitly excludes hyphens that are part of JSDoc tag syntax
- * @param {string} text - The text to check
- * @param {boolean} isFirstLineOfTag - True if this is the first line (tag line)
- * @returns {boolean} - True if the text starts with a list marker
- */
-const startsWithListMarker = (text, isFirstLineOfTag = false) => {
-  // On the first line of a tag, the hyphen is typically the JSDoc separator,
-  // not a list marker
-  if (isFirstLineOfTag) {
-    return false;
-  }
-
-  // Match lines that start with optional whitespace, then a list marker
-  // - or * followed by a space
-  // or a number followed by . or ) and a space
-  return /^\s*(?:[\-*]|\d+(?:\.|\)))\s+/v.test(text);
-};
-
-/**
- * @typedef {{
- *   hasNoTypes: boolean,
- *   maxNamedTagLength: import('./iterateJsdoc.js').Integer,
- *   maxUnnamedTagLength: import('./iterateJsdoc.js').Integer
- * }} TypelessInfo
- */
-
-const {
-  rewireSource
-} = _commentParser.util;
-
-/**
- * @typedef {{
- *   name: import('./iterateJsdoc.js').Integer,
- *   start: import('./iterateJsdoc.js').Integer,
- *   tag: import('./iterateJsdoc.js').Integer,
- *   type: import('./iterateJsdoc.js').Integer
- * }} Width
- */
-
-/** @type {Width} */
-const zeroWidth = {
-  name: 0,
-  start: 0,
-  tag: 0,
-  type: 0
-};
-
-/**
- * @param {string[]} tags
- * @param {import('./iterateJsdoc.js').Integer} index
- * @param {import('comment-parser').Line[]} source
- * @returns {boolean}
- */
-const shouldAlign = (tags, index, source) => {
-  const tag = source[index].tokens.tag.replace('@', '');
-  const includesTag = tags.includes(tag);
-  if (includesTag) {
-    return true;
-  }
-  if (tag !== '') {
-    return false;
-  }
-  for (let iterator = index; iterator >= 0; iterator--) {
-    const previousTag = source[iterator].tokens.tag.replace('@', '');
-    if (previousTag !== '') {
-      if (tags.includes(previousTag)) {
-        return true;
-      }
-      return false;
-    }
-  }
-  return true;
-};
-
-/**
- * @param {string[]} tags
- * @returns {(
- *   width: Width,
- *   line: {
- *     tokens: import('comment-parser').Tokens
- *   },
- *   index: import('./iterateJsdoc.js').Integer,
- *   source: import('comment-parser').Line[]
- * ) => Width}
- */
-const getWidth = tags => {
-  return (width, {
-    tokens
-  }, index, source) => {
-    if (!shouldAlign(tags, index, source)) {
-      return width;
-    }
-    return {
-      name: Math.max(width.name, tokens.name.length),
-      start: tokens.delimiter === '/**' ? tokens.start.length : width.start,
-      tag: Math.max(width.tag, tokens.tag.length),
-      type: Math.max(width.type, tokens.type.length)
-    };
-  };
-};
-
-/**
- * @param {{
- *   description: string;
- *   tags: import('comment-parser').Spec[];
- *   problems: import('comment-parser').Problem[];
- * }} fields
- * @returns {TypelessInfo}
- */
-const getTypelessInfo = fields => {
-  const hasNoTypes = fields.tags.every(({
-    type
-  }) => {
-    return !type;
-  });
-  const maxNamedTagLength = Math.max(...fields.tags.map(({
-    name,
-    tag
-  }) => {
-    return name.length === 0 ? -1 : tag.length;
-  }).filter(length => {
-    return length !== -1;
-  })) + 1;
-  const maxUnnamedTagLength = Math.max(...fields.tags.map(({
-    name,
-    tag
-  }) => {
-    return name.length === 0 ? tag.length : -1;
-  }).filter(length => {
-    return length !== -1;
-  })) + 1;
-  return {
-    hasNoTypes,
-    maxNamedTagLength,
-    maxUnnamedTagLength
-  };
-};
-
-/**
- * @param {import('./iterateJsdoc.js').Integer} len
- * @returns {string}
- */
-const space = len => {
-  return ''.padStart(len, ' ');
-};
-
-/**
- * Check if a tag or any of its lines contain list markers
- * @param {import('./iterateJsdoc.js').Integer} index - Current line index
- * @param {import('comment-parser').Line[]} source - All source lines
- * @returns {{hasListMarker: boolean, tagStartIndex: import('./iterateJsdoc.js').Integer}}
- */
-const checkForListMarkers = (index, source) => {
-  let hasListMarker = false;
-  let tagStartIndex = index;
-  while (tagStartIndex > 0 && source[tagStartIndex].tokens.tag === '') {
-    tagStartIndex--;
-  }
-  for (let idx = tagStartIndex; idx <= index; idx++) {
-    const isFirstLine = idx === tagStartIndex;
-    if (source[idx]?.tokens?.description && startsWithListMarker(source[idx].tokens.description, isFirstLine)) {
-      hasListMarker = true;
-      break;
-    }
-  }
-  return {
-    hasListMarker,
-    tagStartIndex
-  };
-};
-
-/**
- * Calculate extra indentation for list items relative to the first continuation line
- * @param {import('./iterateJsdoc.js').Integer} index - Current line index
- * @param {import('./iterateJsdoc.js').Integer} tagStartIndex - Index of the tag line
- * @param {import('comment-parser').Line[]} source - All source lines
- * @returns {string} - Extra indentation spaces
- */
-const calculateListExtraIndent = (index, tagStartIndex, source) => {
-  // Find the first continuation line to use as baseline
-  let firstContinuationIndent = null;
-  for (let idx = tagStartIndex + 1; idx < source.length; idx++) {
-    if (source[idx].tokens.description && !source[idx].tokens.tag) {
-      firstContinuationIndent = source[idx].tokens.postDelimiter.length;
-      break;
-    }
-  }
-
-  // Calculate the extra indentation of current line relative to the first continuation line
-  const currentOriginalIndent = source[index].tokens.postDelimiter.length;
-  const extraIndent = firstContinuationIndent !== null && currentOriginalIndent > firstContinuationIndent ? ' '.repeat(currentOriginalIndent - firstContinuationIndent) : '';
-  return extraIndent;
-};
-
-/**
- * @param {{
- *   customSpacings: import('../src/rules/checkLineAlignment.js').CustomSpacings,
- *   tags: string[],
- *   indent: string,
- *   preserveMainDescriptionPostDelimiter: boolean,
- *   wrapIndent: string,
- *   disableWrapIndent: boolean,
- * }} cfg
- * @returns {(
- *   block: import('comment-parser').Block
- * ) => import('comment-parser').Block}
- */
-const alignTransform = ({
-  customSpacings,
-  disableWrapIndent,
-  indent,
-  preserveMainDescriptionPostDelimiter,
-  tags,
-  wrapIndent
-}) => {
-  let intoTags = false;
-  /** @type {Width} */
-  let width;
-
-  /**
-   * @param {import('comment-parser').Tokens} tokens
-   * @param {TypelessInfo} typelessInfo
-   * @returns {import('comment-parser').Tokens}
-   */
-  const alignTokens = (tokens, typelessInfo) => {
-    const nothingAfter = {
-      delim: false,
-      name: false,
-      tag: false,
-      type: false
-    };
-    if (tokens.description === '') {
-      nothingAfter.name = true;
-      tokens.postName = '';
-      if (tokens.name === '') {
-        nothingAfter.type = true;
-        tokens.postType = '';
-        if (tokens.type === '') {
-          nothingAfter.tag = true;
-          tokens.postTag = '';
-
-          /* c8 ignore next: Never happens because the !intoTags return. But it's here for consistency with the original align transform */
-          if (tokens.tag === '') {
-            nothingAfter.delim = true;
-          }
-        }
-      }
-    }
-    let untypedNameAdjustment = 0;
-    let untypedTypeAdjustment = 0;
-    if (typelessInfo.hasNoTypes) {
-      nothingAfter.tag = true;
-      tokens.postTag = '';
-      if (tokens.name === '') {
-        untypedNameAdjustment = typelessInfo.maxNamedTagLength - tokens.tag.length;
-      } else {
-        untypedNameAdjustment = typelessInfo.maxNamedTagLength > typelessInfo.maxUnnamedTagLength ? 0 : Math.max(0, typelessInfo.maxUnnamedTagLength - (tokens.tag.length + tokens.name.length + 1));
-        untypedTypeAdjustment = typelessInfo.maxNamedTagLength - tokens.tag.length;
-      }
-    }
-
-    // Todo: Avoid fixing alignment of blocks with multiline wrapping of type
-    if (tokens.tag === '' && tokens.type) {
-      return tokens;
-    }
-    const spacings = {
-      postDelimiter: customSpacings?.postDelimiter || 1,
-      postName: customSpacings?.postName || 1,
-      postTag: customSpacings?.postTag || 1,
-      postType: customSpacings?.postType || 1
-    };
-    tokens.postDelimiter = nothingAfter.delim ? '' : space(spacings.postDelimiter);
-    if (!nothingAfter.tag) {
-      tokens.postTag = space(width.tag - tokens.tag.length + spacings.postTag);
-    }
-    if (!nothingAfter.type) {
-      tokens.postType = space(width.type - tokens.type.length + spacings.postType + untypedTypeAdjustment);
-    }
-    if (!nothingAfter.name) {
-      // If post name is empty for all lines (name width 0), don't add post name spacing.
-      tokens.postName = width.name === 0 ? '' : space(width.name - tokens.name.length + spacings.postName + untypedNameAdjustment);
-    }
-    return tokens;
-  };
-
-  /**
-   * @param {import('comment-parser').Line} line
-   * @param {import('./iterateJsdoc.js').Integer} index
-   * @param {import('comment-parser').Line[]} source
-   * @param {TypelessInfo} typelessInfo
-   * @param {string|false} indentTag
-   * @returns {import('comment-parser').Line}
-   */
-  const update = (line, index, source, typelessInfo, indentTag) => {
-    /** @type {import('comment-parser').Tokens} */
-    const tokens = {
-      ...line.tokens
-    };
-    if (tokens.tag !== '') {
-      intoTags = true;
-    }
-    const isEmpty = tokens.tag === '' && tokens.name === '' && tokens.type === '' && tokens.description === '';
-
-    // dangling '*/'
-    if (tokens.end === '*/' && isEmpty) {
-      tokens.start = indent + ' ';
-      return {
-        ...line,
-        tokens
-      };
-    }
-    switch (tokens.delimiter) {
-      case '*':
-        tokens.start = indent + ' ';
-        break;
-      case '/**':
-        tokens.start = indent;
-        break;
-      default:
-        tokens.delimiter = '';
-
-        // compensate delimiter
-        tokens.start = indent + '  ';
-    }
-    if (!intoTags) {
-      if (tokens.description === '') {
-        tokens.postDelimiter = '';
-      } else if (!preserveMainDescriptionPostDelimiter) {
-        tokens.postDelimiter = ' ';
-      }
-      return {
-        ...line,
-        tokens
-      };
-    }
-    const postHyphenSpacing = customSpacings?.postHyphen ?? 1;
-    const hyphenSpacing = /^\s*-\s+/v;
-    tokens.description = tokens.description.replace(hyphenSpacing, '-' + ''.padStart(postHyphenSpacing, ' '));
-
-    // Not align.
-    if (shouldAlign(tags, index, source)) {
-      alignTokens(tokens, typelessInfo);
-      if (!disableWrapIndent && indentTag) {
-        const {
-          hasListMarker,
-          tagStartIndex
-        } = checkForListMarkers(index, source);
-        if (hasListMarker && index > tagStartIndex) {
-          const extraIndent = calculateListExtraIndent(index, tagStartIndex, source);
-          tokens.postDelimiter += wrapIndent + extraIndent;
-        } else {
-          // Normal case: add wrapIndent after the aligned delimiter
-          tokens.postDelimiter += wrapIndent;
-        }
-      }
-    }
-    return {
-      ...line,
-      tokens
-    };
-  };
-  return ({
-    source,
-    ...fields
-  }) => {
-    width = source.reduce(getWidth(tags), {
-      ...zeroWidth
-    });
-    const typelessInfo = getTypelessInfo(fields);
-    let tagIndentMode = false;
-    return rewireSource({
-      ...fields,
-      source: source.map((line, index) => {
-        const indentTag = !disableWrapIndent && tagIndentMode && !line.tokens.tag && line.tokens.description;
-        const ret = update(line, index, source, typelessInfo, indentTag);
-        if (!disableWrapIndent && line.tokens.tag) {
-          tagIndentMode = true;
-        }
-        return ret;
-      })
-    });
-  };
-};
-var _default = exports.default = alignTransform;
-module.exports = exports.default;
-//# sourceMappingURL=alignTransform.cjs.map

package/dist/alignTransform.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"alignTransform.cjs","names":["util"],"sources":["../src/alignTransform.js"],"sourcesContent":["/**\n * Transform based on https://github.com/syavorsky/comment-parser/blob/master/src/transforms/align.ts\n *\n * It contains some customizations to align based on the tags, and some custom options.\n */\n\nimport {\n  // `comment-parser/primitives` export\n  util,\n} from 'comment-parser';\n\n/**\n * Detects if a line starts with a markdown list marker\n * Supports: -, *, numbered lists (1., 2., etc.)\n * This explicitly excludes hyphens that are part of JSDoc tag syntax\n * @param {string} text - The text to check\n * @param {boolean} isFirstLineOfTag - True if this is the first line (tag line)\n * @returns {boolean} - True if the text starts with a list marker\n */\nconst startsWithListMarker = (text, isFirstLineOfTag = false) => {\n  // On the first line of a tag, the hyphen is typically the JSDoc separator,\n  // not a list marker\n  if (isFirstLineOfTag) {\n    return false;\n  }\n\n  // Match lines that start with optional whitespace, then a list marker\n  // - or * followed by a space\n  // or a number followed by . or ) and a space\n  return /^\\s*(?:[\\-*]|\\d+(?:\\.|\\)))\\s+/v.test(text);\n};\n\n/**\n * @typedef {{\n *   hasNoTypes: boolean,\n *   maxNamedTagLength: import('./iterateJsdoc.js').Integer,\n *   maxUnnamedTagLength: import('./iterateJsdoc.js').Integer\n * }} TypelessInfo\n */\n\nconst {\n  rewireSource,\n} = util;\n\n/**\n * @typedef {{\n *   name: import('./iterateJsdoc.js').Integer,\n *   start: import('./iterateJsdoc.js').Integer,\n *   tag: import('./iterateJsdoc.js').Integer,\n *   type: import('./iterateJsdoc.js').Integer\n * }} Width\n */\n\n/** @type {Width} */\nconst zeroWidth = {\n  name: 0,\n  start: 0,\n  tag: 0,\n  type: 0,\n};\n\n/**\n * @param {string[]} tags\n * @param {import('./iterateJsdoc.js').Integer} index\n * @param {import('comment-parser').Line[]} source\n * @returns {boolean}\n */\nconst shouldAlign = (tags, index, source) => {\n  const tag = source[index].tokens.tag.replace('@', '');\n  const includesTag = tags.includes(tag);\n\n  if (includesTag) {\n    return true;\n  }\n\n  if (tag !== '') {\n    return false;\n  }\n\n  for (let iterator = index; iterator >= 0; iterator--) {\n    const previousTag = source[iterator].tokens.tag.replace('@', '');\n\n    if (previousTag !== '') {\n      if (tags.includes(previousTag)) {\n        return true;\n      }\n\n      return false;\n    }\n  }\n\n  return true;\n};\n\n/**\n * @param {string[]} tags\n * @returns {(\n *   width: Width,\n *   line: {\n *     tokens: import('comment-parser').Tokens\n *   },\n *   index: import('./iterateJsdoc.js').Integer,\n *   source: import('comment-parser').Line[]\n * ) => Width}\n */\nconst getWidth = (tags) => {\n  return (width, {\n    tokens,\n  }, index, source) => {\n    if (!shouldAlign(tags, index, source)) {\n      return width;\n    }\n\n    return {\n      name: Math.max(width.name, tokens.name.length),\n      start: tokens.delimiter === '/**' ? tokens.start.length : width.start,\n      tag: Math.max(width.tag, tokens.tag.length),\n      type: Math.max(width.type, tokens.type.length),\n    };\n  };\n};\n\n/**\n * @param {{\n *   description: string;\n *   tags: import('comment-parser').Spec[];\n *   problems: import('comment-parser').Problem[];\n * }} fields\n * @returns {TypelessInfo}\n */\nconst getTypelessInfo = (fields) => {\n  const hasNoTypes = fields.tags.every(({\n    type,\n  }) => {\n    return !type;\n  });\n  const maxNamedTagLength = Math.max(...fields.tags.map(({\n    name,\n    tag,\n  }) => {\n    return name.length === 0 ? -1 : tag.length;\n  }).filter((length) => {\n    return length !== -1;\n  })) + 1;\n  const maxUnnamedTagLength = Math.max(...fields.tags.map(({\n    name,\n    tag,\n  }) => {\n    return name.length === 0 ? tag.length : -1;\n  }).filter((length) => {\n    return length !== -1;\n  })) + 1;\n  return {\n    hasNoTypes,\n    maxNamedTagLength,\n    maxUnnamedTagLength,\n  };\n};\n\n/**\n * @param {import('./iterateJsdoc.js').Integer} len\n * @returns {string}\n */\nconst space = (len) => {\n  return ''.padStart(len, ' ');\n};\n\n/**\n * Check if a tag or any of its lines contain list markers\n * @param {import('./iterateJsdoc.js').Integer} index - Current line index\n * @param {import('comment-parser').Line[]} source - All source lines\n * @returns {{hasListMarker: boolean, tagStartIndex: import('./iterateJsdoc.js').Integer}}\n */\nconst checkForListMarkers = (index, source) => {\n  let hasListMarker = false;\n  let tagStartIndex = index;\n  while (tagStartIndex > 0 && source[tagStartIndex].tokens.tag === '') {\n    tagStartIndex--;\n  }\n\n  for (let idx = tagStartIndex; idx <= index; idx++) {\n    const isFirstLine = (idx === tagStartIndex);\n    if (source[idx]?.tokens?.description && startsWithListMarker(source[idx].tokens.description, isFirstLine)) {\n      hasListMarker = true;\n      break;\n    }\n  }\n\n  return {\n    hasListMarker,\n    tagStartIndex,\n  };\n};\n\n/**\n * Calculate extra indentation for list items relative to the first continuation line\n * @param {import('./iterateJsdoc.js').Integer} index - Current line index\n * @param {import('./iterateJsdoc.js').Integer} tagStartIndex - Index of the tag line\n * @param {import('comment-parser').Line[]} source - All source lines\n * @returns {string} - Extra indentation spaces\n */\nconst calculateListExtraIndent = (index, tagStartIndex, source) => {\n  // Find the first continuation line to use as baseline\n  let firstContinuationIndent = null;\n  for (let idx = tagStartIndex + 1; idx < source.length; idx++) {\n    if (source[idx].tokens.description && !source[idx].tokens.tag) {\n      firstContinuationIndent = source[idx].tokens.postDelimiter.length;\n      break;\n    }\n  }\n\n  // Calculate the extra indentation of current line relative to the first continuation line\n  const currentOriginalIndent = source[index].tokens.postDelimiter.length;\n  const extraIndent = firstContinuationIndent !== null && currentOriginalIndent > firstContinuationIndent ?\n    ' '.repeat(currentOriginalIndent - firstContinuationIndent) :\n    '';\n\n  return extraIndent;\n};\n\n/**\n * @param {{\n *   customSpacings: import('../src/rules/checkLineAlignment.js').CustomSpacings,\n *   tags: string[],\n *   indent: string,\n *   preserveMainDescriptionPostDelimiter: boolean,\n *   wrapIndent: string,\n *   disableWrapIndent: boolean,\n * }} cfg\n * @returns {(\n *   block: import('comment-parser').Block\n * ) => import('comment-parser').Block}\n */\nconst alignTransform = ({\n  customSpacings,\n  disableWrapIndent,\n  indent,\n  preserveMainDescriptionPostDelimiter,\n  tags,\n  wrapIndent,\n}) => {\n  let intoTags = false;\n  /** @type {Width} */\n  let width;\n\n  /**\n   * @param {import('comment-parser').Tokens} tokens\n   * @param {TypelessInfo} typelessInfo\n   * @returns {import('comment-parser').Tokens}\n   */\n  const alignTokens = (tokens, typelessInfo) => {\n    const nothingAfter = {\n      delim: false,\n      name: false,\n      tag: false,\n      type: false,\n    };\n\n    if (tokens.description === '') {\n      nothingAfter.name = true;\n      tokens.postName = '';\n\n      if (tokens.name === '') {\n        nothingAfter.type = true;\n        tokens.postType = '';\n\n        if (tokens.type === '') {\n          nothingAfter.tag = true;\n          tokens.postTag = '';\n\n          /* c8 ignore next: Never happens because the !intoTags return. But it's here for consistency with the original align transform */\n          if (tokens.tag === '') {\n            nothingAfter.delim = true;\n          }\n        }\n      }\n    }\n\n    let untypedNameAdjustment = 0;\n    let untypedTypeAdjustment = 0;\n    if (typelessInfo.hasNoTypes) {\n      nothingAfter.tag = true;\n      tokens.postTag = '';\n      if (tokens.name === '') {\n        untypedNameAdjustment = typelessInfo.maxNamedTagLength - tokens.tag.length;\n      } else {\n        untypedNameAdjustment = typelessInfo.maxNamedTagLength > typelessInfo.maxUnnamedTagLength ? 0 :\n          Math.max(0, typelessInfo.maxUnnamedTagLength - (tokens.tag.length + tokens.name.length + 1));\n        untypedTypeAdjustment = typelessInfo.maxNamedTagLength - tokens.tag.length;\n      }\n    }\n\n    // Todo: Avoid fixing alignment of blocks with multiline wrapping of type\n    if (tokens.tag === '' && tokens.type) {\n      return tokens;\n    }\n\n    const spacings = {\n      postDelimiter: customSpacings?.postDelimiter || 1,\n      postName: customSpacings?.postName || 1,\n      postTag: customSpacings?.postTag || 1,\n      postType: customSpacings?.postType || 1,\n    };\n\n    tokens.postDelimiter = nothingAfter.delim ? '' : space(spacings.postDelimiter);\n\n    if (!nothingAfter.tag) {\n      tokens.postTag = space(width.tag - tokens.tag.length + spacings.postTag);\n    }\n\n    if (!nothingAfter.type) {\n      tokens.postType = space(width.type - tokens.type.length + spacings.postType + untypedTypeAdjustment);\n    }\n\n    if (!nothingAfter.name) {\n      // If post name is empty for all lines (name width 0), don't add post name spacing.\n      tokens.postName = width.name === 0 ? '' : space(width.name - tokens.name.length + spacings.postName + untypedNameAdjustment);\n    }\n\n    return tokens;\n  };\n\n  /**\n   * @param {import('comment-parser').Line} line\n   * @param {import('./iterateJsdoc.js').Integer} index\n   * @param {import('comment-parser').Line[]} source\n   * @param {TypelessInfo} typelessInfo\n   * @param {string|false} indentTag\n   * @returns {import('comment-parser').Line}\n   */\n  const update = (line, index, source, typelessInfo, indentTag) => {\n    /** @type {import('comment-parser').Tokens} */\n    const tokens = {\n      ...line.tokens,\n    };\n\n    if (tokens.tag !== '') {\n      intoTags = true;\n    }\n\n    const isEmpty =\n      tokens.tag === '' &&\n      tokens.name === '' &&\n      tokens.type === '' &&\n      tokens.description === '';\n\n    // dangling '*/'\n    if (tokens.end === '*/' && isEmpty) {\n      tokens.start = indent + ' ';\n\n      return {\n        ...line,\n        tokens,\n      };\n    }\n\n    switch (tokens.delimiter) {\n      case '*':\n        tokens.start = indent + ' ';\n        break;\n      case '/**':\n        tokens.start = indent;\n        break;\n      default:\n        tokens.delimiter = '';\n\n        // compensate delimiter\n        tokens.start = indent + '  ';\n    }\n\n    if (!intoTags) {\n      if (tokens.description === '') {\n        tokens.postDelimiter = '';\n      } else if (!preserveMainDescriptionPostDelimiter) {\n        tokens.postDelimiter = ' ';\n      }\n\n      return {\n        ...line,\n        tokens,\n      };\n    }\n\n    const postHyphenSpacing = customSpacings?.postHyphen ?? 1;\n    const hyphenSpacing = /^\\s*-\\s+/v;\n    tokens.description = tokens.description.replace(\n      hyphenSpacing, '-' + ''.padStart(postHyphenSpacing, ' '),\n    );\n\n    // Not align.\n    if (shouldAlign(tags, index, source)) {\n      alignTokens(tokens, typelessInfo);\n\n      if (!disableWrapIndent && indentTag) {\n        const {\n          hasListMarker,\n          tagStartIndex,\n        } = checkForListMarkers(index, source);\n\n        if (hasListMarker && index > tagStartIndex) {\n          const extraIndent = calculateListExtraIndent(index, tagStartIndex, source);\n          tokens.postDelimiter += wrapIndent + extraIndent;\n        } else {\n          // Normal case: add wrapIndent after the aligned delimiter\n          tokens.postDelimiter += wrapIndent;\n        }\n      }\n    }\n\n    return {\n      ...line,\n      tokens,\n    };\n  };\n\n  return ({\n    source,\n    ...fields\n  }) => {\n    width = source.reduce(getWidth(tags), {\n      ...zeroWidth,\n    });\n\n    const typelessInfo = getTypelessInfo(fields);\n\n    let tagIndentMode = false;\n\n    return rewireSource({\n      ...fields,\n      source: source.map((line, index) => {\n        const indentTag = !disableWrapIndent && tagIndentMode && !line.tokens.tag && line.tokens.description;\n        const ret = update(line, index, source, typelessInfo, indentTag);\n\n        if (!disableWrapIndent && line.tokens.tag) {\n          tagIndentMode = true;\n        }\n\n        return ret;\n      }),\n    });\n  };\n};\n\nexport default alignTransform;\n"],"mappings":";;;;;;AAMA;AANA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,oBAAoB,GAAG,CAAC,IAAI,EAAE,gBAAgB,GAAG,KAAK,KAAK;EAC/D;EACA;EACA,IAAI,gBAAgB,EAAE;IACpB,OAAO,KAAK;EACd;;EAEA;EACA;EACA;EACA,OAAO,gCAAgC,CAAC,IAAI,CAAC,IAAI,CAAC;AACpD,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,MAAM;EACJ;AACF,CAAC,GAAGA,eAAA,IAAI;;AAER;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA,MAAM,SAAS,GAAG;EAChB,IAAI,EAAE,CAAC;EACP,KAAK,EAAE,CAAC;EACR,GAAG,EAAE,CAAC;EACN,IAAI,EAAE;AACR,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,KAAK;EAC3C,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;EACrD,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;EAEtC,IAAI,WAAW,EAAE;IACf,OAAO,IAAI;EACb;EAEA,IAAI,GAAG,KAAK,EAAE,EAAE;IACd,OAAO,KAAK;EACd;EAEA,KAAK,IAAI,QAAQ,GAAG,KAAK,EAAE,QAAQ,IAAI,CAAC,EAAE,QAAQ,EAAE,EAAE;IACpD,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;IAEhE,IAAI,WAAW,KAAK,EAAE,EAAE;MACtB,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;QAC9B,OAAO,IAAI;MACb;MAEA,OAAO,KAAK;IACd;EACF;EAEA,OAAO,IAAI;AACb,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,QAAQ,GAAI,IAAI,IAAK;EACzB,OAAO,CAAC,KAAK,EAAE;IACb;EACF,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK;IACnB,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE;MACrC,OAAO,KAAK;IACd;IAEA,OAAO;MACL,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;MAC9C,KAAK,EAAE,MAAM,CAAC,SAAS,KAAK,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK;MACrE,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;MAC3C,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM;IAC/C,CAAC;EACH,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,eAAe,GAAI,MAAM,IAAK;EAClC,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpC;EACF,CAAC,KAAK;IACJ,OAAO,CAAC,IAAI;EACd,CAAC,CAAC;EACF,MAAM,iBAAiB,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrD,IAAI;IACJ;EACF,CAAC,KAAK;IACJ,OAAO,IAAI,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,MAAM;EAC5C,CAAC,CAAC,CAAC,MAAM,CAAE,MAAM,IAAK;IACpB,OAAO,MAAM,KAAK,CAAC,CAAC;EACtB,CAAC,CAAC,CAAC,GAAG,CAAC;EACP,MAAM,mBAAmB,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvD,IAAI;IACJ;EACF,CAAC,KAAK;IACJ,OAAO,IAAI,CAAC,MAAM,KAAK,CAAC,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;EAC5C,CAAC,CAAC,CAAC,MAAM,CAAE,MAAM,IAAK;IACpB,OAAO,MAAM,KAAK,CAAC,CAAC;EACtB,CAAC,CAAC,CAAC,GAAG,CAAC;EACP,OAAO;IACL,UAAU;IACV,iBAAiB;IACjB;EACF,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAM,KAAK,GAAI,GAAG,IAAK;EACrB,OAAO,EAAE,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;AAC9B,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,mBAAmB,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK;EAC7C,IAAI,aAAa,GAAG,KAAK;EACzB,IAAI,aAAa,GAAG,KAAK;EACzB,OAAO,aAAa,GAAG,CAAC,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,EAAE,EAAE;IACnE,aAAa,EAAE;EACjB;EAEA,KAAK,IAAI,GAAG,GAAG,aAAa,EAAE,GAAG,IAAI,KAAK,EAAE,GAAG,EAAE,EAAE;IACjD,MAAM,WAAW,GAAI,GAAG,KAAK,aAAc;IAC3C,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,WAAW,IAAI,oBAAoB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,EAAE;MACzG,aAAa,GAAG,IAAI;MACpB;IACF;EACF;EAEA,OAAO;IACL,aAAa;IACb;EACF,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,wBAAwB,GAAG,CAAC,KAAK,EAAE,aAAa,EAAE,MAAM,KAAK;EACjE;EACA,IAAI,uBAAuB,GAAG,IAAI;EAClC,KAAK,IAAI,GAAG,GAAG,aAAa,GAAG,CAAC,EAAE,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;IAC5D,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,WAAW,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE;MAC7D,uBAAuB,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM;MACjE;IACF;EACF;;EAEA;EACA,MAAM,qBAAqB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM;EACvE,MAAM,WAAW,GAAG,uBAAuB,KAAK,IAAI,IAAI,qBAAqB,GAAG,uBAAuB,GACrG,GAAG,CAAC,MAAM,CAAC,qBAAqB,GAAG,uBAAuB,CAAC,GAC3D,EAAE;EAEJ,OAAO,WAAW;AACpB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,cAAc,GAAG,CAAC;EACtB,cAAc;EACd,iBAAiB;EACjB,MAAM;EACN,oCAAoC;EACpC,IAAI;EACJ;AACF,CAAC,KAAK;EACJ,IAAI,QAAQ,GAAG,KAAK;EACpB;EACA,IAAI,KAAK;;EAET;AACF;AACA;AACA;AACA;EACE,MAAM,WAAW,GAAG,CAAC,MAAM,EAAE,YAAY,KAAK;IAC5C,MAAM,YAAY,GAAG;MACnB,KAAK,EAAE,KAAK;MACZ,IAAI,EAAE,KAAK;MACX,GAAG,EAAE,KAAK;MACV,IAAI,EAAE;IACR,CAAC;IAED,IAAI,MAAM,CAAC,WAAW,KAAK,EAAE,EAAE;MAC7B,YAAY,CAAC,IAAI,GAAG,IAAI;MACxB,MAAM,CAAC,QAAQ,GAAG,EAAE;MAEpB,IAAI,MAAM,CAAC,IAAI,KAAK,EAAE,EAAE;QACtB,YAAY,CAAC,IAAI,GAAG,IAAI;QACxB,MAAM,CAAC,QAAQ,GAAG,EAAE;QAEpB,IAAI,MAAM,CAAC,IAAI,KAAK,EAAE,EAAE;UACtB,YAAY,CAAC,GAAG,GAAG,IAAI;UACvB,MAAM,CAAC,OAAO,GAAG,EAAE;;UAEnB;UACA,IAAI,MAAM,CAAC,GAAG,KAAK,EAAE,EAAE;YACrB,YAAY,CAAC,KAAK,GAAG,IAAI;UAC3B;QACF;MACF;IACF;IAEA,IAAI,qBAAqB,GAAG,CAAC;IAC7B,IAAI,qBAAqB,GAAG,CAAC;IAC7B,IAAI,YAAY,CAAC,UAAU,EAAE;MAC3B,YAAY,CAAC,GAAG,GAAG,IAAI;MACvB,MAAM,CAAC,OAAO,GAAG,EAAE;MACnB,IAAI,MAAM,CAAC,IAAI,KAAK,EAAE,EAAE;QACtB,qBAAqB,GAAG,YAAY,CAAC,iBAAiB,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM;MAC5E,CAAC,MAAM;QACL,qBAAqB,GAAG,YAAY,CAAC,iBAAiB,GAAG,YAAY,CAAC,mBAAmB,GAAG,CAAC,GAC3F,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,mBAAmB,IAAI,MAAM,CAAC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC9F,qBAAqB,GAAG,YAAY,CAAC,iBAAiB,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM;MAC5E;IACF;;IAEA;IACA,IAAI,MAAM,CAAC,GAAG,KAAK,EAAE,IAAI,MAAM,CAAC,IAAI,EAAE;MACpC,OAAO,MAAM;IACf;IAEA,MAAM,QAAQ,GAAG;MACf,aAAa,EAAE,cAAc,EAAE,aAAa,IAAI,CAAC;MACjD,QAAQ,EAAE,cAAc,EAAE,QAAQ,IAAI,CAAC;MACvC,OAAO,EAAE,cAAc,EAAE,OAAO,IAAI,CAAC;MACrC,QAAQ,EAAE,cAAc,EAAE,QAAQ,IAAI;IACxC,CAAC;IAED,MAAM,CAAC,aAAa,GAAG,YAAY,CAAC,KAAK,GAAG,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAC,aAAa,CAAC;IAE9E,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE;MACrB,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC;IAC1E;IAEA,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE;MACtB,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,QAAQ,GAAG,qBAAqB,CAAC;IACtG;IAEA,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE;MACtB;MACA,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC,IAAI,KAAK,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,QAAQ,GAAG,qBAAqB,CAAC;IAC9H;IAEA,OAAO,MAAM;EACf,CAAC;;EAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAM,MAAM,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,SAAS,KAAK;IAC/D;IACA,MAAM,MAAM,GAAG;MACb,GAAG,IAAI,CAAC;IACV,CAAC;IAED,IAAI,MAAM,CAAC,GAAG,KAAK,EAAE,EAAE;MACrB,QAAQ,GAAG,IAAI;IACjB;IAEA,MAAM,OAAO,GACX,MAAM,CAAC,GAAG,KAAK,EAAE,IACjB,MAAM,CAAC,IAAI,KAAK,EAAE,IAClB,MAAM,CAAC,IAAI,KAAK,EAAE,IAClB,MAAM,CAAC,WAAW,KAAK,EAAE;;IAE3B;IACA,IAAI,MAAM,CAAC,GAAG,KAAK,IAAI,IAAI,OAAO,EAAE;MAClC,MAAM,CAAC,KAAK,GAAG,MAAM,GAAG,GAAG;MAE3B,OAAO;QACL,GAAG,IAAI;QACP;MACF,CAAC;IACH;IAEA,QAAQ,MAAM,CAAC,SAAS;MACtB,KAAK,GAAG;QACN,MAAM,CAAC,KAAK,GAAG,MAAM,GAAG,GAAG;QAC3B;MACF,KAAK,KAAK;QACR,MAAM,CAAC,KAAK,GAAG,MAAM;QACrB;MACF;QACE,MAAM,CAAC,SAAS,GAAG,EAAE;;QAErB;QACA,MAAM,CAAC,KAAK,GAAG,MAAM,GAAG,IAAI;IAChC;IAEA,IAAI,CAAC,QAAQ,EAAE;MACb,IAAI,MAAM,CAAC,WAAW,KAAK,EAAE,EAAE;QAC7B,MAAM,CAAC,aAAa,GAAG,EAAE;MAC3B,CAAC,MAAM,IAAI,CAAC,oCAAoC,EAAE;QAChD,MAAM,CAAC,aAAa,GAAG,GAAG;MAC5B;MAEA,OAAO;QACL,GAAG,IAAI;QACP;MACF,CAAC;IACH;IAEA,MAAM,iBAAiB,GAAG,cAAc,EAAE,UAAU,IAAI,CAAC;IACzD,MAAM,aAAa,GAAG,WAAW;IACjC,MAAM,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC,OAAO,CAC7C,aAAa,EAAE,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC,iBAAiB,EAAE,GAAG,CACzD,CAAC;;IAED;IACA,IAAI,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE;MACpC,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC;MAEjC,IAAI,CAAC,iBAAiB,IAAI,SAAS,EAAE;QACnC,MAAM;UACJ,aAAa;UACb;QACF,CAAC,GAAG,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC;QAEtC,IAAI,aAAa,IAAI,KAAK,GAAG,aAAa,EAAE;UAC1C,MAAM,WAAW,GAAG,wBAAwB,CAAC,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC;UAC1E,MAAM,CAAC,aAAa,IAAI,UAAU,GAAG,WAAW;QAClD,CAAC,MAAM;UACL;UACA,MAAM,CAAC,aAAa,IAAI,UAAU;QACpC;MACF;IACF;IAEA,OAAO;MACL,GAAG,IAAI;MACP;IACF,CAAC;EACH,CAAC;EAED,OAAO,CAAC;IACN,MAAM;IACN,GAAG;EACL,CAAC,KAAK;IACJ,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;MACpC,GAAG;IACL,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,CAAC;IAE5C,IAAI,aAAa,GAAG,KAAK;IAEzB,OAAO,YAAY,CAAC;MAClB,GAAG,MAAM;MACT,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,KAAK;QAClC,MAAM,SAAS,GAAG,CAAC,iBAAiB,IAAI,aAAa,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW;QACpG,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,SAAS,CAAC;QAEhE,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;UACzC,aAAa,GAAG,IAAI;QACtB;QAEA,OAAO,GAAG;MACZ,CAAC;IACH,CAAC,CAAC;EACJ,CAAC;AACH,CAAC;AAAC,iCAEa,cAAc;AAAA","ignoreList":[]}

package/dist/buildForbidRuleDefinition.cjs

@@ -1,101 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.buildForbidRuleDefinition = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("./iterateJsdoc.cjs"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * @typedef {(string|{
- *   comment: string,
- *   context: string,
- *   message?: string
- * })[]} Contexts
- */
-
-/**
- * @param {{
- *   contexts?: Contexts,
- *   description?: string,
- *   getContexts?: (
- *     ctxt: import('eslint').Rule.RuleContext,
- *     report: import('./iterateJsdoc.js').Report
- *   ) => Contexts|false,
- *   contextName?: string,
- *   modifyContext?: (context: import('eslint').Rule.RuleContext) => import('eslint').Rule.RuleContext,
- *   schema?: import('eslint').Rule.RuleMetaData['schema']
- *   url?: string,
- * }} cfg
- * @returns {import('eslint').Rule.RuleModule}
- */
-const buildForbidRuleDefinition = ({
-  contextName,
-  contexts: cntxts,
-  description,
-  getContexts,
-  modifyContext,
-  schema,
-  url
-}) => {
-  return (0, _iterateJsdoc.default)(({
-    context,
-    info: {
-      comment
-    },
-    report,
-    utils
-  }) => {
-    /** @type {Contexts|boolean|undefined} */
-    let contexts = cntxts;
-    if (getContexts) {
-      contexts = getContexts(context, report);
-      if (!contexts) {
-        return;
-      }
-    }
-    const {
-      contextStr,
-      foundContext
-    } = utils.findContext(/** @type {Contexts} */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'
-      },
-      schema: schema ?? [],
-      type: 'suggestion'
-    },
-    modifyContext: modifyContext ?? (getContexts ? undefined : 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: cntxts
-          }]
-        }
-      });
-    }),
-    nonGlobalSettings: true
-  });
-};
-exports.buildForbidRuleDefinition = buildForbidRuleDefinition;
-//# sourceMappingURL=buildForbidRuleDefinition.cjs.map

package/dist/buildForbidRuleDefinition.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"buildForbidRuleDefinition.cjs","names":["iterateJsdoc"],"sources":["../src/buildForbidRuleDefinition.js"],"sourcesContent":["import iterateJsdoc from './iterateJsdoc.js';\n\n/**\n * @typedef {(string|{\n *   comment: string,\n *   context: string,\n *   message?: string\n * })[]} Contexts\n */\n\n/**\n * @param {{\n *   contexts?: Contexts,\n *   description?: string,\n *   getContexts?: (\n *     ctxt: import('eslint').Rule.RuleContext,\n *     report: import('./iterateJsdoc.js').Report\n *   ) => Contexts|false,\n *   contextName?: string,\n *   modifyContext?: (context: import('eslint').Rule.RuleContext) => import('eslint').Rule.RuleContext,\n *   schema?: import('eslint').Rule.RuleMetaData['schema']\n *   url?: string,\n * }} cfg\n * @returns {import('eslint').Rule.RuleModule}\n */\nexport const buildForbidRuleDefinition = ({\n  contextName,\n  contexts: cntxts,\n  description,\n  getContexts,\n  modifyContext,\n  schema,\n  url,\n}) => {\n  return iterateJsdoc(({\n    context,\n    info: {\n      comment,\n    },\n    report,\n    utils,\n  }) => {\n    /** @type {Contexts|boolean|undefined} */\n    let contexts = cntxts;\n\n    if (getContexts) {\n      contexts = getContexts(context, report);\n      if (!contexts) {\n        return;\n      }\n    }\n\n    const {\n      contextStr,\n      foundContext,\n    } = utils.findContext(/** @type {Contexts} */ (contexts), comment);\n\n    // We are not on the *particular* matching context/comment, so don't assume\n    //   we need reporting\n    if (!foundContext) {\n      return;\n    }\n\n    const message = /** @type {import('./iterateJsdoc.js').ContextObject} */ (\n      foundContext\n    )?.message ??\n      'Syntax is restricted: {{context}}' +\n        (comment ? ' with {{comment}}' : '');\n\n    report(message, null, null, comment ? {\n      comment,\n      context: contextStr,\n    } : {\n      context: contextStr,\n    });\n  }, {\n    contextSelected: true,\n    meta: {\n      docs: {\n        description: description ?? contextName ?? 'Reports when certain comment structures are present.',\n        url: url ?? 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/advanced.md#user-content-advanced-creating-your-own-rules',\n      },\n      schema: schema ?? [],\n      type: 'suggestion',\n    },\n    modifyContext: modifyContext ?? (getContexts ? undefined : (context) => {\n      // Reproduce context object with our own `contexts`\n      const propertyDescriptors = Object.getOwnPropertyDescriptors(context);\n      return Object.create(\n        Object.getPrototypeOf(context),\n        {\n          ...propertyDescriptors,\n          options: {\n            ...propertyDescriptors.options,\n            value: [\n              {\n                contexts: cntxts,\n              },\n            ],\n          },\n        },\n      );\n    }),\n    nonGlobalSettings: true,\n  });\n};\n"],"mappings":";;;;;;AAAA;AAA6C;AAE7C;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAM,yBAAyB,GAAG,CAAC;EACxC,WAAW;EACX,QAAQ,EAAE,MAAM;EAChB,WAAW;EACX,WAAW;EACX,aAAa;EACb,MAAM;EACN;AACF,CAAC,KAAK;EACJ,OAAO,IAAAA,qBAAY,EAAC,CAAC;IACnB,OAAO;IACP,IAAI,EAAE;MACJ;IACF,CAAC;IACD,MAAM;IACN;EACF,CAAC,KAAK;IACJ;IACA,IAAI,QAAQ,GAAG,MAAM;IAErB,IAAI,WAAW,EAAE;MACf,QAAQ,GAAG,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC;MACvC,IAAI,CAAC,QAAQ,EAAE;QACb;MACF;IACF;IAEA,MAAM;MACJ,UAAU;MACV;IACF,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,uBAAyB,QAAQ,EAAG,OAAO,CAAC;;IAElE;IACA;IACA,IAAI,CAAC,YAAY,EAAE;MACjB;IACF;IAEA,MAAM,OAAO,GAAG,wDACd,YAAY,EACX,OAAO,IACR,mCAAmC,IAChC,OAAO,GAAG,mBAAmB,GAAG,EAAE,CAAC;IAExC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,GAAG;MACpC,OAAO;MACP,OAAO,EAAE;IACX,CAAC,GAAG;MACF,OAAO,EAAE;IACX,CAAC,CAAC;EACJ,CAAC,EAAE;IACD,eAAe,EAAE,IAAI;IACrB,IAAI,EAAE;MACJ,IAAI,EAAE;QACJ,WAAW,EAAE,WAAW,IAAI,WAAW,IAAI,sDAAsD;QACjG,GAAG,EAAE,GAAG,IAAI;MACd,CAAC;MACD,MAAM,EAAE,MAAM,IAAI,EAAE;MACpB,IAAI,EAAE;IACR,CAAC;IACD,aAAa,EAAE,aAAa,KAAK,WAAW,GAAG,SAAS,GAAI,OAAO,IAAK;MACtE;MACA,MAAM,mBAAmB,GAAG,MAAM,CAAC,yBAAyB,CAAC,OAAO,CAAC;MACrE,OAAO,MAAM,CAAC,MAAM,CAClB,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,EAC9B;QACE,GAAG,mBAAmB;QACtB,OAAO,EAAE;UACP,GAAG,mBAAmB,CAAC,OAAO;UAC9B,KAAK,EAAE,CACL;YACE,QAAQ,EAAE;UACZ,CAAC;QAEL;MACF,CACF,CAAC;IACH,CAAC,CAAC;IACF,iBAAiB,EAAE;EACrB,CAAC,CAAC;AACJ,CAAC;AAAC","ignoreList":[]}