@depup/eslint-plugin-jsdoc 62.8.0-depup.0

package/dist/rules/sortTags.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sortTags.cjs","names":["_defaultTagOrder","_interopRequireDefault","require","_iterateJsdoc","e","__esModule","default","_default","exports","iterateJsdoc","context","jsdoc","utils","alphabetizeExtras","linesBetween","reportIntraTagGroupSpacing","reportTagGroupSpacing","tagExceptions","tagSequence","defaultTagOrder","options","tagList","flatMap","obj","tags","otherPos","indexOf","endPos","length","ongoingCount","idx","tag","entries","originalIndex","source","originalLine","firstChangedTagLine","firstChangedTagIndex","sortedTags","JSON","parse","stringify","sort","tagNew","tagOld","checkOrSetFirstChanged","newPos","oldPos","preferredNewPos","preferredOldPos","undefined","lastTagsOfGroup","badLastTagsOfGroup","countTagEmptyLines","reduce","acc","tokens","description","end","name","tg","type","empty","Number","innerIdx","currentTag","lastTag","includes","some","tgs","push","ct","fixer","currIdx","newIdx","emptyLine","number","seedTokens","delimiter","start","existingEmptyLines","nextTokens","lineDiff","lines","Array","from","splice","srcIdx","src","reportJSDoc","tagIdx","foundFirstTag","nextIdx","ignore","lastTagOfGroup","firstLine","getFirstLine","fix","itemsToMoveRange","keys","unchangedPriorTagDescriptions","slice","initialOffset","removeTag","changedTags","extraTagCount","changedTag","addTag","addLine","join","iterateAllJsdocs","meta","docs","url","fixable","schema","additionalProperties","properties","patternProperties","items","module"],"sources":["../../src/rules/sortTags.js"],"sourcesContent":["import defaultTagOrder from '../defaultTagOrder.js';\nimport iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n// eslint-disable-next-line complexity -- Temporary\n}) => {\n  const\n    /**\n     * @type {{\n     *   linesBetween: import('../iterateJsdoc.js').Integer,\n     *   tagExceptions: Record<string, number>,\n     *   tagSequence: {\n     *     tags: string[]\n     *   }[],\n     *   alphabetizeExtras: boolean,\n     *   reportTagGroupSpacing: boolean,\n     *   reportIntraTagGroupSpacing: boolean,\n     * }}\n     */ {\n      alphabetizeExtras = false,\n      linesBetween = 1,\n      reportIntraTagGroupSpacing = true,\n      reportTagGroupSpacing = true,\n      tagExceptions = {},\n      tagSequence = defaultTagOrder,\n    } = context.options[0] || {};\n\n  const tagList = tagSequence.flatMap((obj) => {\n    /* typeof obj === 'string' ? obj : */\n    return obj.tags;\n  });\n\n  const otherPos = tagList.indexOf('-other');\n  const endPos = otherPos > -1 ? otherPos : tagList.length;\n\n  let ongoingCount = 0;\n  for (const [\n    idx,\n    tag,\n  ] of\n    /**\n     * @type {(\n     *   import('@es-joy/jsdoccomment').JsdocTagWithInline & {\n     *     originalIndex: import('../iterateJsdoc.js').Integer,\n     *     originalLine: import('../iterateJsdoc.js').Integer,\n     *   }\n     * )[]}\n     */ (jsdoc.tags).entries()) {\n    tag.originalIndex = idx;\n    ongoingCount += tag.source.length;\n    tag.originalLine = ongoingCount;\n  }\n\n  /** @type {import('../iterateJsdoc.js').Integer|undefined} */\n  let firstChangedTagLine;\n  /** @type {import('../iterateJsdoc.js').Integer|undefined} */\n  let firstChangedTagIndex;\n\n  /**\n   * @type {(import('comment-parser').Spec & {\n   *   originalIndex: import('../iterateJsdoc.js').Integer,\n   *   originalLine: import('../iterateJsdoc.js').Integer,\n   * })[]}\n   */\n  const sortedTags = JSON.parse(JSON.stringify(jsdoc.tags));\n  sortedTags.sort(({\n    tag: tagNew,\n  }, {\n    originalIndex,\n    originalLine,\n    tag: tagOld,\n  }) => {\n    // Optimize: Just keep relative positions if the same tag name\n    if (tagNew === tagOld) {\n      return 0;\n    }\n\n    const checkOrSetFirstChanged = () => {\n      if (!firstChangedTagLine || originalLine < firstChangedTagLine) {\n        firstChangedTagLine = originalLine;\n        firstChangedTagIndex = originalIndex;\n      }\n    };\n\n    const newPos = tagList.indexOf(tagNew);\n    const oldPos = tagList.indexOf(tagOld);\n\n    const preferredNewPos = newPos === -1 ? endPos : newPos;\n    const preferredOldPos = oldPos === -1 ? endPos : oldPos;\n\n    if (preferredNewPos < preferredOldPos) {\n      checkOrSetFirstChanged();\n      return -1;\n    }\n\n    if (preferredNewPos > preferredOldPos) {\n      return 1;\n    }\n\n    // preferredNewPos === preferredOldPos\n    if (\n      !alphabetizeExtras ||\n\n      // Optimize: If tagNew (or tagOld which is the same) was found in the\n      //   priority array, it can maintain its relative position—without need\n      //   of alphabetizing (secondary sorting)\n      newPos >= 0\n    ) {\n      return 0;\n    }\n\n    if (tagNew < tagOld) {\n      checkOrSetFirstChanged();\n      return -1;\n    }\n\n    // tagNew > tagOld\n    return 1;\n  });\n\n  if (firstChangedTagLine === undefined) {\n    // Should be ordered by now\n\n    /**\n     * @type {import('comment-parser').Spec[]}\n     */\n    const lastTagsOfGroup = [];\n\n    /**\n     * @type {[\n     *   import('comment-parser').Spec,\n     *   import('../iterateJsdoc.js').Integer\n     * ][]}\n     */\n    const badLastTagsOfGroup = [];\n\n    /**\n     * @param {import('comment-parser').Spec} tag\n     */\n    const countTagEmptyLines = (tag) => {\n      return tag.source.reduce((acc, {\n        tokens: {\n          description,\n          end,\n          name,\n          tag: tg,\n          type,\n        },\n      }) => {\n        const empty = !tg && !type && !name && !description;\n        // Reset the count so long as there is content\n        return empty ? acc + Number(empty && !end) : 0;\n      }, 0);\n    };\n\n    let idx = 0;\n    for (const {\n      tags,\n    } of tagSequence) {\n      let innerIdx;\n      /** @type {import('comment-parser').Spec} */\n      let currentTag;\n      /** @type {import('comment-parser').Spec|undefined} */\n      let lastTag;\n      do {\n        currentTag = jsdoc.tags[idx];\n        if (!currentTag) {\n          idx++;\n          break;\n        }\n\n        innerIdx = tags.indexOf(currentTag.tag);\n\n        if (\n          innerIdx === -1 &&\n          // eslint-disable-next-line no-loop-func -- Safe\n          (!tags.includes('-other') || tagSequence.some(({\n            tags: tgs,\n          }) => {\n            return tgs.includes(currentTag.tag);\n          }))\n        ) {\n          idx++;\n          break;\n        }\n\n        lastTag = currentTag;\n\n        idx++;\n      } while (true);\n\n      idx--;\n\n      if (lastTag) {\n        lastTagsOfGroup.push(lastTag);\n        const ct = countTagEmptyLines(lastTag);\n        if (\n          ct !== linesBetween &&\n          // Use another rule for adding to end (should be of interest outside this rule)\n          jsdoc.tags[idx]\n        ) {\n          badLastTagsOfGroup.push([\n            lastTag, ct,\n          ]);\n        }\n      }\n    }\n\n    if (reportTagGroupSpacing && badLastTagsOfGroup.length) {\n      /**\n       * @param {import('comment-parser').Spec} tg\n       * @returns {() => void}\n       */\n      const fixer = (tg) => {\n        return () => {\n          // Due to https://github.com/syavorsky/comment-parser/issues/110 ,\n          //  we have to modify `jsdoc.source` rather than just modify tags\n          //  directly\n          for (const [\n            currIdx,\n            {\n              tokens,\n            },\n          ] of jsdoc.source.entries()) {\n            if (tokens.tag !== '@' + tg.tag) {\n              continue;\n            }\n\n            // Cannot be `tokens.end`, as dropped off last tag, so safe to\n            //  go on\n            let newIdx = currIdx;\n\n            const emptyLine = () => {\n              return {\n                number: 0,\n                source: '',\n                tokens: utils.seedTokens({\n                  delimiter: '*',\n                  start: jsdoc.source[newIdx - 1].tokens.start,\n                }),\n              };\n            };\n\n            let existingEmptyLines = 0;\n            while (true) {\n              const nextTokens = jsdoc.source[++newIdx]?.tokens;\n\n              /* c8 ignore next 3 -- Guard */\n              if (!nextTokens) {\n                return;\n              }\n\n              // Should be no `nextTokens.end` to worry about since ignored\n              //  if not followed by tag\n\n              if (nextTokens.tag) {\n                // Haven't made it to last tag instance yet, so keep looking\n                if (nextTokens.tag === tokens.tag) {\n                  existingEmptyLines = 0;\n                  continue;\n                }\n\n                const lineDiff = linesBetween - existingEmptyLines;\n                if (lineDiff > 0) {\n                  const lines = Array.from({\n                    length: lineDiff,\n                  }, () => {\n                    return emptyLine();\n                  });\n                  jsdoc.source.splice(newIdx, 0, ...lines);\n                } else {\n                  // lineDiff < 0\n                  jsdoc.source.splice(\n                    newIdx + lineDiff,\n                    -lineDiff,\n                  );\n                }\n\n                break;\n              }\n\n              const empty = !nextTokens.type && !nextTokens.name &&\n                !nextTokens.description;\n\n              if (empty) {\n                existingEmptyLines++;\n              } else {\n                // Has content again, so reset empty line count\n                existingEmptyLines = 0;\n              }\n            }\n\n            break;\n          }\n\n          for (const [\n            srcIdx,\n            src,\n          ] of jsdoc.source.entries()) {\n            src.number = srcIdx;\n          }\n        };\n      };\n\n      for (const [\n        tg,\n      ] of badLastTagsOfGroup) {\n        utils.reportJSDoc(\n          'Tag groups do not have the expected whitespace',\n          tg,\n          fixer(tg),\n        );\n      }\n\n      return;\n    }\n\n    if (!reportIntraTagGroupSpacing) {\n      return;\n    }\n\n    for (const [\n      tagIdx,\n      tag,\n    ] of jsdoc.tags.entries()) {\n      if (!jsdoc.tags[tagIdx + 1] || lastTagsOfGroup.includes(tag)) {\n        continue;\n      }\n\n      const ct = countTagEmptyLines(tag);\n      if (ct && (!tagExceptions[tag.tag] || tagExceptions[tag.tag] < ct)) {\n        const fixer = () => {\n          let foundFirstTag = false;\n\n          /** @type {string|undefined} */\n          let currentTag;\n\n          for (const [\n            currIdx,\n            {\n              tokens: {\n                description,\n                end,\n                name,\n                tag: tg,\n                type,\n              },\n            },\n          ] of jsdoc.source.entries()) {\n            if (tg) {\n              foundFirstTag = true;\n              currentTag = tg;\n            }\n\n            if (!foundFirstTag) {\n              continue;\n            }\n\n            if (currentTag && !tg && !type && !name && !description && !end) {\n              let nextIdx = currIdx;\n\n              let ignore = true;\n              // Even if a tag of the same name as the last tags in a group,\n              //  could still be an earlier tag in that group\n\n              // eslint-disable-next-line no-loop-func -- Safe\n              if (lastTagsOfGroup.some((lastTagOfGroup) => {\n                return currentTag === '@' + lastTagOfGroup.tag;\n              })) {\n                while (true) {\n                  const nextTokens = jsdoc.source[++nextIdx]?.tokens;\n                  if (!nextTokens) {\n                    break;\n                  }\n\n                  if (!nextTokens.tag) {\n                    continue;\n                  }\n\n                  // Followed by the same tag name, so not actually last in group,\n                  //   and of interest\n                  if (nextTokens.tag === currentTag) {\n                    ignore = false;\n                  }\n                }\n              } else {\n                while (true) {\n                  const nextTokens = jsdoc.source[++nextIdx]?.tokens;\n                  if (!nextTokens || nextTokens.end) {\n                    break;\n                  }\n\n                  // Not the very last tag, so don't ignore\n                  if (nextTokens.tag) {\n                    ignore = false;\n                    break;\n                  }\n                }\n              }\n\n              if (!ignore) {\n                jsdoc.source.splice(currIdx, 1);\n                for (const [\n                  srcIdx,\n                  src,\n                ] of jsdoc.source.entries()) {\n                  src.number = srcIdx;\n                }\n              }\n            }\n          }\n        };\n\n        utils.reportJSDoc(\n          'Intra-group tags have unexpected whitespace',\n          tag,\n          fixer,\n        );\n      }\n    }\n\n    return;\n  }\n\n  const firstLine = utils.getFirstLine();\n\n  const fix = () => {\n    const itemsToMoveRange = [\n      ...Array.from({\n        length: jsdoc.tags.length -\n        /** @type {import('../iterateJsdoc.js').Integer} */ (\n          firstChangedTagIndex\n        ),\n      }).keys(),\n    ];\n\n    const unchangedPriorTagDescriptions = jsdoc.tags.slice(\n      0,\n      firstChangedTagIndex,\n    ).reduce((ct, {\n      source,\n    }) => {\n      return ct + source.length - 1;\n    }, 0);\n\n    // This offset includes not only the offset from where the first tag\n    //   must begin, and the additional offset of where the first changed\n    //   tag begins, but it must also account for prior descriptions\n    const initialOffset = /** @type {import('../iterateJsdoc.js').Integer} */ (\n      firstLine\n    ) + /** @type {import('../iterateJsdoc.js').Integer} */ (firstChangedTagIndex) +\n\n      // May be the first tag, so don't try finding a prior one if so\n      unchangedPriorTagDescriptions;\n\n    // Use `firstChangedTagLine` for line number to begin reporting/splicing\n    for (const idx of itemsToMoveRange) {\n      utils.removeTag(\n        idx +\n        /** @type {import('../iterateJsdoc.js').Integer} */ (\n          firstChangedTagIndex\n        ),\n      );\n    }\n\n    const changedTags = sortedTags.slice(firstChangedTagIndex);\n    let extraTagCount = 0;\n\n    for (const idx of itemsToMoveRange) {\n      const changedTag = changedTags[idx];\n\n      utils.addTag(\n        changedTag.tag,\n        extraTagCount + initialOffset + idx,\n        {\n          ...changedTag.source[0].tokens,\n\n          // `comment-parser` puts the `end` within the `tags` section, so\n          //   avoid adding another to jsdoc.source\n          end: '',\n        },\n      );\n\n      for (const {\n        tokens,\n      } of changedTag.source.slice(1)) {\n        if (!tokens.end) {\n          utils.addLine(\n            extraTagCount + initialOffset + idx + 1,\n            {\n              ...tokens,\n              end: '',\n            },\n          );\n          extraTagCount++;\n        }\n      }\n    }\n  };\n\n  utils.reportJSDoc(\n    `Tags are not in the prescribed order: ${\n      tagList.join(', ') || '(alphabetical)'\n    }`,\n    jsdoc.tags[/** @type {import('../iterateJsdoc.js').Integer} */ (\n      firstChangedTagIndex\n    )],\n    fix,\n    true,\n  );\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Sorts tags by a specified sequence according to tag name, optionally adding line breaks between tag groups.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/sort-tags.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          alphabetizeExtras: {\n            description: `Defaults to \\`false\\`. Alphabetizes any items not within \\`tagSequence\\` after any\nitems within \\`tagSequence\\` (or in place of the special \\`-other\\` pseudo-tag)\nare sorted.\n\nIf you want all your tags alphabetized, you can supply an empty array for\n\\`tagSequence\\` along with setting this option to \\`true\\`.`,\n            type: 'boolean',\n          },\n          linesBetween: {\n            description: `Indicates the number of lines to be added between tag groups. Defaults to 1.\nDo not set to 0 or 2+ if you are using \\`tag-lines\\` and \\`\"always\"\\` and do not\nset to 1+ if you are using \\`tag-lines\\` and \\`\"never\"\\`.`,\n            type: 'integer',\n          },\n          reportIntraTagGroupSpacing: {\n            description: `Whether to enable reporting and fixing of line breaks within tags of a given\ntag group. Defaults to \\`true\\` which will remove any line breaks at the end of\nsuch tags. Do not use with \\`true\\` if you are using \\`tag-lines\\` and \\`always\\`.`,\n            type: 'boolean',\n          },\n          reportTagGroupSpacing: {\n            description: `Whether to enable reporting and fixing of line breaks between tag groups\nas set by \\`linesBetween\\`. Defaults to \\`true\\`. Note that the very last tag\nwill not have spacing applied regardless. For adding line breaks there, you\nmay wish to use the \\`endLines\\` option of the \\`tag-lines\\` rule.`,\n            type: 'boolean',\n          },\n          tagExceptions: {\n            description: 'Allows specification by tag of a specific higher maximum number of lines. Keys are tags and values are the maximum number of lines allowed for such tags. Overrides `linesBetween`. Defaults to no special exceptions per tag.',\n            patternProperties: {\n              '.*': {\n                type: 'number',\n              },\n            },\n            type: 'object',\n          },\n          tagSequence: {\n            description: `An array of tag group objects indicating the preferred sequence for sorting tags.\n\nEach item in the array should be an object with a \\`tags\\` property set to an array\nof tag names.\n\nTag names earlier in the list will be arranged first. The relative position of\ntags of the same name will not be changed.\n\nEarlier groups will also be arranged before later groups, but with the added\nfeature that additional line breaks may be added between (or before or after)\nsuch groups (depending on the setting of \\`linesBetween\\`).\n\nTag names not in the list will be grouped together at the end. The pseudo-tag\n\\`-other\\` can be used to place them anywhere else if desired. The tags will be\nplaced in their order of appearance, or alphabetized if \\`alphabetizeExtras\\`\nis enabled, see more below about that option.\n\nDefaults to the array below (noting that it is just a single tag group with\nno lines between groups by default).\n\nPlease note that this order is still experimental, so if you want to retain\na fixed order that doesn't change into the future, supply your own\n\\`tagSequence\\`.\n\n\\`\\`\\`js\n[{tags: [\n  // Brief descriptions\n  'summary',\n  'typeSummary',\n\n  // Module/file-level\n  'module',\n  'exports',\n  'file',\n  'fileoverview',\n  'overview',\n  'import',\n\n  // Identifying (name, type)\n  'typedef',\n  'interface',\n  'record',\n  'template',\n  'name',\n  'kind',\n  'type',\n  'alias',\n  'external',\n  'host',\n  'callback',\n  'func',\n  'function',\n  'method',\n  'class',\n  'constructor',\n\n  // Relationships\n  'modifies',\n  'mixes',\n  'mixin',\n  'mixinClass',\n  'mixinFunction',\n  'namespace',\n  'borrows',\n  'constructs',\n  'lends',\n  'implements',\n  'requires',\n\n  // Long descriptions\n  'desc',\n  'description',\n  'classdesc',\n  'tutorial',\n  'copyright',\n  'license',\n\n  // Simple annotations\n  'const',\n  'constant',\n  'final',\n  'global',\n  'readonly',\n  'abstract',\n  'virtual',\n  'var',\n  'member',\n  'memberof',\n  'memberof!',\n  'inner',\n  'instance',\n  'inheritdoc',\n  'inheritDoc',\n  'override',\n  'hideconstructor',\n\n  // Core function/object info\n  'param',\n  'arg',\n  'argument',\n  'prop',\n  'property',\n  'return',\n  'returns',\n\n  // Important behavior details\n  'async',\n  'generator',\n  'default',\n  'defaultvalue',\n  'enum',\n  'augments',\n  'extends',\n  'throws',\n  'exception',\n  'yield',\n  'yields',\n  'event',\n  'fires',\n  'emits',\n  'listens',\n  'this',\n\n  // Access\n  'static',\n  'private',\n  'protected',\n  'public',\n  'access',\n  'package',\n\n  '-other',\n\n  // Supplementary descriptions\n  'see',\n  'example',\n\n  // METADATA\n\n  // Other Closure (undocumented) metadata\n  'closurePrimitive',\n  'customElement',\n  'expose',\n  'hidden',\n  'idGenerator',\n  'meaning',\n  'ngInject',\n  'owner',\n  'wizaction',\n\n  // Other Closure (documented) metadata\n  'define',\n  'dict',\n  'export',\n  'externs',\n  'implicitCast',\n  'noalias',\n  'nocollapse',\n  'nocompile',\n  'noinline',\n  'nosideeffects',\n  'polymer',\n  'polymerBehavior',\n  'preserve',\n  'struct',\n  'suppress',\n  'unrestricted',\n\n  // @homer0/prettier-plugin-jsdoc metadata\n  'category',\n\n  // Non-Closure metadata\n  'ignore',\n  'author',\n  'version',\n  'variation',\n  'since',\n  'deprecated',\n  'todo',\n]}];\n\\`\\`\\``,\n            items: {\n              additionalProperties: false,\n              properties: {\n                tags: {\n                  description: 'See description on `tagSequence`.',\n                  items: {\n                    type: 'string',\n                  },\n                  type: 'array',\n                },\n              },\n              type: 'object',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,gBAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,aAAA,GAAAF,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GAE/B,IAAAG,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,KAAK;EACLC;EACF;AACA,CAAC,KAAK;EACJ;EACE;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EAAQ;IACFC,iBAAiB,GAAG,KAAK;IACzBC,YAAY,GAAG,CAAC;IAChBC,0BAA0B,GAAG,IAAI;IACjCC,qBAAqB,GAAG,IAAI;IAC5BC,aAAa,GAAG,CAAC,CAAC;IAClBC,WAAW,GAAGC;EAChB,CAAC,GAAGT,OAAO,CAACU,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE9B,MAAMC,OAAO,GAAGH,WAAW,CAACI,OAAO,CAAEC,GAAG,IAAK;IAC3C;IACA,OAAOA,GAAG,CAACC,IAAI;EACjB,CAAC,CAAC;EAEF,MAAMC,QAAQ,GAAGJ,OAAO,CAACK,OAAO,CAAC,QAAQ,CAAC;EAC1C,MAAMC,MAAM,GAAGF,QAAQ,GAAG,CAAC,CAAC,GAAGA,QAAQ,GAAGJ,OAAO,CAACO,MAAM;EAExD,IAAIC,YAAY,GAAG,CAAC;EACpB,KAAK,MAAM,CACTC,GAAG,EACHC,GAAG,CACJ;EACC;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;EAASpB,KAAK,CAACa,IAAI,CAAEQ,OAAO,CAAC,CAAC,EAAE;IAC5BD,GAAG,CAACE,aAAa,GAAGH,GAAG;IACvBD,YAAY,IAAIE,GAAG,CAACG,MAAM,CAACN,MAAM;IACjCG,GAAG,CAACI,YAAY,GAAGN,YAAY;EACjC;;EAEA;EACA,IAAIO,mBAAmB;EACvB;EACA,IAAIC,oBAAoB;;EAExB;AACF;AACA;AACA;AACA;AACA;EACE,MAAMC,UAAU,GAAGC,IAAI,CAACC,KAAK,CAACD,IAAI,CAACE,SAAS,CAAC9B,KAAK,CAACa,IAAI,CAAC,CAAC;EACzDc,UAAU,CAACI,IAAI,CAAC,CAAC;IACfX,GAAG,EAAEY;EACP,CAAC,EAAE;IACDV,aAAa;IACbE,YAAY;IACZJ,GAAG,EAAEa;EACP,CAAC,KAAK;IACJ;IACA,IAAID,MAAM,KAAKC,MAAM,EAAE;MACrB,OAAO,CAAC;IACV;IAEA,MAAMC,sBAAsB,GAAGA,CAAA,KAAM;MACnC,IAAI,CAACT,mBAAmB,IAAID,YAAY,GAAGC,mBAAmB,EAAE;QAC9DA,mBAAmB,GAAGD,YAAY;QAClCE,oBAAoB,GAAGJ,aAAa;MACtC;IACF,CAAC;IAED,MAAMa,MAAM,GAAGzB,OAAO,CAACK,OAAO,CAACiB,MAAM,CAAC;IACtC,MAAMI,MAAM,GAAG1B,OAAO,CAACK,OAAO,CAACkB,MAAM,CAAC;IAEtC,MAAMI,eAAe,GAAGF,MAAM,KAAK,CAAC,CAAC,GAAGnB,MAAM,GAAGmB,MAAM;IACvD,MAAMG,eAAe,GAAGF,MAAM,KAAK,CAAC,CAAC,GAAGpB,MAAM,GAAGoB,MAAM;IAEvD,IAAIC,eAAe,GAAGC,eAAe,EAAE;MACrCJ,sBAAsB,CAAC,CAAC;MACxB,OAAO,CAAC,CAAC;IACX;IAEA,IAAIG,eAAe,GAAGC,eAAe,EAAE;MACrC,OAAO,CAAC;IACV;;IAEA;IACA,IACE,CAACpC,iBAAiB;IAElB;IACA;IACA;IACAiC,MAAM,IAAI,CAAC,EACX;MACA,OAAO,CAAC;IACV;IAEA,IAAIH,MAAM,GAAGC,MAAM,EAAE;MACnBC,sBAAsB,CAAC,CAAC;MACxB,OAAO,CAAC,CAAC;IACX;;IAEA;IACA,OAAO,CAAC;EACV,CAAC,CAAC;EAEF,IAAIT,mBAAmB,KAAKc,SAAS,EAAE;IACrC;;IAEA;AACJ;AACA;IACI,MAAMC,eAAe,GAAG,EAAE;;IAE1B;AACJ;AACA;AACA;AACA;AACA;IACI,MAAMC,kBAAkB,GAAG,EAAE;;IAE7B;AACJ;AACA;IACI,MAAMC,kBAAkB,GAAItB,GAAG,IAAK;MAClC,OAAOA,GAAG,CAACG,MAAM,CAACoB,MAAM,CAAC,CAACC,GAAG,EAAE;QAC7BC,MAAM,EAAE;UACNC,WAAW;UACXC,GAAG;UACHC,IAAI;UACJ5B,GAAG,EAAE6B,EAAE;UACPC;QACF;MACF,CAAC,KAAK;QACJ,MAAMC,KAAK,GAAG,CAACF,EAAE,IAAI,CAACC,IAAI,IAAI,CAACF,IAAI,IAAI,CAACF,WAAW;QACnD;QACA,OAAOK,KAAK,GAAGP,GAAG,GAAGQ,MAAM,CAACD,KAAK,IAAI,CAACJ,GAAG,CAAC,GAAG,CAAC;MAChD,CAAC,EAAE,CAAC,CAAC;IACP,CAAC;IAED,IAAI5B,GAAG,GAAG,CAAC;IACX,KAAK,MAAM;MACTN;IACF,CAAC,IAAIN,WAAW,EAAE;MAChB,IAAI8C,QAAQ;MACZ;MACA,IAAIC,UAAU;MACd;MACA,IAAIC,OAAO;MACX,GAAG;QACDD,UAAU,GAAGtD,KAAK,CAACa,IAAI,CAACM,GAAG,CAAC;QAC5B,IAAI,CAACmC,UAAU,EAAE;UACfnC,GAAG,EAAE;UACL;QACF;QAEAkC,QAAQ,GAAGxC,IAAI,CAACE,OAAO,CAACuC,UAAU,CAAClC,GAAG,CAAC;QAEvC,IACEiC,QAAQ,KAAK,CAAC,CAAC;QACf;QACC,CAACxC,IAAI,CAAC2C,QAAQ,CAAC,QAAQ,CAAC,IAAIjD,WAAW,CAACkD,IAAI,CAAC,CAAC;UAC7C5C,IAAI,EAAE6C;QACR,CAAC,KAAK;UACJ,OAAOA,GAAG,CAACF,QAAQ,CAACF,UAAU,CAAClC,GAAG,CAAC;QACrC,CAAC,CAAC,CAAC,EACH;UACAD,GAAG,EAAE;UACL;QACF;QAEAoC,OAAO,GAAGD,UAAU;QAEpBnC,GAAG,EAAE;MACP,CAAC,QAAQ,IAAI;MAEbA,GAAG,EAAE;MAEL,IAAIoC,OAAO,EAAE;QACXf,eAAe,CAACmB,IAAI,CAACJ,OAAO,CAAC;QAC7B,MAAMK,EAAE,GAAGlB,kBAAkB,CAACa,OAAO,CAAC;QACtC,IACEK,EAAE,KAAKzD,YAAY;QACnB;QACAH,KAAK,CAACa,IAAI,CAACM,GAAG,CAAC,EACf;UACAsB,kBAAkB,CAACkB,IAAI,CAAC,CACtBJ,OAAO,EAAEK,EAAE,CACZ,CAAC;QACJ;MACF;IACF;IAEA,IAAIvD,qBAAqB,IAAIoC,kBAAkB,CAACxB,MAAM,EAAE;MACtD;AACN;AACA;AACA;MACM,MAAM4C,KAAK,GAAIZ,EAAE,IAAK;QACpB,OAAO,MAAM;UACX;UACA;UACA;UACA,KAAK,MAAM,CACTa,OAAO,EACP;YACEjB;UACF,CAAC,CACF,IAAI7C,KAAK,CAACuB,MAAM,CAACF,OAAO,CAAC,CAAC,EAAE;YAC3B,IAAIwB,MAAM,CAACzB,GAAG,KAAK,GAAG,GAAG6B,EAAE,CAAC7B,GAAG,EAAE;cAC/B;YACF;;YAEA;YACA;YACA,IAAI2C,MAAM,GAAGD,OAAO;YAEpB,MAAME,SAAS,GAAGA,CAAA,KAAM;cACtB,OAAO;gBACLC,MAAM,EAAE,CAAC;gBACT1C,MAAM,EAAE,EAAE;gBACVsB,MAAM,EAAE5C,KAAK,CAACiE,UAAU,CAAC;kBACvBC,SAAS,EAAE,GAAG;kBACdC,KAAK,EAAEpE,KAAK,CAACuB,MAAM,CAACwC,MAAM,GAAG,CAAC,CAAC,CAAClB,MAAM,CAACuB;gBACzC,CAAC;cACH,CAAC;YACH,CAAC;YAED,IAAIC,kBAAkB,GAAG,CAAC;YAC1B,OAAO,IAAI,EAAE;cACX,MAAMC,UAAU,GAAGtE,KAAK,CAACuB,MAAM,CAAC,EAAEwC,MAAM,CAAC,EAAElB,MAAM;;cAEjD;cACA,IAAI,CAACyB,UAAU,EAAE;gBACf;cACF;;cAEA;cACA;;cAEA,IAAIA,UAAU,CAAClD,GAAG,EAAE;gBAClB;gBACA,IAAIkD,UAAU,CAAClD,GAAG,KAAKyB,MAAM,CAACzB,GAAG,EAAE;kBACjCiD,kBAAkB,GAAG,CAAC;kBACtB;gBACF;gBAEA,MAAME,QAAQ,GAAGpE,YAAY,GAAGkE,kBAAkB;gBAClD,IAAIE,QAAQ,GAAG,CAAC,EAAE;kBAChB,MAAMC,KAAK,GAAGC,KAAK,CAACC,IAAI,CAAC;oBACvBzD,MAAM,EAAEsD;kBACV,CAAC,EAAE,MAAM;oBACP,OAAOP,SAAS,CAAC,CAAC;kBACpB,CAAC,CAAC;kBACFhE,KAAK,CAACuB,MAAM,CAACoD,MAAM,CAACZ,MAAM,EAAE,CAAC,EAAE,GAAGS,KAAK,CAAC;gBAC1C,CAAC,MAAM;kBACL;kBACAxE,KAAK,CAACuB,MAAM,CAACoD,MAAM,CACjBZ,MAAM,GAAGQ,QAAQ,EACjB,CAACA,QACH,CAAC;gBACH;gBAEA;cACF;cAEA,MAAMpB,KAAK,GAAG,CAACmB,UAAU,CAACpB,IAAI,IAAI,CAACoB,UAAU,CAACtB,IAAI,IAChD,CAACsB,UAAU,CAACxB,WAAW;cAEzB,IAAIK,KAAK,EAAE;gBACTkB,kBAAkB,EAAE;cACtB,CAAC,MAAM;gBACL;gBACAA,kBAAkB,GAAG,CAAC;cACxB;YACF;YAEA;UACF;UAEA,KAAK,MAAM,CACTO,MAAM,EACNC,GAAG,CACJ,IAAI7E,KAAK,CAACuB,MAAM,CAACF,OAAO,CAAC,CAAC,EAAE;YAC3BwD,GAAG,CAACZ,MAAM,GAAGW,MAAM;UACrB;QACF,CAAC;MACH,CAAC;MAED,KAAK,MAAM,CACT3B,EAAE,CACH,IAAIR,kBAAkB,EAAE;QACvBxC,KAAK,CAAC6E,WAAW,CACf,gDAAgD,EAChD7B,EAAE,EACFY,KAAK,CAACZ,EAAE,CACV,CAAC;MACH;MAEA;IACF;IAEA,IAAI,CAAC7C,0BAA0B,EAAE;MAC/B;IACF;IAEA,KAAK,MAAM,CACT2E,MAAM,EACN3D,GAAG,CACJ,IAAIpB,KAAK,CAACa,IAAI,CAACQ,OAAO,CAAC,CAAC,EAAE;MACzB,IAAI,CAACrB,KAAK,CAACa,IAAI,CAACkE,MAAM,GAAG,CAAC,CAAC,IAAIvC,eAAe,CAACgB,QAAQ,CAACpC,GAAG,CAAC,EAAE;QAC5D;MACF;MAEA,MAAMwC,EAAE,GAAGlB,kBAAkB,CAACtB,GAAG,CAAC;MAClC,IAAIwC,EAAE,KAAK,CAACtD,aAAa,CAACc,GAAG,CAACA,GAAG,CAAC,IAAId,aAAa,CAACc,GAAG,CAACA,GAAG,CAAC,GAAGwC,EAAE,CAAC,EAAE;QAClE,MAAMC,KAAK,GAAGA,CAAA,KAAM;UAClB,IAAImB,aAAa,GAAG,KAAK;;UAEzB;UACA,IAAI1B,UAAU;UAEd,KAAK,MAAM,CACTQ,OAAO,EACP;YACEjB,MAAM,EAAE;cACNC,WAAW;cACXC,GAAG;cACHC,IAAI;cACJ5B,GAAG,EAAE6B,EAAE;cACPC;YACF;UACF,CAAC,CACF,IAAIlD,KAAK,CAACuB,MAAM,CAACF,OAAO,CAAC,CAAC,EAAE;YAC3B,IAAI4B,EAAE,EAAE;cACN+B,aAAa,GAAG,IAAI;cACpB1B,UAAU,GAAGL,EAAE;YACjB;YAEA,IAAI,CAAC+B,aAAa,EAAE;cAClB;YACF;YAEA,IAAI1B,UAAU,IAAI,CAACL,EAAE,IAAI,CAACC,IAAI,IAAI,CAACF,IAAI,IAAI,CAACF,WAAW,IAAI,CAACC,GAAG,EAAE;cAC/D,IAAIkC,OAAO,GAAGnB,OAAO;cAErB,IAAIoB,MAAM,GAAG,IAAI;cACjB;cACA;;cAEA;cACA,IAAI1C,eAAe,CAACiB,IAAI,CAAE0B,cAAc,IAAK;gBAC3C,OAAO7B,UAAU,KAAK,GAAG,GAAG6B,cAAc,CAAC/D,GAAG;cAChD,CAAC,CAAC,EAAE;gBACF,OAAO,IAAI,EAAE;kBACX,MAAMkD,UAAU,GAAGtE,KAAK,CAACuB,MAAM,CAAC,EAAE0D,OAAO,CAAC,EAAEpC,MAAM;kBAClD,IAAI,CAACyB,UAAU,EAAE;oBACf;kBACF;kBAEA,IAAI,CAACA,UAAU,CAAClD,GAAG,EAAE;oBACnB;kBACF;;kBAEA;kBACA;kBACA,IAAIkD,UAAU,CAAClD,GAAG,KAAKkC,UAAU,EAAE;oBACjC4B,MAAM,GAAG,KAAK;kBAChB;gBACF;cACF,CAAC,MAAM;gBACL,OAAO,IAAI,EAAE;kBACX,MAAMZ,UAAU,GAAGtE,KAAK,CAACuB,MAAM,CAAC,EAAE0D,OAAO,CAAC,EAAEpC,MAAM;kBAClD,IAAI,CAACyB,UAAU,IAAIA,UAAU,CAACvB,GAAG,EAAE;oBACjC;kBACF;;kBAEA;kBACA,IAAIuB,UAAU,CAAClD,GAAG,EAAE;oBAClB8D,MAAM,GAAG,KAAK;oBACd;kBACF;gBACF;cACF;cAEA,IAAI,CAACA,MAAM,EAAE;gBACXlF,KAAK,CAACuB,MAAM,CAACoD,MAAM,CAACb,OAAO,EAAE,CAAC,CAAC;gBAC/B,KAAK,MAAM,CACTc,MAAM,EACNC,GAAG,CACJ,IAAI7E,KAAK,CAACuB,MAAM,CAACF,OAAO,CAAC,CAAC,EAAE;kBAC3BwD,GAAG,CAACZ,MAAM,GAAGW,MAAM;gBACrB;cACF;YACF;UACF;QACF,CAAC;QAED3E,KAAK,CAAC6E,WAAW,CACf,6CAA6C,EAC7C1D,GAAG,EACHyC,KACF,CAAC;MACH;IACF;IAEA;EACF;EAEA,MAAMuB,SAAS,GAAGnF,KAAK,CAACoF,YAAY,CAAC,CAAC;EAEtC,MAAMC,GAAG,GAAGA,CAAA,KAAM;IAChB,MAAMC,gBAAgB,GAAG,CACvB,GAAGd,KAAK,CAACC,IAAI,CAAC;MACZzD,MAAM,EAAEjB,KAAK,CAACa,IAAI,CAACI,MAAM,IACzB;MACES,oBAAoB;IAExB,CAAC,CAAC,CAAC8D,IAAI,CAAC,CAAC,CACV;IAED,MAAMC,6BAA6B,GAAGzF,KAAK,CAACa,IAAI,CAAC6E,KAAK,CACpD,CAAC,EACDhE,oBACF,CAAC,CAACiB,MAAM,CAAC,CAACiB,EAAE,EAAE;MACZrC;IACF,CAAC,KAAK;MACJ,OAAOqC,EAAE,GAAGrC,MAAM,CAACN,MAAM,GAAG,CAAC;IAC/B,CAAC,EAAE,CAAC,CAAC;;IAEL;IACA;IACA;IACA,MAAM0E,aAAa,GAAG,mDACpBP,SAAS,IACP,mDAAqD1D,oBAAoB,CAAC;IAE5E;IACA+D,6BAA6B;;IAE/B;IACA,KAAK,MAAMtE,GAAG,IAAIoE,gBAAgB,EAAE;MAClCtF,KAAK,CAAC2F,SAAS,CACbzE,GAAG,IACH;MACEO,oBAAoB,CAExB,CAAC;IACH;IAEA,MAAMmE,WAAW,GAAGlE,UAAU,CAAC+D,KAAK,CAAChE,oBAAoB,CAAC;IAC1D,IAAIoE,aAAa,GAAG,CAAC;IAErB,KAAK,MAAM3E,GAAG,IAAIoE,gBAAgB,EAAE;MAClC,MAAMQ,UAAU,GAAGF,WAAW,CAAC1E,GAAG,CAAC;MAEnClB,KAAK,CAAC+F,MAAM,CACVD,UAAU,CAAC3E,GAAG,EACd0E,aAAa,GAAGH,aAAa,GAAGxE,GAAG,EACnC;QACE,GAAG4E,UAAU,CAACxE,MAAM,CAAC,CAAC,CAAC,CAACsB,MAAM;QAE9B;QACA;QACAE,GAAG,EAAE;MACP,CACF,CAAC;MAED,KAAK,MAAM;QACTF;MACF,CAAC,IAAIkD,UAAU,CAACxE,MAAM,CAACmE,KAAK,CAAC,CAAC,CAAC,EAAE;QAC/B,IAAI,CAAC7C,MAAM,CAACE,GAAG,EAAE;UACf9C,KAAK,CAACgG,OAAO,CACXH,aAAa,GAAGH,aAAa,GAAGxE,GAAG,GAAG,CAAC,EACvC;YACE,GAAG0B,MAAM;YACTE,GAAG,EAAE;UACP,CACF,CAAC;UACD+C,aAAa,EAAE;QACjB;MACF;IACF;EACF,CAAC;EAED7F,KAAK,CAAC6E,WAAW,CACf,yCACEpE,OAAO,CAACwF,IAAI,CAAC,IAAI,CAAC,IAAI,gBAAgB,EACtC,EACFlG,KAAK,CAACa,IAAI,EAAC;EACTa,oBAAoB,EACpB,EACF4D,GAAG,EACH,IACF,CAAC;AACH,CAAC,EAAE;EACDa,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJvD,WAAW,EAAE,6GAA6G;MAC1HwD,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVxG,iBAAiB,EAAE;UACjB4C,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA,4DAA4D;UAChDI,IAAI,EAAE;QACR,CAAC;QACD/C,YAAY,EAAE;UACZ2C,WAAW,EAAE;AACzB;AACA,0DAA0D;UAC9CI,IAAI,EAAE;QACR,CAAC;QACD9C,0BAA0B,EAAE;UAC1B0C,WAAW,EAAE;AACzB;AACA,mFAAmF;UACvEI,IAAI,EAAE;QACR,CAAC;QACD7C,qBAAqB,EAAE;UACrByC,WAAW,EAAE;AACzB;AACA;AACA,mEAAmE;UACvDI,IAAI,EAAE;QACR,CAAC;QACD5C,aAAa,EAAE;UACbwC,WAAW,EAAE,gOAAgO;UAC7O6D,iBAAiB,EAAE;YACjB,IAAI,EAAE;cACJzD,IAAI,EAAE;YACR;UACF,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACD3C,WAAW,EAAE;UACXuC,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO;UACK8D,KAAK,EAAE;YACLH,oBAAoB,EAAE,KAAK;YAC3BC,UAAU,EAAE;cACV7F,IAAI,EAAE;gBACJiC,WAAW,EAAE,mCAAmC;gBAChD8D,KAAK,EAAE;kBACL1D,IAAI,EAAE;gBACR,CAAC;gBACDA,IAAI,EAAE;cACR;YACF,CAAC;YACDA,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA2D,MAAA,CAAAhH,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}

