eslint-plugin-jsdoc 63.3.3 → 64.0.0

package/dist/rules/multilineBlocks.cjs

@@ -1,431 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * @param {import('@es-joy/jsdoccomment').JsdocBlockWithInline} jsdoc
- * @param {import('../iterateJsdoc.js').Utils} utils
- * @param {number} requireSingleLineUnderCount
- */
-const checkForShortTags = (jsdoc, utils, requireSingleLineUnderCount) => {
-  if (!requireSingleLineUnderCount || !jsdoc.tags.length) {
-    return false;
-  }
-  let lastLineWithTag = 0;
-  let isUnderCountLimit = false;
-  let hasMultiDescOrType = false;
-  const tagLines = jsdoc.source.reduce((acc, {
-    tokens: {
-      delimiter,
-      description: desc,
-      name,
-      postDelimiter,
-      postName,
-      postTag,
-      postType,
-      start,
-      tag,
-      type
-    }
-  }, idx) => {
-    if (tag.length) {
-      lastLineWithTag = idx;
-      if (start.length + delimiter.length + postDelimiter.length + type.length + postType.length + name.length + postName.length + tag.length + postTag.length + desc.length < requireSingleLineUnderCount) {
-        isUnderCountLimit = true;
-      }
-      return acc + 1;
-    } else if (desc.length || type.length) {
-      hasMultiDescOrType = true;
-      return acc;
-    }
-    return acc;
-  }, 0);
-  // Could be tagLines > 1
-  if (!hasMultiDescOrType && isUnderCountLimit && tagLines === 1) {
-    const fixer = () => {
-      const tokens = jsdoc.source[lastLineWithTag].tokens;
-      jsdoc.source = [{
-        number: 0,
-        source: '',
-        tokens: utils.seedTokens({
-          delimiter: '/**',
-          description: tokens.description.trimEnd() + ' ',
-          end: '*/',
-          name: tokens.name,
-          postDelimiter: ' ',
-          postName: tokens.postName,
-          postTag: tokens.postTag,
-          postType: tokens.postType,
-          start: jsdoc.source[0].tokens.start,
-          tag: tokens.tag,
-          type: tokens.type
-        })
-      }];
-    };
-    utils.reportJSDoc('Description is too short to be multi-line.', null, fixer);
-    return true;
-  }
-  return false;
-};
-
-/**
- * @param {import('@es-joy/jsdoccomment').JsdocBlockWithInline} jsdoc
- * @param {import('../iterateJsdoc.js').Utils} utils
- * @param {number} requireSingleLineUnderCount
- */
-const checkForShortDescriptions = (jsdoc, utils, requireSingleLineUnderCount) => {
-  if (!requireSingleLineUnderCount || jsdoc.tags.length) {
-    return false;
-  }
-  let lastLineWithDesc = 0;
-  let isUnderCountLimit = false;
-  const descLines = jsdoc.source.reduce((acc, {
-    tokens: {
-      delimiter,
-      description: desc,
-      postDelimiter,
-      start
-    }
-  }, idx) => {
-    if (desc.length) {
-      lastLineWithDesc = idx;
-      if (start.length + delimiter.length + postDelimiter.length + desc.length < requireSingleLineUnderCount) {
-        isUnderCountLimit = true;
-      }
-      return acc + 1;
-    }
-    return acc;
-  }, 0);
-  // Could be descLines > 1
-  if (isUnderCountLimit && descLines === 1) {
-    const fixer = () => {
-      const desc = jsdoc.source[lastLineWithDesc].tokens.description;
-      jsdoc.source = [{
-        number: 0,
-        source: '',
-        tokens: utils.seedTokens({
-          delimiter: '/**',
-          description: desc.trimEnd() + ' ',
-          end: '*/',
-          postDelimiter: ' ',
-          start: jsdoc.source[0].tokens.start
-        })
-      }];
-    };
-    utils.reportJSDoc('Description is too short to be multi-line.', null, fixer);
-    return true;
-  }
-  return false;
-};
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  context,
-  jsdoc,
-  utils
-}) => {
-  const {
-    allowMultipleTags = true,
-    minimumLengthForMultiline = Number.POSITIVE_INFINITY,
-    multilineTags = ['*'],
-    noFinalLineText = true,
-    noMultilineBlocks = false,
-    noSingleLineBlocks = false,
-    noZeroLineText = true,
-    requireSingleLineUnderCount = null,
-    singleLineTags = ['lends', 'type']
-  } = context.options[0] || {};
-  const {
-    source: [{
-      tokens
-    }]
-  } = jsdoc;
-  const {
-    description,
-    tag
-  } = tokens;
-  const sourceLength = jsdoc.source.length;
-
-  /**
-   * @param {string} tagName
-   * @returns {boolean}
-   */
-  const isInvalidSingleLine = tagName => {
-    return noSingleLineBlocks && (!tagName || !singleLineTags.includes(tagName) && !singleLineTags.includes('*'));
-  };
-  if (sourceLength === 1) {
-    if (!isInvalidSingleLine(tag.slice(1))) {
-      return;
-    }
-    const fixer = () => {
-      utils.makeMultiline();
-    };
-    utils.reportJSDoc('Single line blocks are not permitted by your configuration.', null, fixer, true);
-    return;
-  }
-  if (checkForShortDescriptions(jsdoc, utils, requireSingleLineUnderCount)) {
-    return;
-  }
-  if (checkForShortTags(jsdoc, utils, requireSingleLineUnderCount)) {
-    return;
-  }
-  const lineChecks = () => {
-    if (noZeroLineText && (tag || description)) {
-      const fixer = () => {
-        const line = {
-          ...tokens
-        };
-        utils.emptyTokens(tokens);
-        const {
-          tokens: {
-            delimiter,
-            start
-          }
-        } = jsdoc.source[1];
-        utils.addLine(1, {
-          ...line,
-          delimiter,
-          start
-        });
-      };
-      utils.reportJSDoc('Should have no text on the "0th" line (after the `/**`).', null, fixer);
-      return;
-    }
-    const finalLine = jsdoc.source[jsdoc.source.length - 1];
-    const finalLineTokens = finalLine.tokens;
-    if (noFinalLineText && finalLineTokens.description.trim()) {
-      const fixer = () => {
-        const line = {
-          ...finalLineTokens
-        };
-        line.description = line.description.trimEnd();
-        const {
-          delimiter
-        } = line;
-        for (const prop of ['delimiter', 'postDelimiter', 'tag', 'type', 'lineEnd', 'postType', 'postTag', 'name', 'postName', 'description']) {
-          finalLineTokens[(
-          /**
-           * @type {"delimiter"|"postDelimiter"|"tag"|"type"|
-           *   "lineEnd"|"postType"|"postTag"|"name"|
-           *   "postName"|"description"}
-           */
-          prop)] = '';
-        }
-        utils.addLine(jsdoc.source.length - 1, {
-          ...line,
-          delimiter,
-          end: ''
-        });
-      };
-      utils.reportJSDoc('Should have no text on the final line (before the `*/`).', null, fixer);
-    }
-  };
-  if (noMultilineBlocks) {
-    if (jsdoc.tags.length && (multilineTags.includes('*') || utils.hasATag(multilineTags))) {
-      lineChecks();
-      return;
-    }
-    if (jsdoc.description.length >= minimumLengthForMultiline) {
-      lineChecks();
-      return;
-    }
-    if (noSingleLineBlocks && (!jsdoc.tags.length || !utils.filterTags(({
-      tag: tg
-    }) => {
-      return !isInvalidSingleLine(tg);
-    }).length)) {
-      utils.reportJSDoc('Multiline JSDoc blocks are prohibited by ' + 'your configuration but fixing would result in a single ' + 'line block which you have prohibited with `noSingleLineBlocks`.');
-      return;
-    }
-    if (jsdoc.tags.length > 1) {
-      if (!allowMultipleTags) {
-        utils.reportJSDoc('Multiline JSDoc blocks are prohibited by ' + 'your configuration but the block has multiple tags.');
-        return;
-      }
-    } else if (jsdoc.tags.length === 1 && jsdoc.description.trim()) {
-      if (!allowMultipleTags) {
-        utils.reportJSDoc('Multiline JSDoc blocks are prohibited by ' + 'your configuration but the block has a description with a tag.');
-        return;
-      }
-    } else {
-      const fixer = () => {
-        jsdoc.source = [{
-          number: 1,
-          source: '',
-          tokens: jsdoc.source.reduce((obj, {
-            tokens: {
-              description: desc,
-              lineEnd,
-              name: nme,
-              postName,
-              postTag,
-              postType,
-              tag: tg,
-              type: typ
-            }
-          }) => {
-            if (typ) {
-              obj.type = typ;
-            }
-            if (tg && typ && nme) {
-              obj.postType = postType;
-            }
-            if (nme) {
-              obj.name += nme;
-            }
-            if (nme && desc) {
-              obj.postName = postName;
-            }
-            obj.description += desc;
-            const nameOrDescription = obj.description || obj.name;
-            if (nameOrDescription && nameOrDescription.slice(-1) !== ' ') {
-              obj.description += ' ';
-            }
-            obj.lineEnd = lineEnd;
-
-            // Already filtered for multiple tags
-            obj.tag += tg;
-            if (tg) {
-              obj.postTag = postTag || ' ';
-            }
-            return obj;
-          }, utils.seedTokens({
-            delimiter: '/**',
-            end: '*/',
-            postDelimiter: ' '
-          }))
-        }];
-      };
-      utils.reportJSDoc('Multiline JSDoc blocks are prohibited by ' + 'your configuration.', null, fixer);
-      return;
-    }
-  }
-  lineChecks();
-}, {
-  iterateAllJsdocs: true,
-  meta: {
-    docs: {
-      description: 'Controls how and whether JSDoc blocks can be expressed as single or multiple line blocks.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/multiline-blocks.md#repos-sticky-header'
-    },
-    fixable: 'code',
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        allowMultipleTags: {
-          description: `If \`noMultilineBlocks\` is set to \`true\` with this option and multiple tags are
-found in a block, an error will not be reported.
-
-Since multiple-tagged lines cannot be collapsed into a single line, this option
-prevents them from being reported. Set to \`false\` if you really want to report
-any blocks.
-
-This option will also be applied when there is a block description and a single
-tag (since a description cannot precede a tag on a single line, and also
-cannot be reliably added after the tag either).
-
-Defaults to \`true\`.`,
-          type: 'boolean'
-        },
-        minimumLengthForMultiline: {
-          description: `If \`noMultilineBlocks\` is set with this numeric option, multiline blocks will
-be permitted if containing at least the given amount of text.
-
-If not set, multiline blocks will not be permitted regardless of length unless
-a relevant tag is present and \`multilineTags\` is set.
-
-Defaults to not being in effect.`,
-          type: 'integer'
-        },
-        multilineTags: {
-          anyOf: [{
-            enum: ['*'],
-            type: 'string'
-          }, {
-            items: {
-              type: 'string'
-            },
-            type: 'array'
-          }],
-          description: `If \`noMultilineBlocks\` is set with this option, multiline blocks may be allowed
-regardless of length as long as a tag or a tag of a certain type is present.
-
-If \`*\` is included in the array, the presence of a tags will allow for
-multiline blocks (but not when without any tags unless the amount of text is
-over an amount specified by \`minimumLengthForMultiline\`).
-
-If the array does not include \`*\` but lists certain tags, the presence of
-such a tag will cause multiline blocks to be allowed.
-
-You may set this to an empty array to prevent any tag from permitting multiple
-lines.
-
-Defaults to \`['*']\`.`
-        },
-        noFinalLineText: {
-          description: `For multiline blocks, any non-whitespace text preceding the \`*/\` on the final
-line will be reported. (Text preceding a newline is not reported.)
-
-\`noMultilineBlocks\` will have priority over this rule if it applies.
-
-Defaults to \`true\`.`,
-          type: 'boolean'
-        },
-        noMultilineBlocks: {
-          description: `Requires that JSDoc blocks are restricted to single lines only unless impacted
-by the options \`minimumLengthForMultiline\`, \`multilineTags\`, or
-\`allowMultipleTags\`.
-
-Defaults to \`false\`.`,
-          type: 'boolean'
-        },
-        noSingleLineBlocks: {
-          description: `If this is \`true\`, any single line blocks will be reported, except those which
-are whitelisted in \`singleLineTags\`.
-
-Defaults to \`false\`.`,
-          type: 'boolean'
-        },
-        noZeroLineText: {
-          description: `For multiline blocks, any non-whitespace text immediately after the \`/**\` and
-space will be reported. (Text after a newline is not reported.)
-
-\`noMultilineBlocks\` will have priority over this rule if it applies.
-
-Defaults to \`true\`.`,
-          type: 'boolean'
-        },
-        requireSingleLineUnderCount: {
-          description: `If this number is set, it indicates a minimum line width for a single line of
-JSDoc content spread over a multi-line comment block. If a single line is under
-the minimum length, it will be reported so as to enforce single line JSDoc blocks
-for such cases. Blocks are not reported which have multi-line descriptions,
-multiple tags, a block description and tag, or tags with multi-line types or
-descriptions.
-
-Defaults to \`null\`.`,
-          type: 'number'
-        },
-        singleLineTags: {
-          description: `An array of tags which can nevertheless be allowed as single line blocks when
-\`noSingleLineBlocks\` is set.  You may set this to a empty array to
-cause all single line blocks to be reported. If \`'*'\` is present, then
-the presence of a tag will allow single line blocks (but not if a tag is
-missing).
-
-Defaults to \`['lends', 'type']\`.`,
-          items: {
-            type: 'string'
-          },
-          type: 'array'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'suggestion'
-  }
-});
-module.exports = exports.default;
-//# sourceMappingURL=multilineBlocks.cjs.map