package/dist/rules/sortTags.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("eslint").Rule.RuleModule;
+export default _default;
+//# sourceMappingURL=sortTags.d.ts.map

package/dist/rules/tagLines.cjs

@@ -0,0 +1,374 @@
+"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 {{
+ *   maxBlockLines: null|number,
+ *   startLines: null|number,
+ *   utils: import('../iterateJsdoc.js').Utils
+ * }} cfg
+ */
+const checkMaxBlockLines = ({
+  maxBlockLines,
+  startLines,
+  utils
+}) => {
+  if (typeof maxBlockLines !== 'number') {
+    return false;
+  }
+  if (typeof startLines === 'number' && maxBlockLines < startLines) {
+    utils.reportJSDoc('If set to a number, `maxBlockLines` must be greater than or equal to `startLines`.');
+    return true;
+  }
+  const {
+    description
+  } = utils.getDescription();
+  const excessBlockLinesRegex = new RegExp('\n{' + (maxBlockLines + 2) + ',}', 'v');
+  const excessBlockLinesMatch = description.match(excessBlockLinesRegex);
+  const excessBlockLines = excessBlockLinesMatch?.[0]?.length ?? 0;
+  if (excessBlockLinesMatch) {
+    const excessIndexLine = description.slice(0, excessBlockLinesMatch.index).match(/\n/gv)?.length ?? 0;
+    utils.reportJSDoc(`Expected a maximum of ${maxBlockLines} line${maxBlockLines === 1 ? '' : 's'} within block description`, {
+      line: excessIndexLine
+    }, () => {
+      utils.setBlockDescription((info, seedTokens, descLines, postDelims) => {
+        const newPostDelims = [...postDelims.slice(0, excessIndexLine), ...postDelims.slice(excessIndexLine + excessBlockLines - 1 - maxBlockLines)];
+        return [...descLines.slice(0, excessIndexLine), ...descLines.slice(excessIndexLine + excessBlockLines - 1 - maxBlockLines)].map((desc, idx) => {
+          return {
+            number: 0,
+            source: '',
+            tokens: seedTokens({
+              ...info,
+              description: desc,
+              postDelimiter: newPostDelims[idx]
+            })
+          };
+        });
+      });
+    });
+    return true;
+  }
+  return false;
+};
+var _default = exports.default = (0, _iterateJsdoc.default)(({
+  context,
+  jsdoc,
+  utils
+}) => {
+  const [alwaysNever = 'never', {
+    applyToEndTag = true,
+    count = 1,
+    endLines = 0,
+    maxBlockLines = null,
+    startLines = 0,
+    startLinesWithNoTags = null,
+    tags = {}
+  } = {}] = context.options;
+  jsdoc.tags.some((tg, tagIdx) => {
+    let lastTag;
+
+    /**
+     * @type {null|import('../iterateJsdoc.js').Integer}
+     */
+    let lastEmpty = null;
+
+    /**
+     * @type {null|import('../iterateJsdoc.js').Integer}
+     */
+    let reportIndex = null;
+    let emptyLinesCount = 0;
+    for (const [idx, {
+      tokens: {
+        description,
+        end,
+        name,
+        tag,
+        type
+      }
+    }] of tg.source.entries()) {
+      // May be text after a line break within a tag description
+      if (description) {
+        reportIndex = null;
+      }
+      if (lastTag && ['always', 'any'].includes(tags[lastTag.slice(1)]?.lines)) {
+        continue;
+      }
+      const empty = !tag && !name && !type && !description;
+      if (empty && !end && (alwaysNever === 'never' || lastTag && tags[lastTag.slice(1)]?.lines === 'never')) {
+        reportIndex = idx;
+        continue;
+      }
+      if (!end) {
+        if (empty) {
+          emptyLinesCount++;
+        } else {
+          emptyLinesCount = 0;
+        }
+        lastEmpty = empty ? idx : null;
+      }
+      lastTag = tag;
+    }
+    if (typeof endLines === 'number' && lastEmpty !== null && tagIdx === jsdoc.tags.length - 1) {
+      const lineDiff = endLines - emptyLinesCount;
+      if (lineDiff < 0) {
+        const fixer = () => {
+          utils.removeTag(tagIdx, {
+            tagSourceOffset: /** @type {import('../iterateJsdoc.js').Integer} */lastEmpty + lineDiff + 1
+          });
+        };
+        utils.reportJSDoc(`Expected ${endLines} trailing lines`, {
+          line: tg.source[lastEmpty].number + lineDiff + 1
+        }, fixer);
+      } else if (lineDiff > 0) {
+        const fixer = () => {
+          utils.addLines(tagIdx, /** @type {import('../iterateJsdoc.js').Integer} */lastEmpty, endLines - emptyLinesCount);
+        };
+        utils.reportJSDoc(`Expected ${endLines} trailing lines`, {
+          line: tg.source[lastEmpty].number
+        }, fixer);
+      }
+      return true;
+    }
+    if (reportIndex !== null) {
+      const fixer = () => {
+        utils.removeTag(tagIdx, {
+          tagSourceOffset: (/** @type {import('../iterateJsdoc.js').Integer} */
+          reportIndex)
+        });
+      };
+      utils.reportJSDoc('Expected no lines between tags', {
+        line: tg.source[0].number + 1
+      }, fixer);
+      return true;
+    }
+    return false;
+  });
+  (applyToEndTag ? jsdoc.tags : jsdoc.tags.slice(0, -1)).some((tg, tagIdx) => {
+    /**
+     * @type {{
+     *   idx: import('../iterateJsdoc.js').Integer,
+     *   number: import('../iterateJsdoc.js').Integer
+     * }[]}
+     */
+    const lines = [];
+    let currentTag;
+    let tagSourceIdx = 0;
+    for (const [idx, {
+      number,
+      tokens: {
+        description,
+        end,
+        name,
+        tag,
+        type
+      }
+    }] of tg.source.entries()) {
+      if (description) {
+        lines.splice(0);
+        tagSourceIdx = idx;
+      }
+      if (tag) {
+        currentTag = tag;
+      }
+      if (!tag && !name && !type && !description && !end) {
+        lines.push({
+          idx,
+          number
+        });
+      }
+    }
+    const currentTg = currentTag && tags[currentTag.slice(1)];
+    const tagCount = currentTg?.count;
+    const defaultAlways = alwaysNever === 'always' && currentTg?.lines !== 'never' && currentTg?.lines !== 'any' && lines.length < count;
+    let overrideAlways;
+    let fixCount = count;
+    if (!defaultAlways) {
+      fixCount = typeof tagCount === 'number' ? tagCount : count;
+      overrideAlways = currentTg?.lines === 'always' && lines.length < fixCount;
+    }
+    if (defaultAlways || overrideAlways) {
+      const fixer = () => {
+        utils.addLines(tagIdx, lines[lines.length - 1]?.idx || tagSourceIdx + 1, fixCount - lines.length);
+      };
+      const line = lines[lines.length - 1]?.number || tg.source[tagSourceIdx].number;
+      utils.reportJSDoc(`Expected ${fixCount} line${fixCount === 1 ? '' : 's'} between tags but found ${lines.length}`, {
+        line
+      }, fixer);
+      return true;
+    }
+    return false;
+  });
+  if (checkMaxBlockLines({
+    maxBlockLines,
+    startLines,
+    utils
+  })) {
+    return;
+  }
+  if (typeof startLines === 'number' || typeof startLinesWithNoTags === 'number') {
+    const noTags = !jsdoc.tags.length;
+    if (noTags && startLinesWithNoTags === null) {
+      return;
+    }
+    const {
+      description,
+      lastDescriptionLine
+    } = utils.getDescription();
+    if (!/\S/v.test(description)) {
+      return;
+    }
+    const startingLines = noTags ? startLinesWithNoTags : startLines;
+    const trailingLines = description.match(/\n+$/v)?.[0]?.length;
+    const trailingDiff = (trailingLines ?? 0) - startingLines;
+    if (trailingDiff > 0) {
+      utils.reportJSDoc(`Expected only ${startingLines} line${startingLines === 1 ? '' : 's'} after block description`, {
+        line: lastDescriptionLine - trailingDiff
+      }, () => {
+        utils.setBlockDescription((info, seedTokens, descLines, postDelims) => {
+          return descLines.slice(0, -trailingDiff).map((desc, idx) => {
+            return {
+              number: 0,
+              source: '',
+              tokens: seedTokens({
+                ...info,
+                description: desc,
+                postDelimiter: postDelims[idx]
+              })
+            };
+          });
+        });
+      });
+    } else if (trailingDiff < 0) {
+      utils.reportJSDoc(`Expected ${startingLines} lines after block description`, {
+        line: lastDescriptionLine
+      }, () => {
+        utils.setBlockDescription((info, seedTokens, descLines, postDelims) => {
+          return [...descLines, ...Array.from({
+            length: -trailingDiff
+          }, () => {
+            return '';
+          })].map((desc, idx) => {
+            return {
+              number: 0,
+              source: '',
+              tokens: seedTokens({
+                ...info,
+                description: desc,
+                postDelimiter: desc.trim() ? postDelims[idx] : ''
+              })
+            };
+          });
+        });
+      });
+    }
+  }
+}, {
+  iterateAllJsdocs: true,
+  meta: {
+    docs: {
+      description: 'Enforces lines (or no lines) before, after, or between tags.',
+      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/tag-lines.md#repos-sticky-header'
+    },
+    fixable: 'code',
+    schema: [{
+      description: `Defaults to "never". "any" is only useful with \`tags\` (allowing non-enforcement of lines except
+for particular tags) or with \`startLines\`, \`startLinesWithNoTags\` \`endLines\`, or \`maxBlockLines\`. It is also
+necessary if using the linebreak-setting options of the \`sort-tags\` rule
+so that the two rules won't conflict in both attempting to set lines
+between tags.`,
+      enum: ['always', 'any', 'never'],
+      type: 'string'
+    }, {
+      additionalProperties: false,
+      properties: {
+        applyToEndTag: {
+          description: `Set to \`false\` and use with "always" to indicate the normal lines to be
+added after tags should not be added after the final tag.
+
+Defaults to \`true\`.`,
+          type: 'boolean'
+        },
+        count: {
+          description: `Use with "always" to indicate the number of lines to require be present.
+
+Defaults to 1.`,
+          type: 'integer'
+        },
+        endLines: {
+          anyOf: [{
+            type: 'integer'
+          }, {
+            type: 'null'
+          }],
+          description: `If not set to \`null\`, will enforce end lines to the given count on the
+final tag only.
+
+Defaults to \`0\`.`
+        },
+        maxBlockLines: {
+          anyOf: [{
+            type: 'integer'
+          }, {
+            type: 'null'
+          }],
+          description: `If not set to \`null\`, will enforce a maximum number of lines to the given count anywhere in the block description.
+
+Note that if non-\`null\`, \`maxBlockLines\` must be greater than or equal to \`startLines\`.
+
+Defaults to \`null\`.`
+        },
+        startLines: {
+          anyOf: [{
+            type: 'integer'
+          }, {
+            type: 'null'
+          }],
+          description: `If not set to \`null\`, will enforce end lines to the given count before the
+first tag only, unless there is only whitespace content, in which case,
+a line count will not be enforced.
+
+Defaults to \`0\`.`
+        },
+        startLinesWithNoTags: {
+          description: 'If set to a number, will enforce a starting lines count when there are no tags. Defaults to `undefined`.',
+          type: 'number'
+        },
+        tags: {
+          description: `Overrides the default behavior depending on specific tags.
+
+An object whose keys are tag names and whose values are objects with the
+following keys:
+
+1. \`lines\` - Set to \`always\`, \`never\`, or \`any\` to override.
+2. \`count\` - Overrides main \`count\` (for "always")
+
+Defaults to empty object.`,
+          patternProperties: {
+            '.*': {
+              additionalProperties: false,
+              properties: {
+                count: {
+                  type: 'integer'
+                },
+                lines: {
+                  enum: ['always', 'never', 'any'],
+                  type: 'string'
+                }
+              }
+            }
+          },
+          type: 'object'
+        }
+      },
+      type: 'object'
+    }],
+    type: 'suggestion'
+  }
+});
+module.exports = exports.default;
+//# sourceMappingURL=tagLines.cjs.map