package/dist/rules/multilineBlocks.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"multilineBlocks.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/multilineBlocks.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {import('@es-joy/jsdoccomment').JsdocBlockWithInline} jsdoc\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {number} requireSingleLineUnderCount\n */\nconst checkForShortTags = (jsdoc, utils, requireSingleLineUnderCount) => {\n  if (!requireSingleLineUnderCount || !jsdoc.tags.length) {\n    return false;\n  }\n\n  let lastLineWithTag = 0;\n  let isUnderCountLimit = false;\n  let hasMultiDescOrType = false;\n  const tagLines = jsdoc.source.reduce((acc, {\n    tokens: {\n      delimiter,\n      description: desc,\n      name,\n      postDelimiter,\n      postName,\n      postTag,\n      postType,\n      start,\n      tag,\n      type,\n    },\n  }, idx) => {\n    if (tag.length) {\n      lastLineWithTag = idx;\n      if (\n        start.length + delimiter.length + postDelimiter.length +\n        type.length + postType.length + name.length + postName.length +\n        tag.length + postTag.length + desc.length <\n          requireSingleLineUnderCount\n      ) {\n        isUnderCountLimit = true;\n      }\n\n      return acc + 1;\n    } else if (desc.length || type.length) {\n      hasMultiDescOrType = true;\n      return acc;\n    }\n\n    return acc;\n  }, 0);\n  // Could be tagLines > 1\n  if (!hasMultiDescOrType && isUnderCountLimit && tagLines === 1) {\n    const fixer = () => {\n      const tokens = jsdoc.source[lastLineWithTag].tokens;\n      jsdoc.source = [\n        {\n          number: 0,\n          source: '',\n          tokens: utils.seedTokens({\n            delimiter: '/**',\n            description: tokens.description.trimEnd() + ' ',\n            end: '*/',\n            name: tokens.name,\n            postDelimiter: ' ',\n            postName: tokens.postName,\n            postTag: tokens.postTag,\n            postType: tokens.postType,\n            start: jsdoc.source[0].tokens.start,\n            tag: tokens.tag,\n            type: tokens.type,\n          }),\n        },\n      ];\n    };\n\n    utils.reportJSDoc(\n      'Description is too short to be multi-line.',\n      null,\n      fixer,\n    );\n    return true;\n  }\n\n  return false;\n};\n\n/**\n * @param {import('@es-joy/jsdoccomment').JsdocBlockWithInline} jsdoc\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @param {number} requireSingleLineUnderCount\n */\nconst checkForShortDescriptions = (jsdoc, utils, requireSingleLineUnderCount) => {\n  if (!requireSingleLineUnderCount || jsdoc.tags.length) {\n    return false;\n  }\n\n  let lastLineWithDesc = 0;\n  let isUnderCountLimit = false;\n  const descLines = jsdoc.source.reduce((acc, {\n    tokens: {\n      delimiter,\n      description: desc,\n      postDelimiter,\n      start,\n    },\n  }, idx) => {\n    if (desc.length) {\n      lastLineWithDesc = idx;\n      if (\n        start.length + delimiter.length + postDelimiter.length + desc.length <\n          requireSingleLineUnderCount\n      ) {\n        isUnderCountLimit = true;\n      }\n\n      return acc + 1;\n    }\n\n    return acc;\n  }, 0);\n  // Could be descLines > 1\n  if (isUnderCountLimit && descLines === 1) {\n    const fixer = () => {\n      const desc = jsdoc.source[lastLineWithDesc].tokens.description;\n      jsdoc.source = [\n        {\n          number: 0,\n          source: '',\n          tokens: utils.seedTokens({\n            delimiter: '/**',\n            description: desc.trimEnd() + ' ',\n            end: '*/',\n            postDelimiter: ' ',\n            start: jsdoc.source[0].tokens.start,\n          }),\n        },\n      ];\n    };\n\n    utils.reportJSDoc(\n      'Description is too short to be multi-line.',\n      null,\n      fixer,\n    );\n    return true;\n  }\n\n  return false;\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  const {\n    allowMultipleTags = true,\n    minimumLengthForMultiline = Number.POSITIVE_INFINITY,\n    multilineTags = [\n      '*',\n    ],\n    noFinalLineText = true,\n    noMultilineBlocks = false,\n    noSingleLineBlocks = false,\n    noZeroLineText = true,\n    requireSingleLineUnderCount = null,\n    singleLineTags = [\n      'lends', 'type',\n    ],\n  } = context.options[0] || {};\n\n  const {\n    source: [\n      {\n        tokens,\n      },\n    ],\n  } = jsdoc;\n  const {\n    description,\n    tag,\n  } = tokens;\n  const sourceLength = jsdoc.source.length;\n\n  /**\n   * @param {string} tagName\n   * @returns {boolean}\n   */\n  const isInvalidSingleLine = (tagName) => {\n    return noSingleLineBlocks &&\n      (!tagName ||\n      !singleLineTags.includes(tagName) && !singleLineTags.includes('*'));\n  };\n\n  if (sourceLength === 1) {\n    if (!isInvalidSingleLine(tag.slice(1))) {\n      return;\n    }\n\n    const fixer = () => {\n      utils.makeMultiline();\n    };\n\n    utils.reportJSDoc(\n      'Single line blocks are not permitted by your configuration.',\n      null,\n      fixer,\n      true,\n    );\n\n    return;\n  }\n\n  if (checkForShortDescriptions(jsdoc, utils, requireSingleLineUnderCount)\n  ) {\n    return;\n  }\n\n  if (checkForShortTags(jsdoc, utils, requireSingleLineUnderCount)\n  ) {\n    return;\n  }\n\n  const lineChecks = () => {\n    if (\n      noZeroLineText &&\n      (tag || description)\n    ) {\n      const fixer = () => {\n        const line = {\n          ...tokens,\n        };\n        utils.emptyTokens(tokens);\n        const {\n          tokens: {\n            delimiter,\n            start,\n          },\n        } = jsdoc.source[1];\n        utils.addLine(1, {\n          ...line,\n          delimiter,\n          start,\n        });\n      };\n\n      utils.reportJSDoc(\n        'Should have no text on the \"0th\" line (after the `/**`).',\n        null,\n        fixer,\n      );\n\n      return;\n    }\n\n    const finalLine = jsdoc.source[jsdoc.source.length - 1];\n    const finalLineTokens = finalLine.tokens;\n    if (\n      noFinalLineText &&\n      finalLineTokens.description.trim()\n    ) {\n      const fixer = () => {\n        const line = {\n          ...finalLineTokens,\n        };\n        line.description = line.description.trimEnd();\n\n        const {\n          delimiter,\n        } = line;\n\n        for (const prop of [\n          'delimiter',\n          'postDelimiter',\n          'tag',\n          'type',\n          'lineEnd',\n          'postType',\n          'postTag',\n          'name',\n          'postName',\n          'description',\n        ]) {\n          finalLineTokens[\n            /**\n             * @type {\"delimiter\"|\"postDelimiter\"|\"tag\"|\"type\"|\n             *   \"lineEnd\"|\"postType\"|\"postTag\"|\"name\"|\n             *   \"postName\"|\"description\"}\n             */ (\n              prop\n            )\n          ] = '';\n        }\n\n        utils.addLine(jsdoc.source.length - 1, {\n          ...line,\n          delimiter,\n          end: '',\n        });\n      };\n\n      utils.reportJSDoc(\n        'Should have no text on the final line (before the `*/`).',\n        null,\n        fixer,\n      );\n    }\n  };\n\n  if (noMultilineBlocks) {\n    if (\n      jsdoc.tags.length &&\n      (multilineTags.includes('*') || utils.hasATag(multilineTags))\n    ) {\n      lineChecks();\n\n      return;\n    }\n\n    if (jsdoc.description.length >= minimumLengthForMultiline) {\n      lineChecks();\n\n      return;\n    }\n\n    if (\n      noSingleLineBlocks &&\n      (!jsdoc.tags.length ||\n      !utils.filterTags(({\n        tag: tg,\n      }) => {\n        return !isInvalidSingleLine(tg);\n      }).length)\n    ) {\n      utils.reportJSDoc(\n        'Multiline JSDoc blocks are prohibited by ' +\n          'your configuration but fixing would result in a single ' +\n          'line block which you have prohibited with `noSingleLineBlocks`.',\n      );\n\n      return;\n    }\n\n    if (jsdoc.tags.length > 1) {\n      if (!allowMultipleTags) {\n        utils.reportJSDoc(\n          'Multiline JSDoc blocks are prohibited by ' +\n            'your configuration but the block has multiple tags.',\n        );\n\n        return;\n      }\n    } else if (jsdoc.tags.length === 1 && jsdoc.description.trim()) {\n      if (!allowMultipleTags) {\n        utils.reportJSDoc(\n          'Multiline JSDoc blocks are prohibited by ' +\n            'your configuration but the block has a description with a tag.',\n        );\n\n        return;\n      }\n    } else {\n      const fixer = () => {\n        jsdoc.source = [\n          {\n            number: 1,\n            source: '',\n            tokens: jsdoc.source.reduce((obj, {\n              tokens: {\n                description: desc,\n                lineEnd,\n                name: nme,\n                postName,\n                postTag,\n                postType,\n                tag: tg,\n                type: typ,\n              },\n            }) => {\n              if (typ) {\n                obj.type = typ;\n              }\n\n              if (tg && typ && nme) {\n                obj.postType = postType;\n              }\n\n              if (nme) {\n                obj.name += nme;\n              }\n\n              if (nme && desc) {\n                obj.postName = postName;\n              }\n\n              obj.description += desc;\n\n              const nameOrDescription = obj.description || obj.name;\n              if (\n                nameOrDescription && nameOrDescription.slice(-1) !== ' '\n              ) {\n                obj.description += ' ';\n              }\n\n              obj.lineEnd = lineEnd;\n\n              // Already filtered for multiple tags\n              obj.tag += tg;\n              if (tg) {\n                obj.postTag = postTag || ' ';\n              }\n\n              return obj;\n            }, utils.seedTokens({\n              delimiter: '/**',\n              end: '*/',\n              postDelimiter: ' ',\n            })),\n          },\n        ];\n      };\n\n      utils.reportJSDoc(\n        'Multiline JSDoc blocks are prohibited by ' +\n          'your configuration.',\n        null,\n        fixer,\n      );\n\n      return;\n    }\n  }\n\n  lineChecks();\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Controls how and whether JSDoc blocks can be expressed as single or multiple line blocks.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/multiline-blocks.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          allowMultipleTags: {\n            description: `If \\`noMultilineBlocks\\` is set to \\`true\\` with this option and multiple tags are\nfound in a block, an error will not be reported.\n\nSince multiple-tagged lines cannot be collapsed into a single line, this option\nprevents them from being reported. Set to \\`false\\` if you really want to report\nany blocks.\n\nThis option will also be applied when there is a block description and a single\ntag (since a description cannot precede a tag on a single line, and also\ncannot be reliably added after the tag either).\n\nDefaults to \\`true\\`.`,\n            type: 'boolean',\n          },\n          minimumLengthForMultiline: {\n            description: `If \\`noMultilineBlocks\\` is set with this numeric option, multiline blocks will\nbe permitted if containing at least the given amount of text.\n\nIf not set, multiline blocks will not be permitted regardless of length unless\na relevant tag is present and \\`multilineTags\\` is set.\n\nDefaults to not being in effect.`,\n            type: 'integer',\n          },\n          multilineTags: {\n            anyOf: [\n              {\n                enum: [\n                  '*',\n                ],\n                type: 'string',\n              }, {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n            ],\n            description: `If \\`noMultilineBlocks\\` is set with this option, multiline blocks may be allowed\nregardless of length as long as a tag or a tag of a certain type is present.\n\nIf \\`*\\` is included in the array, the presence of a tags will allow for\nmultiline blocks (but not when without any tags unless the amount of text is\nover an amount specified by \\`minimumLengthForMultiline\\`).\n\nIf the array does not include \\`*\\` but lists certain tags, the presence of\nsuch a tag will cause multiline blocks to be allowed.\n\nYou may set this to an empty array to prevent any tag from permitting multiple\nlines.\n\nDefaults to \\`['*']\\`.`,\n          },\n          noFinalLineText: {\n            description: `For multiline blocks, any non-whitespace text preceding the \\`*/\\` on the final\nline will be reported. (Text preceding a newline is not reported.)\n\n\\`noMultilineBlocks\\` will have priority over this rule if it applies.\n\nDefaults to \\`true\\`.`,\n            type: 'boolean',\n          },\n          noMultilineBlocks: {\n            description: `Requires that JSDoc blocks are restricted to single lines only unless impacted\nby the options \\`minimumLengthForMultiline\\`, \\`multilineTags\\`, or\n\\`allowMultipleTags\\`.\n\nDefaults to \\`false\\`.`,\n            type: 'boolean',\n          },\n          noSingleLineBlocks: {\n            description: `If this is \\`true\\`, any single line blocks will be reported, except those which\nare whitelisted in \\`singleLineTags\\`.\n\nDefaults to \\`false\\`.`,\n            type: 'boolean',\n          },\n          noZeroLineText: {\n            description: `For multiline blocks, any non-whitespace text immediately after the \\`/**\\` and\nspace will be reported. (Text after a newline is not reported.)\n\n\\`noMultilineBlocks\\` will have priority over this rule if it applies.\n\nDefaults to \\`true\\`.`,\n            type: 'boolean',\n          },\n          requireSingleLineUnderCount: {\n            description: `If this number is set, it indicates a minimum line width for a single line of\nJSDoc content spread over a multi-line comment block. If a single line is under\nthe minimum length, it will be reported so as to enforce single line JSDoc blocks\nfor such cases. Blocks are not reported which have multi-line descriptions,\nmultiple tags, a block description and tag, or tags with multi-line types or\ndescriptions.\n\nDefaults to \\`null\\`.`,\n            type: 'number',\n          },\n          singleLineTags: {\n            description: `An array of tags which can nevertheless be allowed as single line blocks when\n\\`noSingleLineBlocks\\` is set.  You may set this to a empty array to\ncause all single line blocks to be reported. If \\`'*'\\` is present, then\nthe presence of a tag will allow single line blocks (but not if a tag is\nmissing).\n\nDefaults to \\`['lends', 'type']\\`.`,\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA;AAA8C;AAE9C;AACA;AACA;AACA;AACA;AACA,MAAM,iBAAiB,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,2BAA2B,KAAK;EACvE,IAAI,CAAC,2BAA2B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE;IACtD,OAAO,KAAK;EACd;EAEA,IAAI,eAAe,GAAG,CAAC;EACvB,IAAI,iBAAiB,GAAG,KAAK;EAC7B,IAAI,kBAAkB,GAAG,KAAK;EAC9B,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE;IACzC,MAAM,EAAE;MACN,SAAS;MACT,WAAW,EAAE,IAAI;MACjB,IAAI;MACJ,aAAa;MACb,QAAQ;MACR,OAAO;MACP,QAAQ;MACR,KAAK;MACL,GAAG;MACH;IACF;EACF,CAAC,EAAE,GAAG,KAAK;IACT,IAAI,GAAG,CAAC,MAAM,EAAE;MACd,eAAe,GAAG,GAAG;MACrB,IACE,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,GACtD,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,GAC7D,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,GACvC,2BAA2B,EAC7B;QACA,iBAAiB,GAAG,IAAI;MAC1B;MAEA,OAAO,GAAG,GAAG,CAAC;IAChB,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,EAAE;MACrC,kBAAkB,GAAG,IAAI;MACzB,OAAO,GAAG;IACZ;IAEA,OAAO,GAAG;EACZ,CAAC,EAAE,CAAC,CAAC;EACL;EACA,IAAI,CAAC,kBAAkB,IAAI,iBAAiB,IAAI,QAAQ,KAAK,CAAC,EAAE;IAC9D,MAAM,KAAK,GAAG,MAAM;MAClB,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,MAAM;MACnD,KAAK,CAAC,MAAM,GAAG,CACb;QACE,MAAM,EAAE,CAAC;QACT,MAAM,EAAE,EAAE;QACV,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC;UACvB,SAAS,EAAE,KAAK;UAChB,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,GAAG,GAAG;UAC/C,GAAG,EAAE,IAAI;UACT,IAAI,EAAE,MAAM,CAAC,IAAI;UACjB,aAAa,EAAE,GAAG;UAClB,QAAQ,EAAE,MAAM,CAAC,QAAQ;UACzB,OAAO,EAAE,MAAM,CAAC,OAAO;UACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;UACzB,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK;UACnC,GAAG,EAAE,MAAM,CAAC,GAAG;UACf,IAAI,EAAE,MAAM,CAAC;QACf,CAAC;MACH,CAAC,CACF;IACH,CAAC;IAED,KAAK,CAAC,WAAW,CACf,4CAA4C,EAC5C,IAAI,EACJ,KACF,CAAC;IACD,OAAO,IAAI;EACb;EAEA,OAAO,KAAK;AACd,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAM,yBAAyB,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,2BAA2B,KAAK;EAC/E,IAAI,CAAC,2BAA2B,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE;IACrD,OAAO,KAAK;EACd;EAEA,IAAI,gBAAgB,GAAG,CAAC;EACxB,IAAI,iBAAiB,GAAG,KAAK;EAC7B,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE;IAC1C,MAAM,EAAE;MACN,SAAS;MACT,WAAW,EAAE,IAAI;MACjB,aAAa;MACb;IACF;EACF,CAAC,EAAE,GAAG,KAAK;IACT,IAAI,IAAI,CAAC,MAAM,EAAE;MACf,gBAAgB,GAAG,GAAG;MACtB,IACE,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,GAClE,2BAA2B,EAC7B;QACA,iBAAiB,GAAG,IAAI;MAC1B;MAEA,OAAO,GAAG,GAAG,CAAC;IAChB;IAEA,OAAO,GAAG;EACZ,CAAC,EAAE,CAAC,CAAC;EACL;EACA,IAAI,iBAAiB,IAAI,SAAS,KAAK,CAAC,EAAE;IACxC,MAAM,KAAK,GAAG,MAAM;MAClB,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,WAAW;MAC9D,KAAK,CAAC,MAAM,GAAG,CACb;QACE,MAAM,EAAE,CAAC;QACT,MAAM,EAAE,EAAE;QACV,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC;UACvB,SAAS,EAAE,KAAK;UAChB,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,GAAG;UACjC,GAAG,EAAE,IAAI;UACT,aAAa,EAAE,GAAG;UAClB,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAChC,CAAC;MACH,CAAC,CACF;IACH,CAAC;IAED,KAAK,CAAC,WAAW,CACf,4CAA4C,EAC5C,IAAI,EACJ,KACF,CAAC;IACD,OAAO,IAAI;EACb;EAEA,OAAO,KAAK;AACd,CAAC;AAAC,iCAEa,IAAAA,qBAAY,EAAC,CAAC;EAC3B,OAAO;EACP,KAAK;EACL;AACF,CAAC,KAAK;EACJ,MAAM;IACJ,iBAAiB,GAAG,IAAI;IACxB,yBAAyB,GAAG,MAAM,CAAC,iBAAiB;IACpD,aAAa,GAAG,CACd,GAAG,CACJ;IACD,eAAe,GAAG,IAAI;IACtB,iBAAiB,GAAG,KAAK;IACzB,kBAAkB,GAAG,KAAK;IAC1B,cAAc,GAAG,IAAI;IACrB,2BAA2B,GAAG,IAAI;IAClC,cAAc,GAAG,CACf,OAAO,EAAE,MAAM;EAEnB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,MAAM;IACJ,MAAM,EAAE,CACN;MACE;IACF,CAAC;EAEL,CAAC,GAAG,KAAK;EACT,MAAM;IACJ,WAAW;IACX;EACF,CAAC,GAAG,MAAM;EACV,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM;;EAExC;AACF;AACA;AACA;EACE,MAAM,mBAAmB,GAAI,OAAO,IAAK;IACvC,OAAO,kBAAkB,KACtB,CAAC,OAAO,IACT,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;EACvE,CAAC;EAED,IAAI,YAAY,KAAK,CAAC,EAAE;IACtB,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;MACtC;IACF;IAEA,MAAM,KAAK,GAAG,MAAM;MAClB,KAAK,CAAC,aAAa,CAAC,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,WAAW,CACf,6DAA6D,EAC7D,IAAI,EACJ,KAAK,EACL,IACF,CAAC;IAED;EACF;EAEA,IAAI,yBAAyB,CAAC,KAAK,EAAE,KAAK,EAAE,2BAA2B,CAAC,EACtE;IACA;EACF;EAEA,IAAI,iBAAiB,CAAC,KAAK,EAAE,KAAK,EAAE,2BAA2B,CAAC,EAC9D;IACA;EACF;EAEA,MAAM,UAAU,GAAG,MAAM;IACvB,IACE,cAAc,KACb,GAAG,IAAI,WAAW,CAAC,EACpB;MACA,MAAM,KAAK,GAAG,MAAM;QAClB,MAAM,IAAI,GAAG;UACX,GAAG;QACL,CAAC;QACD,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC;QACzB,MAAM;UACJ,MAAM,EAAE;YACN,SAAS;YACT;UACF;QACF,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;QACnB,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE;UACf,GAAG,IAAI;UACP,SAAS;UACT;QACF,CAAC,CAAC;MACJ,CAAC;MAED,KAAK,CAAC,WAAW,CACf,0DAA0D,EAC1D,IAAI,EACJ,KACF,CAAC;MAED;IACF;IAEA,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IACvD,MAAM,eAAe,GAAG,SAAS,CAAC,MAAM;IACxC,IACE,eAAe,IACf,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,EAClC;MACA,MAAM,KAAK,GAAG,MAAM;QAClB,MAAM,IAAI,GAAG;UACX,GAAG;QACL,CAAC;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAE7C,MAAM;UACJ;QACF,CAAC,GAAG,IAAI;QAER,KAAK,MAAM,IAAI,IAAI,CACjB,WAAW,EACX,eAAe,EACf,KAAK,EACL,MAAM,EACN,SAAS,EACT,UAAU,EACV,SAAS,EACT,MAAM,EACN,UAAU,EACV,aAAa,CACd,EAAE;UACD,eAAe;UACb;AACZ;AACA;AACA;AACA;UACc,IAAI,EAEP,GAAG,EAAE;QACR;QAEA,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;UACrC,GAAG,IAAI;UACP,SAAS;UACT,GAAG,EAAE;QACP,CAAC,CAAC;MACJ,CAAC;MAED,KAAK,CAAC,WAAW,CACf,0DAA0D,EAC1D,IAAI,EACJ,KACF,CAAC;IACH;EACF,CAAC;EAED,IAAI,iBAAiB,EAAE;IACrB,IACE,KAAK,CAAC,IAAI,CAAC,MAAM,KAChB,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,EAC7D;MACA,UAAU,CAAC,CAAC;MAEZ;IACF;IAEA,IAAI,KAAK,CAAC,WAAW,CAAC,MAAM,IAAI,yBAAyB,EAAE;MACzD,UAAU,CAAC,CAAC;MAEZ;IACF;IAEA,IACE,kBAAkB,KACjB,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,IACnB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;MACjB,GAAG,EAAE;IACP,CAAC,KAAK;MACJ,OAAO,CAAC,mBAAmB,CAAC,EAAE,CAAC;IACjC,CAAC,CAAC,CAAC,MAAM,CAAC,EACV;MACA,KAAK,CAAC,WAAW,CACf,2CAA2C,GACzC,yDAAyD,GACzD,iEACJ,CAAC;MAED;IACF;IAEA,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;MACzB,IAAI,CAAC,iBAAiB,EAAE;QACtB,KAAK,CAAC,WAAW,CACf,2CAA2C,GACzC,qDACJ,CAAC;QAED;MACF;IACF,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE;MAC9D,IAAI,CAAC,iBAAiB,EAAE;QACtB,KAAK,CAAC,WAAW,CACf,2CAA2C,GACzC,gEACJ,CAAC;QAED;MACF;IACF,CAAC,MAAM;MACL,MAAM,KAAK,GAAG,MAAM;QAClB,KAAK,CAAC,MAAM,GAAG,CACb;UACE,MAAM,EAAE,CAAC;UACT,MAAM,EAAE,EAAE;UACV,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE;YAChC,MAAM,EAAE;cACN,WAAW,EAAE,IAAI;cACjB,OAAO;cACP,IAAI,EAAE,GAAG;cACT,QAAQ;cACR,OAAO;cACP,QAAQ;cACR,GAAG,EAAE,EAAE;cACP,IAAI,EAAE;YACR;UACF,CAAC,KAAK;YACJ,IAAI,GAAG,EAAE;cACP,GAAG,CAAC,IAAI,GAAG,GAAG;YAChB;YAEA,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,EAAE;cACpB,GAAG,CAAC,QAAQ,GAAG,QAAQ;YACzB;YAEA,IAAI,GAAG,EAAE;cACP,GAAG,CAAC,IAAI,IAAI,GAAG;YACjB;YAEA,IAAI,GAAG,IAAI,IAAI,EAAE;cACf,GAAG,CAAC,QAAQ,GAAG,QAAQ;YACzB;YAEA,GAAG,CAAC,WAAW,IAAI,IAAI;YAEvB,MAAM,iBAAiB,GAAG,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,IAAI;YACrD,IACE,iBAAiB,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,EACxD;cACA,GAAG,CAAC,WAAW,IAAI,GAAG;YACxB;YAEA,GAAG,CAAC,OAAO,GAAG,OAAO;;YAErB;YACA,GAAG,CAAC,GAAG,IAAI,EAAE;YACb,IAAI,EAAE,EAAE;cACN,GAAG,CAAC,OAAO,GAAG,OAAO,IAAI,GAAG;YAC9B;YAEA,OAAO,GAAG;UACZ,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC;YAClB,SAAS,EAAE,KAAK;YAChB,GAAG,EAAE,IAAI;YACT,aAAa,EAAE;UACjB,CAAC,CAAC;QACJ,CAAC,CACF;MACH,CAAC;MAED,KAAK,CAAC,WAAW,CACf,2CAA2C,GACzC,qBAAqB,EACvB,IAAI,EACJ,KACF,CAAC;MAED;IACF;EACF;EAEA,UAAU,CAAC,CAAC;AACd,CAAC,EAAE;EACD,gBAAgB,EAAE,IAAI;EACtB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,2FAA2F;MACxG,GAAG,EAAE;IACP,CAAC;IACD,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,iBAAiB,EAAE;UACjB,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,sBAAsB;UACV,IAAI,EAAE;QACR,CAAC;QACD,yBAAyB,EAAE;UACzB,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA,iCAAiC;UACrB,IAAI,EAAE;QACR,CAAC;QACD,aAAa,EAAE;UACb,KAAK,EAAE,CACL;YACE,IAAI,EAAE,CACJ,GAAG,CACJ;YACD,IAAI,EAAE;UACR,CAAC,EAAE;YACD,KAAK,EAAE;cACL,IAAI,EAAE;YACR,CAAC;YACD,IAAI,EAAE;UACR,CAAC,CACF;UACD,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;QACU,CAAC;QACD,eAAe,EAAE;UACf,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA,sBAAsB;UACV,IAAI,EAAE;QACR,CAAC;QACD,iBAAiB,EAAE;UACjB,WAAW,EAAE;AACzB;AACA;AACA;AACA,uBAAuB;UACX,IAAI,EAAE;QACR,CAAC;QACD,kBAAkB,EAAE;UAClB,WAAW,EAAE;AACzB;AACA;AACA,uBAAuB;UACX,IAAI,EAAE;QACR,CAAC;QACD,cAAc,EAAE;UACd,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA,sBAAsB;UACV,IAAI,EAAE;QACR,CAAC;QACD,2BAA2B,EAAE;UAC3B,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA,sBAAsB;UACV,IAAI,EAAE;QACR,CAAC;QACD,cAAc,EAAE;UACd,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA,mCAAmC;UACvB,KAAK,EAAE;YACL,IAAI,EAAE;UACR,CAAC;UACD,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}