package/dist/rules/tagLines.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tagLines.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","checkMaxBlockLines","maxBlockLines","startLines","utils","reportJSDoc","description","getDescription","excessBlockLinesRegex","RegExp","excessBlockLinesMatch","match","excessBlockLines","length","excessIndexLine","slice","index","line","setBlockDescription","info","seedTokens","descLines","postDelims","newPostDelims","map","desc","idx","number","source","tokens","postDelimiter","_default","exports","iterateJsdoc","context","jsdoc","alwaysNever","applyToEndTag","count","endLines","startLinesWithNoTags","tags","options","some","tg","tagIdx","lastTag","lastEmpty","reportIndex","emptyLinesCount","end","name","tag","type","entries","includes","lines","empty","lineDiff","fixer","removeTag","tagSourceOffset","addLines","currentTag","tagSourceIdx","splice","push","currentTg","tagCount","defaultAlways","overrideAlways","fixCount","noTags","lastDescriptionLine","test","startingLines","trailingLines","trailingDiff","Array","from","trim","iterateAllJsdocs","meta","docs","url","fixable","schema","enum","additionalProperties","properties","anyOf","patternProperties","module"],"sources":["../../src/rules/tagLines.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {{\n *   maxBlockLines: null|number,\n *   startLines: null|number,\n *   utils: import('../iterateJsdoc.js').Utils\n * }} cfg\n */\nconst checkMaxBlockLines = ({\n  maxBlockLines,\n  startLines,\n  utils,\n}) => {\n  if (typeof maxBlockLines !== 'number') {\n    return false;\n  }\n\n  if (typeof startLines === 'number' && maxBlockLines < startLines) {\n    utils.reportJSDoc(\n      'If set to a number, `maxBlockLines` must be greater than or equal to `startLines`.',\n    );\n    return true;\n  }\n\n  const {\n    description,\n  } = utils.getDescription();\n  const excessBlockLinesRegex = new RegExp('\\n{' + (maxBlockLines + 2) + ',}', 'v');\n  const excessBlockLinesMatch = description.match(excessBlockLinesRegex);\n  const excessBlockLines = excessBlockLinesMatch?.[0]?.length ?? 0;\n  if (excessBlockLinesMatch) {\n    const excessIndexLine = description.slice(0, excessBlockLinesMatch.index).match(/\\n/gv)?.length ?? 0;\n    utils.reportJSDoc(\n      `Expected a maximum of ${maxBlockLines} line${maxBlockLines === 1 ? '' : 's'} within block description`,\n      {\n        line: excessIndexLine,\n      },\n      () => {\n        utils.setBlockDescription((info, seedTokens, descLines, postDelims) => {\n          const newPostDelims = [\n            ...postDelims.slice(0, excessIndexLine),\n            ...postDelims.slice(excessIndexLine + excessBlockLines - 1 - maxBlockLines),\n          ];\n          return [\n            ...descLines.slice(0, excessIndexLine),\n            ...descLines.slice(excessIndexLine + excessBlockLines - 1 - maxBlockLines),\n          ].map((desc, idx) => {\n            return {\n              number: 0,\n              source: '',\n              tokens: seedTokens({\n                ...info,\n                description: desc,\n                postDelimiter: newPostDelims[idx],\n              }),\n            };\n          });\n        });\n      },\n    );\n    return true;\n  }\n\n  return false;\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  const [\n    alwaysNever = 'never',\n    {\n      applyToEndTag = true,\n      count = 1,\n      endLines = 0,\n      maxBlockLines = null,\n      startLines = 0,\n      startLinesWithNoTags = null,\n      tags = {},\n    } = {},\n  ] = context.options;\n\n  jsdoc.tags.some((tg, tagIdx) => {\n    let lastTag;\n\n    /**\n     * @type {null|import('../iterateJsdoc.js').Integer}\n     */\n    let lastEmpty = null;\n\n    /**\n     * @type {null|import('../iterateJsdoc.js').Integer}\n     */\n    let reportIndex = null;\n    let emptyLinesCount = 0;\n    for (const [\n      idx,\n      {\n        tokens: {\n          description,\n          end,\n          name,\n          tag,\n          type,\n        },\n      },\n    ] of tg.source.entries()) {\n      // May be text after a line break within a tag description\n      if (description) {\n        reportIndex = null;\n      }\n\n      if (lastTag && [\n        'always', 'any',\n      ].includes(tags[lastTag.slice(1)]?.lines)) {\n        continue;\n      }\n\n      const empty = !tag && !name && !type && !description;\n      if (\n        empty && !end &&\n        (alwaysNever === 'never' ||\n          lastTag && tags[lastTag.slice(1)]?.lines === 'never'\n        )\n      ) {\n        reportIndex = idx;\n\n        continue;\n      }\n\n      if (!end) {\n        if (empty) {\n          emptyLinesCount++;\n        } else {\n          emptyLinesCount = 0;\n        }\n\n        lastEmpty = empty ? idx : null;\n      }\n\n      lastTag = tag;\n    }\n\n    if (\n      typeof endLines === 'number' &&\n      lastEmpty !== null && tagIdx === jsdoc.tags.length - 1\n    ) {\n      const lineDiff = endLines - emptyLinesCount;\n\n      if (lineDiff < 0) {\n        const fixer = () => {\n          utils.removeTag(tagIdx, {\n            tagSourceOffset: /** @type {import('../iterateJsdoc.js').Integer} */ (\n              lastEmpty\n            ) + lineDiff + 1,\n          });\n        };\n\n        utils.reportJSDoc(\n          `Expected ${endLines} trailing lines`,\n          {\n            line: tg.source[lastEmpty].number + lineDiff + 1,\n          },\n          fixer,\n        );\n      } else if (lineDiff > 0) {\n        const fixer = () => {\n          utils.addLines(\n            tagIdx,\n            /** @type {import('../iterateJsdoc.js').Integer} */ (lastEmpty),\n            endLines - emptyLinesCount,\n          );\n        };\n\n        utils.reportJSDoc(\n          `Expected ${endLines} trailing lines`,\n          {\n            line: tg.source[lastEmpty].number,\n          },\n          fixer,\n        );\n      }\n\n      return true;\n    }\n\n    if (reportIndex !== null) {\n      const fixer = () => {\n        utils.removeTag(tagIdx, {\n          tagSourceOffset: /** @type {import('../iterateJsdoc.js').Integer} */ (\n            reportIndex\n          ),\n        });\n      };\n\n      utils.reportJSDoc(\n        'Expected no lines between tags',\n        {\n          line: tg.source[0].number + 1,\n        },\n        fixer,\n      );\n\n      return true;\n    }\n\n    return false;\n  });\n\n  (applyToEndTag ? jsdoc.tags : jsdoc.tags.slice(0, -1)).some((tg, tagIdx) => {\n    /**\n     * @type {{\n     *   idx: import('../iterateJsdoc.js').Integer,\n     *   number: import('../iterateJsdoc.js').Integer\n     * }[]}\n     */\n    const lines = [];\n\n    let currentTag;\n    let tagSourceIdx = 0;\n    for (const [\n      idx,\n      {\n        number,\n        tokens: {\n          description,\n          end,\n          name,\n          tag,\n          type,\n        },\n      },\n    ] of tg.source.entries()) {\n      if (description) {\n        lines.splice(0);\n        tagSourceIdx = idx;\n      }\n\n      if (tag) {\n        currentTag = tag;\n      }\n\n      if (!tag && !name && !type && !description && !end) {\n        lines.push({\n          idx,\n          number,\n        });\n      }\n    }\n\n    const currentTg = currentTag && tags[currentTag.slice(1)];\n    const tagCount = currentTg?.count;\n\n    const defaultAlways = alwaysNever === 'always' && currentTg?.lines !== 'never' &&\n      currentTg?.lines !== 'any' && lines.length < count;\n\n    let overrideAlways;\n    let fixCount = count;\n    if (!defaultAlways) {\n      fixCount = typeof tagCount === 'number' ? tagCount : count;\n      overrideAlways = currentTg?.lines === 'always' &&\n        lines.length < fixCount;\n    }\n\n    if (defaultAlways || overrideAlways) {\n      const fixer = () => {\n        utils.addLines(tagIdx, lines[lines.length - 1]?.idx || tagSourceIdx + 1, fixCount - lines.length);\n      };\n\n      const line = lines[lines.length - 1]?.number || tg.source[tagSourceIdx].number;\n      utils.reportJSDoc(\n        `Expected ${fixCount} line${fixCount === 1 ? '' : 's'} between tags but found ${lines.length}`,\n        {\n          line,\n        },\n        fixer,\n      );\n\n      return true;\n    }\n\n    return false;\n  });\n\n  if (checkMaxBlockLines({\n    maxBlockLines,\n    startLines,\n    utils,\n  })) {\n    return;\n  }\n\n  if (typeof startLines === 'number' || typeof startLinesWithNoTags === 'number') {\n    const noTags = !jsdoc.tags.length;\n\n    if (noTags && startLinesWithNoTags === null) {\n      return;\n    }\n\n    const {\n      description,\n      lastDescriptionLine,\n    } = utils.getDescription();\n    if (!(/\\S/v).test(description)) {\n      return;\n    }\n\n    const startingLines = noTags ? startLinesWithNoTags : startLines;\n\n    const trailingLines = description.match(/\\n+$/v)?.[0]?.length;\n    const trailingDiff = (trailingLines ?? 0) - startingLines;\n    if (trailingDiff > 0) {\n      utils.reportJSDoc(\n        `Expected only ${startingLines} line${startingLines === 1 ? '' : 's'} after block description`,\n        {\n          line: lastDescriptionLine - trailingDiff,\n        },\n        () => {\n          utils.setBlockDescription((info, seedTokens, descLines, postDelims) => {\n            return descLines.slice(0, -trailingDiff).map((desc, idx) => {\n              return {\n                number: 0,\n                source: '',\n                tokens: seedTokens({\n                  ...info,\n                  description: desc,\n                  postDelimiter: postDelims[idx],\n                }),\n              };\n            });\n          });\n        },\n      );\n    } else if (trailingDiff < 0) {\n      utils.reportJSDoc(\n        `Expected ${startingLines} lines after block description`,\n        {\n          line: lastDescriptionLine,\n        },\n        () => {\n          utils.setBlockDescription((info, seedTokens, descLines, postDelims) => {\n            return [\n              ...descLines,\n              ...Array.from({\n                length: -trailingDiff,\n              }, () => {\n                return '';\n              }),\n            ].map((desc, idx) => {\n              return {\n                number: 0,\n                source: '',\n                tokens: seedTokens({\n                  ...info,\n                  description: desc,\n                  postDelimiter: desc.trim() ? postDelims[idx] : '',\n                }),\n              };\n            });\n          });\n        },\n      );\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Enforces lines (or no lines) before, after, or between tags.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/tag-lines.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        description: `Defaults to \"never\". \"any\" is only useful with \\`tags\\` (allowing non-enforcement of lines except\nfor particular tags) or with \\`startLines\\`, \\`startLinesWithNoTags\\` \\`endLines\\`, or \\`maxBlockLines\\`. It is also\nnecessary if using the linebreak-setting options of the \\`sort-tags\\` rule\nso that the two rules won't conflict in both attempting to set lines\nbetween tags.`,\n        enum: [\n          'always', 'any', 'never',\n        ],\n        type: 'string',\n      },\n      {\n        additionalProperties: false,\n        properties: {\n          applyToEndTag: {\n            description: `Set to \\`false\\` and use with \"always\" to indicate the normal lines to be\nadded after tags should not be added after the final tag.\n\nDefaults to \\`true\\`.`,\n            type: 'boolean',\n          },\n          count: {\n            description: `Use with \"always\" to indicate the number of lines to require be present.\n\nDefaults to 1.`,\n            type: 'integer',\n          },\n          endLines: {\n            anyOf: [\n              {\n                type: 'integer',\n              },\n              {\n                type: 'null',\n              },\n            ],\n            description: `If not set to \\`null\\`, will enforce end lines to the given count on the\nfinal tag only.\n\nDefaults to \\`0\\`.`,\n          },\n          maxBlockLines: {\n            anyOf: [\n              {\n                type: 'integer',\n              },\n              {\n                type: 'null',\n              },\n            ],\n            description: `If not set to \\`null\\`, will enforce a maximum number of lines to the given count anywhere in the block description.\n\nNote that if non-\\`null\\`, \\`maxBlockLines\\` must be greater than or equal to \\`startLines\\`.\n\nDefaults to \\`null\\`.`,\n          },\n          startLines: {\n            anyOf: [\n              {\n                type: 'integer',\n              },\n              {\n                type: 'null',\n              },\n            ],\n            description: `If not set to \\`null\\`, will enforce end lines to the given count before the\nfirst tag only, unless there is only whitespace content, in which case,\na line count will not be enforced.\n\nDefaults to \\`0\\`.`,\n          },\n          startLinesWithNoTags: {\n            description: 'If set to a number, will enforce a starting lines count when there are no tags. Defaults to `undefined`.',\n            type: 'number',\n          },\n          tags: {\n            description: `Overrides the default behavior depending on specific tags.\n\nAn object whose keys are tag names and whose values are objects with the\nfollowing keys:\n\n1. \\`lines\\` - Set to \\`always\\`, \\`never\\`, or \\`any\\` to override.\n2. \\`count\\` - Overrides main \\`count\\` (for \"always\")\n\nDefaults to empty object.`,\n            patternProperties: {\n              '.*': {\n                additionalProperties: false,\n                properties: {\n                  count: {\n                    type: 'integer',\n                  },\n                  lines: {\n                    enum: [\n                      'always', 'never', 'any',\n                    ],\n                    type: 'string',\n                  },\n                },\n              },\n            },\n            type: 'object',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9C;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMG,kBAAkB,GAAGA,CAAC;EAC1BC,aAAa;EACbC,UAAU;EACVC;AACF,CAAC,KAAK;EACJ,IAAI,OAAOF,aAAa,KAAK,QAAQ,EAAE;IACrC,OAAO,KAAK;EACd;EAEA,IAAI,OAAOC,UAAU,KAAK,QAAQ,IAAID,aAAa,GAAGC,UAAU,EAAE;IAChEC,KAAK,CAACC,WAAW,CACf,oFACF,CAAC;IACD,OAAO,IAAI;EACb;EAEA,MAAM;IACJC;EACF,CAAC,GAAGF,KAAK,CAACG,cAAc,CAAC,CAAC;EAC1B,MAAMC,qBAAqB,GAAG,IAAIC,MAAM,CAAC,KAAK,IAAIP,aAAa,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC;EACjF,MAAMQ,qBAAqB,GAAGJ,WAAW,CAACK,KAAK,CAACH,qBAAqB,CAAC;EACtE,MAAMI,gBAAgB,GAAGF,qBAAqB,GAAG,CAAC,CAAC,EAAEG,MAAM,IAAI,CAAC;EAChE,IAAIH,qBAAqB,EAAE;IACzB,MAAMI,eAAe,GAAGR,WAAW,CAACS,KAAK,CAAC,CAAC,EAAEL,qBAAqB,CAACM,KAAK,CAAC,CAACL,KAAK,CAAC,MAAM,CAAC,EAAEE,MAAM,IAAI,CAAC;IACpGT,KAAK,CAACC,WAAW,CACf,yBAAyBH,aAAa,QAAQA,aAAa,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,2BAA2B,EACvG;MACEe,IAAI,EAAEH;IACR,CAAC,EACD,MAAM;MACJV,KAAK,CAACc,mBAAmB,CAAC,CAACC,IAAI,EAAEC,UAAU,EAAEC,SAAS,EAAEC,UAAU,KAAK;QACrE,MAAMC,aAAa,GAAG,CACpB,GAAGD,UAAU,CAACP,KAAK,CAAC,CAAC,EAAED,eAAe,CAAC,EACvC,GAAGQ,UAAU,CAACP,KAAK,CAACD,eAAe,GAAGF,gBAAgB,GAAG,CAAC,GAAGV,aAAa,CAAC,CAC5E;QACD,OAAO,CACL,GAAGmB,SAAS,CAACN,KAAK,CAAC,CAAC,EAAED,eAAe,CAAC,EACtC,GAAGO,SAAS,CAACN,KAAK,CAACD,eAAe,GAAGF,gBAAgB,GAAG,CAAC,GAAGV,aAAa,CAAC,CAC3E,CAACsB,GAAG,CAAC,CAACC,IAAI,EAAEC,GAAG,KAAK;UACnB,OAAO;YACLC,MAAM,EAAE,CAAC;YACTC,MAAM,EAAE,EAAE;YACVC,MAAM,EAAET,UAAU,CAAC;cACjB,GAAGD,IAAI;cACPb,WAAW,EAAEmB,IAAI;cACjBK,aAAa,EAAEP,aAAa,CAACG,GAAG;YAClC,CAAC;UACH,CAAC;QACH,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ,CACF,CAAC;IACD,OAAO,IAAI;EACb;EAEA,OAAO,KAAK;AACd,CAAC;AAAC,IAAAK,QAAA,GAAAC,OAAA,CAAAhC,OAAA,GAEa,IAAAiC,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,KAAK;EACL/B;AACF,CAAC,KAAK;EACJ,MAAM,CACJgC,WAAW,GAAG,OAAO,EACrB;IACEC,aAAa,GAAG,IAAI;IACpBC,KAAK,GAAG,CAAC;IACTC,QAAQ,GAAG,CAAC;IACZrC,aAAa,GAAG,IAAI;IACpBC,UAAU,GAAG,CAAC;IACdqC,oBAAoB,GAAG,IAAI;IAC3BC,IAAI,GAAG,CAAC;EACV,CAAC,GAAG,CAAC,CAAC,CACP,GAAGP,OAAO,CAACQ,OAAO;EAEnBP,KAAK,CAACM,IAAI,CAACE,IAAI,CAAC,CAACC,EAAE,EAAEC,MAAM,KAAK;IAC9B,IAAIC,OAAO;;IAEX;AACJ;AACA;IACI,IAAIC,SAAS,GAAG,IAAI;;IAEpB;AACJ;AACA;IACI,IAAIC,WAAW,GAAG,IAAI;IACtB,IAAIC,eAAe,GAAG,CAAC;IACvB,KAAK,MAAM,CACTvB,GAAG,EACH;MACEG,MAAM,EAAE;QACNvB,WAAW;QACX4C,GAAG;QACHC,IAAI;QACJC,GAAG;QACHC;MACF;IACF,CAAC,CACF,IAAIT,EAAE,CAAChB,MAAM,CAAC0B,OAAO,CAAC,CAAC,EAAE;MACxB;MACA,IAAIhD,WAAW,EAAE;QACf0C,WAAW,GAAG,IAAI;MACpB;MAEA,IAAIF,OAAO,IAAI,CACb,QAAQ,EAAE,KAAK,CAChB,CAACS,QAAQ,CAACd,IAAI,CAACK,OAAO,CAAC/B,KAAK,CAAC,CAAC,CAAC,CAAC,EAAEyC,KAAK,CAAC,EAAE;QACzC;MACF;MAEA,MAAMC,KAAK,GAAG,CAACL,GAAG,IAAI,CAACD,IAAI,IAAI,CAACE,IAAI,IAAI,CAAC/C,WAAW;MACpD,IACEmD,KAAK,IAAI,CAACP,GAAG,KACZd,WAAW,KAAK,OAAO,IACtBU,OAAO,IAAIL,IAAI,CAACK,OAAO,CAAC/B,KAAK,CAAC,CAAC,CAAC,CAAC,EAAEyC,KAAK,KAAK,OAAO,CACrD,EACD;QACAR,WAAW,GAAGtB,GAAG;QAEjB;MACF;MAEA,IAAI,CAACwB,GAAG,EAAE;QACR,IAAIO,KAAK,EAAE;UACTR,eAAe,EAAE;QACnB,CAAC,MAAM;UACLA,eAAe,GAAG,CAAC;QACrB;QAEAF,SAAS,GAAGU,KAAK,GAAG/B,GAAG,GAAG,IAAI;MAChC;MAEAoB,OAAO,GAAGM,GAAG;IACf;IAEA,IACE,OAAOb,QAAQ,KAAK,QAAQ,IAC5BQ,SAAS,KAAK,IAAI,IAAIF,MAAM,KAAKV,KAAK,CAACM,IAAI,CAAC5B,MAAM,GAAG,CAAC,EACtD;MACA,MAAM6C,QAAQ,GAAGnB,QAAQ,GAAGU,eAAe;MAE3C,IAAIS,QAAQ,GAAG,CAAC,EAAE;QAChB,MAAMC,KAAK,GAAGA,CAAA,KAAM;UAClBvD,KAAK,CAACwD,SAAS,CAACf,MAAM,EAAE;YACtBgB,eAAe,EAAE,mDACfd,SAAS,GACPW,QAAQ,GAAG;UACjB,CAAC,CAAC;QACJ,CAAC;QAEDtD,KAAK,CAACC,WAAW,CACf,YAAYkC,QAAQ,iBAAiB,EACrC;UACEtB,IAAI,EAAE2B,EAAE,CAAChB,MAAM,CAACmB,SAAS,CAAC,CAACpB,MAAM,GAAG+B,QAAQ,GAAG;QACjD,CAAC,EACDC,KACF,CAAC;MACH,CAAC,MAAM,IAAID,QAAQ,GAAG,CAAC,EAAE;QACvB,MAAMC,KAAK,GAAGA,CAAA,KAAM;UAClBvD,KAAK,CAAC0D,QAAQ,CACZjB,MAAM,EACN,mDAAqDE,SAAS,EAC9DR,QAAQ,GAAGU,eACb,CAAC;QACH,CAAC;QAED7C,KAAK,CAACC,WAAW,CACf,YAAYkC,QAAQ,iBAAiB,EACrC;UACEtB,IAAI,EAAE2B,EAAE,CAAChB,MAAM,CAACmB,SAAS,CAAC,CAACpB;QAC7B,CAAC,EACDgC,KACF,CAAC;MACH;MAEA,OAAO,IAAI;IACb;IAEA,IAAIX,WAAW,KAAK,IAAI,EAAE;MACxB,MAAMW,KAAK,GAAGA,CAAA,KAAM;QAClBvD,KAAK,CAACwD,SAAS,CAACf,MAAM,EAAE;UACtBgB,eAAe,GAAE;UACfb,WAAW;QAEf,CAAC,CAAC;MACJ,CAAC;MAED5C,KAAK,CAACC,WAAW,CACf,gCAAgC,EAChC;QACEY,IAAI,EAAE2B,EAAE,CAAChB,MAAM,CAAC,CAAC,CAAC,CAACD,MAAM,GAAG;MAC9B,CAAC,EACDgC,KACF,CAAC;MAED,OAAO,IAAI;IACb;IAEA,OAAO,KAAK;EACd,CAAC,CAAC;EAEF,CAACtB,aAAa,GAAGF,KAAK,CAACM,IAAI,GAAGN,KAAK,CAACM,IAAI,CAAC1B,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE4B,IAAI,CAAC,CAACC,EAAE,EAAEC,MAAM,KAAK;IAC1E;AACJ;AACA;AACA;AACA;AACA;IACI,MAAMW,KAAK,GAAG,EAAE;IAEhB,IAAIO,UAAU;IACd,IAAIC,YAAY,GAAG,CAAC;IACpB,KAAK,MAAM,CACTtC,GAAG,EACH;MACEC,MAAM;MACNE,MAAM,EAAE;QACNvB,WAAW;QACX4C,GAAG;QACHC,IAAI;QACJC,GAAG;QACHC;MACF;IACF,CAAC,CACF,IAAIT,EAAE,CAAChB,MAAM,CAAC0B,OAAO,CAAC,CAAC,EAAE;MACxB,IAAIhD,WAAW,EAAE;QACfkD,KAAK,CAACS,MAAM,CAAC,CAAC,CAAC;QACfD,YAAY,GAAGtC,GAAG;MACpB;MAEA,IAAI0B,GAAG,EAAE;QACPW,UAAU,GAAGX,GAAG;MAClB;MAEA,IAAI,CAACA,GAAG,IAAI,CAACD,IAAI,IAAI,CAACE,IAAI,IAAI,CAAC/C,WAAW,IAAI,CAAC4C,GAAG,EAAE;QAClDM,KAAK,CAACU,IAAI,CAAC;UACTxC,GAAG;UACHC;QACF,CAAC,CAAC;MACJ;IACF;IAEA,MAAMwC,SAAS,GAAGJ,UAAU,IAAItB,IAAI,CAACsB,UAAU,CAAChD,KAAK,CAAC,CAAC,CAAC,CAAC;IACzD,MAAMqD,QAAQ,GAAGD,SAAS,EAAE7B,KAAK;IAEjC,MAAM+B,aAAa,GAAGjC,WAAW,KAAK,QAAQ,IAAI+B,SAAS,EAAEX,KAAK,KAAK,OAAO,IAC5EW,SAAS,EAAEX,KAAK,KAAK,KAAK,IAAIA,KAAK,CAAC3C,MAAM,GAAGyB,KAAK;IAEpD,IAAIgC,cAAc;IAClB,IAAIC,QAAQ,GAAGjC,KAAK;IACpB,IAAI,CAAC+B,aAAa,EAAE;MAClBE,QAAQ,GAAG,OAAOH,QAAQ,KAAK,QAAQ,GAAGA,QAAQ,GAAG9B,KAAK;MAC1DgC,cAAc,GAAGH,SAAS,EAAEX,KAAK,KAAK,QAAQ,IAC5CA,KAAK,CAAC3C,MAAM,GAAG0D,QAAQ;IAC3B;IAEA,IAAIF,aAAa,IAAIC,cAAc,EAAE;MACnC,MAAMX,KAAK,GAAGA,CAAA,KAAM;QAClBvD,KAAK,CAAC0D,QAAQ,CAACjB,MAAM,EAAEW,KAAK,CAACA,KAAK,CAAC3C,MAAM,GAAG,CAAC,CAAC,EAAEa,GAAG,IAAIsC,YAAY,GAAG,CAAC,EAAEO,QAAQ,GAAGf,KAAK,CAAC3C,MAAM,CAAC;MACnG,CAAC;MAED,MAAMI,IAAI,GAAGuC,KAAK,CAACA,KAAK,CAAC3C,MAAM,GAAG,CAAC,CAAC,EAAEc,MAAM,IAAIiB,EAAE,CAAChB,MAAM,CAACoC,YAAY,CAAC,CAACrC,MAAM;MAC9EvB,KAAK,CAACC,WAAW,CACf,YAAYkE,QAAQ,QAAQA,QAAQ,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,2BAA2Bf,KAAK,CAAC3C,MAAM,EAAE,EAC9F;QACEI;MACF,CAAC,EACD0C,KACF,CAAC;MAED,OAAO,IAAI;IACb;IAEA,OAAO,KAAK;EACd,CAAC,CAAC;EAEF,IAAI1D,kBAAkB,CAAC;IACrBC,aAAa;IACbC,UAAU;IACVC;EACF,CAAC,CAAC,EAAE;IACF;EACF;EAEA,IAAI,OAAOD,UAAU,KAAK,QAAQ,IAAI,OAAOqC,oBAAoB,KAAK,QAAQ,EAAE;IAC9E,MAAMgC,MAAM,GAAG,CAACrC,KAAK,CAACM,IAAI,CAAC5B,MAAM;IAEjC,IAAI2D,MAAM,IAAIhC,oBAAoB,KAAK,IAAI,EAAE;MAC3C;IACF;IAEA,MAAM;MACJlC,WAAW;MACXmE;IACF,CAAC,GAAGrE,KAAK,CAACG,cAAc,CAAC,CAAC;IAC1B,IAAI,CAAE,KAAK,CAAEmE,IAAI,CAACpE,WAAW,CAAC,EAAE;MAC9B;IACF;IAEA,MAAMqE,aAAa,GAAGH,MAAM,GAAGhC,oBAAoB,GAAGrC,UAAU;IAEhE,MAAMyE,aAAa,GAAGtE,WAAW,CAACK,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAEE,MAAM;IAC7D,MAAMgE,YAAY,GAAG,CAACD,aAAa,IAAI,CAAC,IAAID,aAAa;IACzD,IAAIE,YAAY,GAAG,CAAC,EAAE;MACpBzE,KAAK,CAACC,WAAW,CACf,iBAAiBsE,aAAa,QAAQA,aAAa,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,0BAA0B,EAC9F;QACE1D,IAAI,EAAEwD,mBAAmB,GAAGI;MAC9B,CAAC,EACD,MAAM;QACJzE,KAAK,CAACc,mBAAmB,CAAC,CAACC,IAAI,EAAEC,UAAU,EAAEC,SAAS,EAAEC,UAAU,KAAK;UACrE,OAAOD,SAAS,CAACN,KAAK,CAAC,CAAC,EAAE,CAAC8D,YAAY,CAAC,CAACrD,GAAG,CAAC,CAACC,IAAI,EAAEC,GAAG,KAAK;YAC1D,OAAO;cACLC,MAAM,EAAE,CAAC;cACTC,MAAM,EAAE,EAAE;cACVC,MAAM,EAAET,UAAU,CAAC;gBACjB,GAAGD,IAAI;gBACPb,WAAW,EAAEmB,IAAI;gBACjBK,aAAa,EAAER,UAAU,CAACI,GAAG;cAC/B,CAAC;YACH,CAAC;UACH,CAAC,CAAC;QACJ,CAAC,CAAC;MACJ,CACF,CAAC;IACH,CAAC,MAAM,IAAImD,YAAY,GAAG,CAAC,EAAE;MAC3BzE,KAAK,CAACC,WAAW,CACf,YAAYsE,aAAa,gCAAgC,EACzD;QACE1D,IAAI,EAAEwD;MACR,CAAC,EACD,MAAM;QACJrE,KAAK,CAACc,mBAAmB,CAAC,CAACC,IAAI,EAAEC,UAAU,EAAEC,SAAS,EAAEC,UAAU,KAAK;UACrE,OAAO,CACL,GAAGD,SAAS,EACZ,GAAGyD,KAAK,CAACC,IAAI,CAAC;YACZlE,MAAM,EAAE,CAACgE;UACX,CAAC,EAAE,MAAM;YACP,OAAO,EAAE;UACX,CAAC,CAAC,CACH,CAACrD,GAAG,CAAC,CAACC,IAAI,EAAEC,GAAG,KAAK;YACnB,OAAO;cACLC,MAAM,EAAE,CAAC;cACTC,MAAM,EAAE,EAAE;cACVC,MAAM,EAAET,UAAU,CAAC;gBACjB,GAAGD,IAAI;gBACPb,WAAW,EAAEmB,IAAI;gBACjBK,aAAa,EAAEL,IAAI,CAACuD,IAAI,CAAC,CAAC,GAAG1D,UAAU,CAACI,GAAG,CAAC,GAAG;cACjD,CAAC;YACH,CAAC;UACH,CAAC,CAAC;QACJ,CAAC,CAAC;MACJ,CACF,CAAC;IACH;EACF;AACF,CAAC,EAAE;EACDuD,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJ7E,WAAW,EAAE,8DAA8D;MAC3E8E,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEhF,WAAW,EAAE;AACrB;AACA;AACA;AACA,cAAc;MACNiF,IAAI,EAAE,CACJ,QAAQ,EAAE,KAAK,EAAE,OAAO,CACzB;MACDlC,IAAI,EAAE;IACR,CAAC,EACD;MACEmC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVpD,aAAa,EAAE;UACb/B,WAAW,EAAE;AACzB;AACA;AACA,sBAAsB;UACV+C,IAAI,EAAE;QACR,CAAC;QACDf,KAAK,EAAE;UACLhC,WAAW,EAAE;AACzB;AACA,eAAe;UACH+C,IAAI,EAAE;QACR,CAAC;QACDd,QAAQ,EAAE;UACRmD,KAAK,EAAE,CACL;YACErC,IAAI,EAAE;UACR,CAAC,EACD;YACEA,IAAI,EAAE;UACR,CAAC,CACF;UACD/C,WAAW,EAAE;AACzB;AACA;AACA;QACU,CAAC;QACDJ,aAAa,EAAE;UACbwF,KAAK,EAAE,CACL;YACErC,IAAI,EAAE;UACR,CAAC,EACD;YACEA,IAAI,EAAE;UACR,CAAC,CACF;UACD/C,WAAW,EAAE;AACzB;AACA;AACA;AACA;QACU,CAAC;QACDH,UAAU,EAAE;UACVuF,KAAK,EAAE,CACL;YACErC,IAAI,EAAE;UACR,CAAC,EACD;YACEA,IAAI,EAAE;UACR,CAAC,CACF;UACD/C,WAAW,EAAE;AACzB;AACA;AACA;AACA;QACU,CAAC;QACDkC,oBAAoB,EAAE;UACpBlC,WAAW,EAAE,0GAA0G;UACvH+C,IAAI,EAAE;QACR,CAAC;QACDZ,IAAI,EAAE;UACJnC,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA,0BAA0B;UACdqF,iBAAiB,EAAE;YACjB,IAAI,EAAE;cACJH,oBAAoB,EAAE,KAAK;cAC3BC,UAAU,EAAE;gBACVnD,KAAK,EAAE;kBACLe,IAAI,EAAE;gBACR,CAAC;gBACDG,KAAK,EAAE;kBACL+B,IAAI,EAAE,CACJ,QAAQ,EAAE,OAAO,EAAE,KAAK,CACzB;kBACDlC,IAAI,EAAE;gBACR;cACF;YACF;UACF,CAAC;UACDA,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAuC,MAAA,CAAA5D,OAAA,GAAAA,OAAA,CAAAhC,OAAA","ignoreList":[]}

package/dist/rules/tagLines.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("eslint").Rule.RuleModule;
+export default _default;
+//# sourceMappingURL=tagLines.d.ts.map

package/dist/rules/textEscaping.cjs

@@ -0,0 +1,141 @@
+"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 }; }
+// We could disallow raw gt, quot, and apos, but allow for parity; but we do
+//  not allow hex or decimal character references
+const htmlRegex = /(<|&(?!(?:amp|lt|gt|quot|apos);))(?=\S)/v;
+const markdownRegex = /(?<!\\)(`+)([^`]+)\1(?!`)/v;
+
+/**
+ * @param {string} desc
+ * @returns {string}
+ */
+const htmlReplacer = desc => {
+  return desc.replaceAll(new RegExp(htmlRegex, 'gv'), _ => {
+    if (_ === '<') {
+      return '&lt;';
+    }
+    return '&amp;';
+  });
+};
+
+/**
+ * @param {string} desc
+ * @returns {string}
+ */
+const markdownReplacer = desc => {
+  return desc.replaceAll(new RegExp(markdownRegex, 'gv'), (_, backticks, encapsed) => {
+    const bookend = '`'.repeat(backticks.length);
+    return `\\${bookend}${encapsed}${bookend}`;
+  });
+};
+var _default = exports.default = (0, _iterateJsdoc.default)(({
+  context,
+  jsdoc,
+  utils
+}) => {
+  const {
+    escapeHTML,
+    escapeMarkdown
+  } = context.options[0] || {};
+  if (!escapeHTML && !escapeMarkdown) {
+    context.report({
+      loc: {
+        end: {
+          column: 1,
+          line: 1
+        },
+        start: {
+          column: 1,
+          line: 1
+        }
+      },
+      message: 'You must include either `escapeHTML` or `escapeMarkdown`'
+    });
+    return;
+  }
+  const {
+    descriptions
+  } = utils.getDescription();
+  if (escapeHTML) {
+    if (descriptions.some(desc => {
+      return htmlRegex.test(desc);
+    })) {
+      const line = utils.setDescriptionLines(htmlRegex, htmlReplacer);
+      utils.reportJSDoc('You have unescaped HTML characters < or &', {
+        line
+      }, () => {}, true);
+      return;
+    }
+    for (const tag of jsdoc.tags) {
+      if (tag.tag === 'example') {
+        continue;
+      }
+      if (/** @type {string[]} */utils.getTagDescription(tag, true).some(desc => {
+        return htmlRegex.test(desc);
+      })) {
+        const line = utils.setTagDescription(tag, htmlRegex, htmlReplacer) + tag.source[0].number;
+        utils.reportJSDoc('You have unescaped HTML characters < or & in a tag', {
+          line
+        }, () => {}, true);
+      }
+    }
+    return;
+  }
+  if (descriptions.some(desc => {
+    return markdownRegex.test(desc);
+  })) {
+    const line = utils.setDescriptionLines(markdownRegex, markdownReplacer);
+    utils.reportJSDoc('You have unescaped Markdown backtick sequences', {
+      line
+    }, () => {}, true);
+    return;
+  }
+  for (const tag of jsdoc.tags) {
+    if (tag.tag === 'example') {
+      continue;
+    }
+    if (/** @type {string[]} */utils.getTagDescription(tag, true).some(desc => {
+      return markdownRegex.test(desc);
+    })) {
+      const line = utils.setTagDescription(tag, markdownRegex, markdownReplacer) + tag.source[0].number;
+      utils.reportJSDoc('You have unescaped Markdown backtick sequences in a tag', {
+        line
+      }, () => {}, true);
+    }
+  }
+}, {
+  iterateAllJsdocs: true,
+  meta: {
+    docs: {
+      description: 'Auto-escape certain characters that are input within block and tag descriptions.',
+      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/text-escaping.md#repos-sticky-header'
+    },
+    fixable: 'code',
+    schema: [{
+      additionalProperties: false,
+      properties: {
+        escapeHTML: {
+          description: `This option escapes all \`<\` and \`&\` characters (except those followed by
+whitespace which are treated as literals by Visual Studio Code). Defaults to
+\`false\`.`,
+          type: 'boolean'
+        },
+        escapeMarkdown: {
+          description: `This option escapes the first backtick (\`\` \` \`\`) in a paired sequence.
+Defaults to \`false\`.`,
+          type: 'boolean'
+        }
+      },
+      type: 'object'
+    }],
+    type: 'suggestion'
+  }
+});
+module.exports = exports.default;
+//# sourceMappingURL=textEscaping.cjs.map