package/dist/rules/noBadBlocks.cjs

@@ -1,100 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-var _commentParser = require("comment-parser");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// Neither a single nor 3+ asterisks are valid JSDoc per
-//  https://jsdoc.app/about-getting-started.html#adding-documentation-comments-to-your-code
-const commentRegexp = /^\/\*(?!\*)/v;
-const extraAsteriskCommentRegexp = /^\/\*{3,}/v;
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  allComments,
-  context,
-  makeReport,
-  sourceCode
-}) => {
-  const [{
-    ignore = ['ts-check', 'ts-expect-error', 'ts-ignore', 'ts-nocheck'],
-    preventAllMultiAsteriskBlocks = false
-  } = {}] = context.options;
-  let extraAsterisks = false;
-  const nonJsdocNodes = /** @type {import('estree').Node[]} */allComments.filter(comment => {
-    const commentText = sourceCode.getText(comment);
-    const initialText = commentText.replace(commentRegexp, '').trimStart();
-    if (['eslint'].some(directive => {
-      return initialText.startsWith(directive);
-    })) {
-      return false;
-    }
-    let sliceIndex = 2;
-    if (!commentRegexp.test(commentText)) {
-      const multiline = extraAsteriskCommentRegexp.exec(commentText)?.[0];
-      if (!multiline) {
-        return false;
-      }
-      sliceIndex = multiline.length;
-      extraAsterisks = true;
-      if (preventAllMultiAsteriskBlocks) {
-        return true;
-      }
-    }
-    const tags = ((0, _commentParser.parse)(`${commentText.slice(0, 2)}*${commentText.slice(sliceIndex)}`)[0] || {}).tags ?? [];
-    return tags.length && !tags.some(({
-      tag
-    }) => {
-      return ignore.includes(tag);
-    });
-  });
-  if (!nonJsdocNodes.length) {
-    return;
-  }
-  for (const node of nonJsdocNodes) {
-    const report = /** @type {import('../iterateJsdoc.js').MakeReport} */makeReport(context, node);
-
-    // eslint-disable-next-line no-loop-func
-    const fix = /** @type {import('eslint').Rule.ReportFixer} */fixer => {
-      const text = sourceCode.getText(node);
-      return fixer.replaceText(node, extraAsterisks ? text.replace(extraAsteriskCommentRegexp, '/**') : text.replace('/*', '/**'));
-    };
-    report('Expected JSDoc-like comment to begin with two asterisks.', fix);
-  }
-}, {
-  checkFile: true,
-  meta: {
-    docs: {
-      description: 'This rule checks for multi-line-style comments which fail to meet the criteria of a JSDoc block.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-bad-blocks.md#repos-sticky-header'
-    },
-    fixable: 'code',
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        ignore: {
-          description: `An array of directives that will not be reported if present at the beginning of
-a multi-comment block and at-sign \`/* @\`.
-
-Defaults to \`['ts-check', 'ts-expect-error', 'ts-ignore', 'ts-nocheck']\`
-(some directives [used by TypeScript](https://www.typescriptlang.org/docs/handbook/intro-to-js-ts.html#ts-check)).`,
-          items: {
-            type: 'string'
-          },
-          type: 'array'
-        },
-        preventAllMultiAsteriskBlocks: {
-          description: `A boolean (defaulting to \`false\`) which if \`true\` will prevent all
-JSDoc-like blocks with more than two initial asterisks even those without
-apparent tag content.`,
-          type: 'boolean'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'layout'
-  }
-});
-module.exports = exports.default;
-//# sourceMappingURL=noBadBlocks.cjs.map

package/dist/rules/noBadBlocks.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"noBadBlocks.cjs","names":["iterateJsdoc","commentParser"],"sources":["../../src/rules/noBadBlocks.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  parse as commentParser,\n} from 'comment-parser';\n\n// Neither a single nor 3+ asterisks are valid JSDoc per\n//  https://jsdoc.app/about-getting-started.html#adding-documentation-comments-to-your-code\nconst commentRegexp = /^\\/\\*(?!\\*)/v;\nconst extraAsteriskCommentRegexp = /^\\/\\*{3,}/v;\n\nexport default iterateJsdoc(({\n  allComments,\n  context,\n  makeReport,\n  sourceCode,\n}) => {\n  const [\n    {\n      ignore = [\n        'ts-check',\n        'ts-expect-error',\n        'ts-ignore',\n        'ts-nocheck',\n      ],\n      preventAllMultiAsteriskBlocks = false,\n    } = {},\n  ] = context.options;\n\n  let extraAsterisks = false;\n  const nonJsdocNodes = /** @type {import('estree').Node[]} */ (\n    allComments\n  ).filter((comment) => {\n    const commentText = sourceCode.getText(comment);\n\n    const initialText = commentText.replace(commentRegexp, '').trimStart();\n    if ([\n      'eslint',\n    ].some((directive) => {\n      return initialText.startsWith(directive);\n    })) {\n      return false;\n    }\n\n    let sliceIndex = 2;\n    if (!commentRegexp.test(commentText)) {\n      const multiline = extraAsteriskCommentRegexp.exec(commentText)?.[0];\n      if (!multiline) {\n        return false;\n      }\n\n      sliceIndex = multiline.length;\n      extraAsterisks = true;\n      if (preventAllMultiAsteriskBlocks) {\n        return true;\n      }\n    }\n\n    const tags = (commentParser(\n      `${commentText.slice(0, 2)}*${commentText.slice(sliceIndex)}`,\n    )[0] || {}).tags ?? [];\n\n    return tags.length && !tags.some(({\n      tag,\n    }) => {\n      return ignore.includes(tag);\n    });\n  });\n\n  if (!nonJsdocNodes.length) {\n    return;\n  }\n\n  for (const node of nonJsdocNodes) {\n    const report = /** @type {import('../iterateJsdoc.js').MakeReport} */ (\n      makeReport\n    )(context, node);\n\n    // eslint-disable-next-line no-loop-func\n    const fix = /** @type {import('eslint').Rule.ReportFixer} */ (fixer) => {\n      const text = sourceCode.getText(node);\n\n      return fixer.replaceText(\n        node,\n        extraAsterisks ?\n          text.replace(extraAsteriskCommentRegexp, '/**') :\n          text.replace('/*', '/**'),\n      );\n    };\n\n    report('Expected JSDoc-like comment to begin with two asterisks.', fix);\n  }\n}, {\n  checkFile: true,\n  meta: {\n    docs: {\n      description: 'This rule checks for multi-line-style comments which fail to meet the criteria of a JSDoc block.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-bad-blocks.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          ignore: {\n            description: `An array of directives that will not be reported if present at the beginning of\na multi-comment block and at-sign \\`/* @\\`.\n\nDefaults to \\`['ts-check', 'ts-expect-error', 'ts-ignore', 'ts-nocheck']\\`\n(some directives [used by TypeScript](https://www.typescriptlang.org/docs/handbook/intro-to-js-ts.html#ts-check)).`,\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          preventAllMultiAsteriskBlocks: {\n            description: `A boolean (defaulting to \\`false\\`) which if \\`true\\` will prevent all\nJSDoc-like blocks with more than two initial asterisks even those without\napparent tag content.`,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'layout',\n  },\n});\n"],"mappings":";;;;;;AAAA;AACA;AAEwB;AAExB;AACA;AACA,MAAM,aAAa,GAAG,cAAc;AACpC,MAAM,0BAA0B,GAAG,YAAY;AAAC,iCAEjC,IAAAA,qBAAY,EAAC,CAAC;EAC3B,WAAW;EACX,OAAO;EACP,UAAU;EACV;AACF,CAAC,KAAK;EACJ,MAAM,CACJ;IACE,MAAM,GAAG,CACP,UAAU,EACV,iBAAiB,EACjB,WAAW,EACX,YAAY,CACb;IACD,6BAA6B,GAAG;EAClC,CAAC,GAAG,CAAC,CAAC,CACP,GAAG,OAAO,CAAC,OAAO;EAEnB,IAAI,cAAc,GAAG,KAAK;EAC1B,MAAM,aAAa,GAAG,sCACpB,WAAW,CACX,MAAM,CAAE,OAAO,IAAK;IACpB,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC;IAE/C,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;IACtE,IAAI,CACF,QAAQ,CACT,CAAC,IAAI,CAAE,SAAS,IAAK;MACpB,OAAO,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC;IAC1C,CAAC,CAAC,EAAE;MACF,OAAO,KAAK;IACd;IAEA,IAAI,UAAU,GAAG,CAAC;IAClB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;MACpC,MAAM,SAAS,GAAG,0BAA0B,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;MACnE,IAAI,CAAC,SAAS,EAAE;QACd,OAAO,KAAK;MACd;MAEA,UAAU,GAAG,SAAS,CAAC,MAAM;MAC7B,cAAc,GAAG,IAAI;MACrB,IAAI,6BAA6B,EAAE;QACjC,OAAO,IAAI;MACb;IACF;IAEA,MAAM,IAAI,GAAG,CAAC,IAAAC,oBAAa,EACzB,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,EAC7D,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,IAAI,EAAE;IAEtB,OAAO,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;MAChC;IACF,CAAC,KAAK;MACJ,OAAO,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;IAC7B,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE;IACzB;EACF;EAEA,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE;IAChC,MAAM,MAAM,GAAG,sDACb,UAAU,CACV,OAAO,EAAE,IAAI,CAAC;;IAEhB;IACA,MAAM,GAAG,GAAG,gDAAkD,KAAK,IAAK;MACtE,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC;MAErC,OAAO,KAAK,CAAC,WAAW,CACtB,IAAI,EACJ,cAAc,GACZ,IAAI,CAAC,OAAO,CAAC,0BAA0B,EAAE,KAAK,CAAC,GAC/C,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAC5B,CAAC;IACH,CAAC;IAED,MAAM,CAAC,0DAA0D,EAAE,GAAG,CAAC;EACzE;AACF,CAAC,EAAE;EACD,SAAS,EAAE,IAAI;EACf,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,kGAAkG;MAC/G,GAAG,EAAE;IACP,CAAC;IACD,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,MAAM,EAAE;UACN,WAAW,EAAE;AACzB;AACA;AACA;AACA,mHAAmH;UACvG,KAAK,EAAE;YACL,IAAI,EAAE;UACR,CAAC;UACD,IAAI,EAAE;QACR,CAAC;QACD,6BAA6B,EAAE;UAC7B,WAAW,EAAE;AACzB;AACA,sBAAsB;UACV,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}

package/dist/rules/noBlankBlockDescriptions.cjs

@@ -1,63 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const anyWhitespaceLines = /^\s*$/v;
-const atLeastTwoLinesWhitespace = /^[ \t]*\n[ \t]*\n\s*$/v;
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  jsdoc,
-  utils
-}) => {
-  const {
-    description,
-    descriptions,
-    lastDescriptionLine
-  } = utils.getDescription();
-  const regex = jsdoc.tags.length ? anyWhitespaceLines : atLeastTwoLinesWhitespace;
-  if (descriptions.length && regex.test(description)) {
-    if (jsdoc.tags.length) {
-      utils.reportJSDoc('There should be no blank lines in block descriptions followed by tags.', {
-        line: lastDescriptionLine
-      }, () => {
-        utils.setBlockDescription(() => {
-          // Remove all lines
-          return [];
-        });
-      });
-    } else {
-      utils.reportJSDoc('There should be no extra blank lines in block descriptions not followed by tags.', {
-        line: lastDescriptionLine
-      }, () => {
-        utils.setBlockDescription((info, seedTokens) => {
-          return [
-          // Keep the starting line
-          {
-            number: 0,
-            source: '',
-            tokens: seedTokens({
-              ...info,
-              description: ''
-            })
-          }];
-        });
-      });
-    }
-  }
-}, {
-  iterateAllJsdocs: true,
-  meta: {
-    docs: {
-      description: 'If tags are present, this rule will prevent empty lines in the block description. If no tags are present, this rule will prevent extra empty lines in the block description.',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-blank-block-descriptions.md#repos-sticky-header'
-    },
-    fixable: 'whitespace',
-    schema: [],
-    type: 'layout'
-  }
-});
-module.exports = exports.default;
-//# sourceMappingURL=noBlankBlockDescriptions.cjs.map

package/dist/rules/noBlankBlockDescriptions.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"noBlankBlockDescriptions.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/noBlankBlockDescriptions.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nconst anyWhitespaceLines = /^\\s*$/v;\nconst atLeastTwoLinesWhitespace = /^[ \\t]*\\n[ \\t]*\\n\\s*$/v;\n\nexport default iterateJsdoc(({\n  jsdoc,\n  utils,\n}) => {\n  const {\n    description,\n    descriptions,\n    lastDescriptionLine,\n  } = utils.getDescription();\n\n  const regex = jsdoc.tags.length ?\n    anyWhitespaceLines :\n    atLeastTwoLinesWhitespace;\n\n  if (descriptions.length && regex.test(description)) {\n    if (jsdoc.tags.length) {\n      utils.reportJSDoc(\n        'There should be no blank lines in block descriptions followed by tags.',\n        {\n          line: lastDescriptionLine,\n        },\n        () => {\n          utils.setBlockDescription(() => {\n            // Remove all lines\n            return [];\n          });\n        },\n      );\n    } else {\n      utils.reportJSDoc(\n        'There should be no extra blank lines in block descriptions not followed by tags.',\n        {\n          line: lastDescriptionLine,\n        },\n        () => {\n          utils.setBlockDescription((info, seedTokens) => {\n            return [\n              // Keep the starting line\n              {\n                number: 0,\n                source: '',\n                tokens: seedTokens({\n                  ...info,\n                  description: '',\n                }),\n              },\n            ];\n          });\n        },\n      );\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'If tags are present, this rule will prevent empty lines in the block description. If no tags are present, this rule will prevent extra empty lines in the block description.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-blank-block-descriptions.md#repos-sticky-header',\n    },\n    fixable: 'whitespace',\n    schema: [],\n    type: 'layout',\n  },\n});\n"],"mappings":";;;;;;AAAA;AAA8C;AAE9C,MAAM,kBAAkB,GAAG,QAAQ;AACnC,MAAM,yBAAyB,GAAG,wBAAwB;AAAC,iCAE5C,IAAAA,qBAAY,EAAC,CAAC;EAC3B,KAAK;EACL;AACF,CAAC,KAAK;EACJ,MAAM;IACJ,WAAW;IACX,YAAY;IACZ;EACF,CAAC,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;EAE1B,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,GAC7B,kBAAkB,GAClB,yBAAyB;EAE3B,IAAI,YAAY,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;IAClD,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE;MACrB,KAAK,CAAC,WAAW,CACf,wEAAwE,EACxE;QACE,IAAI,EAAE;MACR,CAAC,EACD,MAAM;QACJ,KAAK,CAAC,mBAAmB,CAAC,MAAM;UAC9B;UACA,OAAO,EAAE;QACX,CAAC,CAAC;MACJ,CACF,CAAC;IACH,CAAC,MAAM;MACL,KAAK,CAAC,WAAW,CACf,kFAAkF,EAClF;QACE,IAAI,EAAE;MACR,CAAC,EACD,MAAM;QACJ,KAAK,CAAC,mBAAmB,CAAC,CAAC,IAAI,EAAE,UAAU,KAAK;UAC9C,OAAO;UACL;UACA;YACE,MAAM,EAAE,CAAC;YACT,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,UAAU,CAAC;cACjB,GAAG,IAAI;cACP,WAAW,EAAE;YACf,CAAC;UACH,CAAC,CACF;QACH,CAAC,CAAC;MACJ,CACF,CAAC;IACH;EACF;AACF,CAAC,EAAE;EACD,gBAAgB,EAAE,IAAI;EACtB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,8KAA8K;MAC3L,GAAG,EAAE;IACP,CAAC;IACD,OAAO,EAAE,YAAY;IACrB,MAAM,EAAE,EAAE;IACV,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}