eslint-plugin-jsdoc 46.4.5 → 46.5.0

package/README.md

@@ -12,6 +12,8 @@ JSDoc linting rules for ESLint.
 * [eslint-plugin-jsdoc](#user-content-eslint-plugin-jsdoc)
     * [Installation](#user-content-eslint-plugin-jsdoc-installation)
     * [Configuration](#user-content-eslint-plugin-jsdoc-configuration)
+        * [Flat config](#user-content-eslint-plugin-jsdoc-configuration-flat-config)
+        * [`eslintrc`](#user-content-eslint-plugin-jsdoc-configuration-eslintrc)
     * [Options](#user-content-eslint-plugin-jsdoc-options)
     * [Settings](#user-content-eslint-plugin-jsdoc-settings)
     * [Advanced](#user-content-eslint-plugin-jsdoc-advanced)
@@ -40,6 +42,35 @@ npm install --save-dev eslint-plugin-jsdoc
 <a name="eslint-plugin-jsdoc-configuration"></a>
 ## Configuration
 
+<a name="user-content-eslint-plugin-jsdoc-configuration-flat-config"></a>
+<a name="eslint-plugin-jsdoc-configuration-flat-config"></a>
+### Flat config
+
+```js
+import jsdoc from 'eslint-plugin-jsdoc';
+
+const config = [
+  // configuration included in plugin
+  jsdoc.configs['flat/recommended'],
+  // other configuration objects...
+  {
+    files: ['**/*.js'],
+    plugins: {
+      jsdoc,
+    },
+    rules: {
+      'jsdoc/require-description': 'warn'
+    }
+  }
+];
+
+export default config;
+```
+
+<a name="user-content-eslint-plugin-jsdoc-configuration-eslintrc"></a>
+<a name="eslint-plugin-jsdoc-configuration-eslintrc"></a>
+### <code>eslintrc</code>
+
 Add `plugins` section to [.eslintrc.*](https://eslint.org/docs/user-guide/configuring#configuration-file-formats)
 and specify `eslint-plugin-jsdoc` as a plugin.
 

package/dist/alignTransform.js

@@ -25,10 +25,10 @@ const {
 
 /**
  * @typedef {{
- *   name: import('./iterateJsdoc').Integer,
- *   start: import('./iterateJsdoc').Integer,
- *   tag: import('./iterateJsdoc').Integer,
- *   type: import('./iterateJsdoc').Integer
+ *   name: import('./iterateJsdoc.js').Integer,
+ *   start: import('./iterateJsdoc.js').Integer,
+ *   tag: import('./iterateJsdoc.js').Integer,
+ *   type: import('./iterateJsdoc.js').Integer
  * }} Width
  */
 
@@ -42,7 +42,7 @@ const zeroWidth = {
 
 /**
  * @param {string[]} tags
- * @param {import('./iterateJsdoc').Integer} index
+ * @param {import('./iterateJsdoc.js').Integer} index
  * @param {import('comment-parser').Line[]} source
  * @returns {boolean}
  */

package/dist/alignTransform.js.map

@@ -1 +1 @@
-{"version":3,"file":"alignTransform.js","names":["_commentParser","require","rewireSource","util","zeroWidth","name","start","tag","type","shouldAlign","tags","index","source","tokens","replace","includesTag","includes","iterator","previousTag","getWidth","width","Math","max","length","delimiter","getTypelessInfo","fields","hasNoTypes","every","maxNamedTagLength","map","filter","maxUnnamedTagLength","space","len","padStart","alignTransform","customSpacings","indent","preserveMainDescriptionPostDelimiter","wrapIndent","intoTags","alignTokens","typelessInfo","nothingAfter","delim","description","postName","postType","postTag","untypedNameAdjustment","untypedTypeAdjustment","spacings","postDelimiter","update","line","indentTag","isEmpty","end","postHyphenSpacing","postHyphen","hyphenSpacing","reduce","tagIndentMode","ret","_default","exports","default","module"],"sources":["../src/alignTransform.js"],"sourcesContent":["/**\n * Transform based on https://github.com/syavorsky/comment-parser/blob/master/src/transforms/align.ts\n *\n * It contains some customizations to align based on the tags, and some custom options.\n */\n\nimport {\n  // `comment-parser/primitives` export\n  util,\n} from 'comment-parser';\n\n/**\n * @typedef {{\n *   hasNoTypes: boolean,\n *   maxNamedTagLength: import('./iterateJsdoc.js').Integer,\n *   maxUnnamedTagLength: import('./iterateJsdoc.js').Integer\n * }} TypelessInfo\n */\n\nconst {\n  rewireSource,\n} = util;\n\n/**\n * @typedef {{\n *   name: import('./iterateJsdoc').Integer,\n *   start: import('./iterateJsdoc').Integer,\n *   tag: import('./iterateJsdoc').Integer,\n *   type: import('./iterateJsdoc').Integer\n * }} Width\n */\n\n/** @type {Width} */\nconst zeroWidth = {\n  name: 0,\n  start: 0,\n  tag: 0,\n  type: 0,\n};\n\n/**\n * @param {string[]} tags\n * @param {import('./iterateJsdoc').Integer} index\n * @param {import('comment-parser').Line[]} source\n * @returns {boolean}\n */\nconst shouldAlign = (tags, index, source) => {\n  const tag = source[index].tokens.tag.replace('@', '');\n  const includesTag = tags.includes(tag);\n\n  if (includesTag) {\n    return true;\n  }\n\n  if (tag !== '') {\n    return false;\n  }\n\n  for (let iterator = index; iterator >= 0; iterator--) {\n    const previousTag = source[iterator].tokens.tag.replace('@', '');\n\n    if (previousTag !== '') {\n      if (tags.includes(previousTag)) {\n        return true;\n      }\n\n      return false;\n    }\n  }\n\n  return true;\n};\n\n/**\n * @param {string[]} tags\n * @returns {(\n *   width: Width,\n *   line: {\n *     tokens: import('comment-parser').Tokens\n *   },\n *   index: import('./iterateJsdoc.js').Integer,\n *   source: import('comment-parser').Line[]\n * ) => Width}\n */\nconst getWidth = (tags) => {\n  return (width, {\n    tokens,\n  }, index, source) => {\n    if (!shouldAlign(tags, index, source)) {\n      return width;\n    }\n\n    return {\n      name: Math.max(width.name, tokens.name.length),\n      start: tokens.delimiter === '/**' ? tokens.start.length : width.start,\n      tag: Math.max(width.tag, tokens.tag.length),\n      type: Math.max(width.type, tokens.type.length),\n    };\n  };\n};\n\n/**\n * @param {{\n *   description: string;\n *   tags: import('comment-parser').Spec[];\n *   problems: import('comment-parser').Problem[];\n * }} fields\n * @returns {TypelessInfo}\n */\nconst getTypelessInfo = (fields) => {\n  const hasNoTypes = fields.tags.every(({\n    type,\n  }) => {\n    return !type;\n  });\n  const maxNamedTagLength = Math.max(...fields.tags.map(({\n    tag,\n    name,\n  }) => {\n    return name.length === 0 ? -1 : tag.length;\n  }).filter((length) => {\n    return length !== -1;\n  })) + 1;\n  const maxUnnamedTagLength = Math.max(...fields.tags.map(({\n    tag,\n    name,\n  }) => {\n    return name.length === 0 ? tag.length : -1;\n  }).filter((length) => {\n    return length !== -1;\n  })) + 1;\n  return {\n    hasNoTypes,\n    maxNamedTagLength,\n    maxUnnamedTagLength,\n  };\n};\n\n/**\n * @param {import('./iterateJsdoc.js').Integer} len\n * @returns {string}\n */\nconst space = (len) => {\n  return ''.padStart(len, ' ');\n};\n\n/**\n * @param {{\n *   customSpacings: import('../src/rules/checkLineAlignment.js').CustomSpacings,\n *   tags: string[],\n *   indent: string,\n *   preserveMainDescriptionPostDelimiter: boolean,\n *   wrapIndent: string,\n * }} cfg\n * @returns {(\n *   block: import('comment-parser').Block\n * ) => import('comment-parser').Block}\n */\nconst alignTransform = ({\n  customSpacings,\n  tags,\n  indent,\n  preserveMainDescriptionPostDelimiter,\n  wrapIndent,\n}) => {\n  let intoTags = false;\n  /** @type {Width} */\n  let width;\n\n  /**\n   * @param {import('comment-parser').Tokens} tokens\n   * @param {TypelessInfo} typelessInfo\n   * @returns {import('comment-parser').Tokens}\n   */\n  const alignTokens = (tokens, typelessInfo) => {\n    const nothingAfter = {\n      delim: false,\n      name: false,\n      tag: false,\n      type: false,\n    };\n\n    if (tokens.description === '') {\n      nothingAfter.name = true;\n      tokens.postName = '';\n\n      if (tokens.name === '') {\n        nothingAfter.type = true;\n        tokens.postType = '';\n\n        if (tokens.type === '') {\n          nothingAfter.tag = true;\n          tokens.postTag = '';\n\n          /* istanbul ignore next: Never happens because the !intoTags return. But it's here for consistency with the original align transform */\n          if (tokens.tag === '') {\n            nothingAfter.delim = true;\n          }\n        }\n      }\n    }\n\n    let untypedNameAdjustment = 0;\n    let untypedTypeAdjustment = 0;\n    if (typelessInfo.hasNoTypes) {\n      nothingAfter.tag = true;\n      tokens.postTag = '';\n      if (tokens.name === '') {\n        untypedNameAdjustment = typelessInfo.maxNamedTagLength - tokens.tag.length;\n      } else {\n        untypedNameAdjustment = typelessInfo.maxNamedTagLength > typelessInfo.maxUnnamedTagLength ? 0 :\n          Math.max(0, typelessInfo.maxUnnamedTagLength - (tokens.tag.length + tokens.name.length + 1));\n        untypedTypeAdjustment = typelessInfo.maxNamedTagLength - tokens.tag.length;\n      }\n    }\n\n    // Todo: Avoid fixing alignment of blocks with multiline wrapping of type\n    if (tokens.tag === '' && tokens.type) {\n      return tokens;\n    }\n\n    const spacings = {\n      postDelimiter: customSpacings?.postDelimiter || 1,\n      postName: customSpacings?.postName || 1,\n      postTag: customSpacings?.postTag || 1,\n      postType: customSpacings?.postType || 1,\n    };\n\n    tokens.postDelimiter = nothingAfter.delim ? '' : space(spacings.postDelimiter);\n\n    if (!nothingAfter.tag) {\n      tokens.postTag = space(width.tag - tokens.tag.length + spacings.postTag);\n    }\n\n    if (!nothingAfter.type) {\n      tokens.postType = space(width.type - tokens.type.length + spacings.postType + untypedTypeAdjustment);\n    }\n\n    if (!nothingAfter.name) {\n      // If post name is empty for all lines (name width 0), don't add post name spacing.\n      tokens.postName = width.name === 0 ? '' : space(width.name - tokens.name.length + spacings.postName + untypedNameAdjustment);\n    }\n\n    return tokens;\n  };\n\n  /**\n   * @param {import('comment-parser').Line} line\n   * @param {import('./iterateJsdoc.js').Integer} index\n   * @param {import('comment-parser').Line[]} source\n   * @param {TypelessInfo} typelessInfo\n   * @param {string|false} indentTag\n   * @returns {import('comment-parser').Line}\n   */\n  const update = (line, index, source, typelessInfo, indentTag) => {\n    /** @type {import('comment-parser').Tokens} */\n    const tokens = {\n      ...line.tokens,\n    };\n\n    if (tokens.tag !== '') {\n      intoTags = true;\n    }\n\n    const isEmpty =\n      tokens.tag === '' &&\n      tokens.name === '' &&\n      tokens.type === '' &&\n      tokens.description === '';\n\n    // dangling '*/'\n    if (tokens.end === '*/' && isEmpty) {\n      tokens.start = indent + ' ';\n\n      return {\n        ...line,\n        tokens,\n      };\n    }\n\n    switch (tokens.delimiter) {\n    case '/**':\n      tokens.start = indent;\n      break;\n    case '*':\n      tokens.start = indent + ' ';\n      break;\n    default:\n      tokens.delimiter = '';\n\n      // compensate delimiter\n      tokens.start = indent + '  ';\n    }\n\n    if (!intoTags) {\n      if (tokens.description === '') {\n        tokens.postDelimiter = '';\n      } else if (!preserveMainDescriptionPostDelimiter) {\n        tokens.postDelimiter = ' ';\n      }\n\n      return {\n        ...line,\n        tokens,\n      };\n    }\n\n    const postHyphenSpacing = customSpacings?.postHyphen ?? 1;\n    const hyphenSpacing = /^\\s*-\\s+/u;\n    tokens.description = tokens.description.replace(\n      hyphenSpacing, '-' + ''.padStart(postHyphenSpacing, ' '),\n    );\n\n    // Not align.\n    if (shouldAlign(tags, index, source)) {\n      alignTokens(tokens, typelessInfo);\n      if (indentTag) {\n        tokens.postDelimiter += wrapIndent;\n      }\n    }\n\n    return {\n      ...line,\n      tokens,\n    };\n  };\n\n  return ({\n    source,\n    ...fields\n  }) => {\n    width = source.reduce(getWidth(tags), {\n      ...zeroWidth,\n    });\n\n    const typelessInfo = getTypelessInfo(fields);\n\n    let tagIndentMode = false;\n\n    return rewireSource({\n      ...fields,\n      source: source.map((line, index) => {\n        const indentTag = tagIndentMode && !line.tokens.tag && line.tokens.description;\n        const ret = update(line, index, source, typelessInfo, indentTag);\n\n        if (line.tokens.tag) {\n          tagIndentMode = true;\n        }\n\n        return ret;\n      }),\n    });\n  };\n};\n\nexport default alignTransform;\n"],"mappings":";;;;;;AAMA,IAAAA,cAAA,GAAAC,OAAA;AANA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,MAAM;EACJC;AACF,CAAC,GAAGC,mBAAI;;AAER;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA,MAAMC,SAAS,GAAG;EAChBC,IAAI,EAAE,CAAC;EACPC,KAAK,EAAE,CAAC;EACRC,GAAG,EAAE,CAAC;EACNC,IAAI,EAAE;AACR,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,WAAW,GAAGA,CAACC,IAAI,EAAEC,KAAK,EAAEC,MAAM,KAAK;EAC3C,MAAML,GAAG,GAAGK,MAAM,CAACD,KAAK,CAAC,CAACE,MAAM,CAACN,GAAG,CAACO,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;EACrD,MAAMC,WAAW,GAAGL,IAAI,CAACM,QAAQ,CAACT,GAAG,CAAC;EAEtC,IAAIQ,WAAW,EAAE;IACf,OAAO,IAAI;EACb;EAEA,IAAIR,GAAG,KAAK,EAAE,EAAE;IACd,OAAO,KAAK;EACd;EAEA,KAAK,IAAIU,QAAQ,GAAGN,KAAK,EAAEM,QAAQ,IAAI,CAAC,EAAEA,QAAQ,EAAE,EAAE;IACpD,MAAMC,WAAW,GAAGN,MAAM,CAACK,QAAQ,CAAC,CAACJ,MAAM,CAACN,GAAG,CAACO,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;IAEhE,IAAII,WAAW,KAAK,EAAE,EAAE;MACtB,IAAIR,IAAI,CAACM,QAAQ,CAACE,WAAW,CAAC,EAAE;QAC9B,OAAO,IAAI;MACb;MAEA,OAAO,KAAK;IACd;EACF;EAEA,OAAO,IAAI;AACb,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,QAAQ,GAAIT,IAAI,IAAK;EACzB,OAAO,CAACU,KAAK,EAAE;IACbP;EACF,CAAC,EAAEF,KAAK,EAAEC,MAAM,KAAK;IACnB,IAAI,CAACH,WAAW,CAACC,IAAI,EAAEC,KAAK,EAAEC,MAAM,CAAC,EAAE;MACrC,OAAOQ,KAAK;IACd;IAEA,OAAO;MACLf,IAAI,EAAEgB,IAAI,CAACC,GAAG,CAACF,KAAK,CAACf,IAAI,EAAEQ,MAAM,CAACR,IAAI,CAACkB,MAAM,CAAC;MAC9CjB,KAAK,EAAEO,MAAM,CAACW,SAAS,KAAK,KAAK,GAAGX,MAAM,CAACP,KAAK,CAACiB,MAAM,GAAGH,KAAK,CAACd,KAAK;MACrEC,GAAG,EAAEc,IAAI,CAACC,GAAG,CAACF,KAAK,CAACb,GAAG,EAAEM,MAAM,CAACN,GAAG,CAACgB,MAAM,CAAC;MAC3Cf,IAAI,EAAEa,IAAI,CAACC,GAAG,CAACF,KAAK,CAACZ,IAAI,EAAEK,MAAM,CAACL,IAAI,CAACe,MAAM;IAC/C,CAAC;EACH,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAME,eAAe,GAAIC,MAAM,IAAK;EAClC,MAAMC,UAAU,GAAGD,MAAM,CAAChB,IAAI,CAACkB,KAAK,CAAC,CAAC;IACpCpB;EACF,CAAC,KAAK;IACJ,OAAO,CAACA,IAAI;EACd,CAAC,CAAC;EACF,MAAMqB,iBAAiB,GAAGR,IAAI,CAACC,GAAG,CAAC,GAAGI,MAAM,CAAChB,IAAI,CAACoB,GAAG,CAAC,CAAC;IACrDvB,GAAG;IACHF;EACF,CAAC,KAAK;IACJ,OAAOA,IAAI,CAACkB,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC,GAAGhB,GAAG,CAACgB,MAAM;EAC5C,CAAC,CAAC,CAACQ,MAAM,CAAER,MAAM,IAAK;IACpB,OAAOA,MAAM,KAAK,CAAC,CAAC;EACtB,CAAC,CAAC,CAAC,GAAG,CAAC;EACP,MAAMS,mBAAmB,GAAGX,IAAI,CAACC,GAAG,CAAC,GAAGI,MAAM,CAAChB,IAAI,CAACoB,GAAG,CAAC,CAAC;IACvDvB,GAAG;IACHF;EACF,CAAC,KAAK;IACJ,OAAOA,IAAI,CAACkB,MAAM,KAAK,CAAC,GAAGhB,GAAG,CAACgB,MAAM,GAAG,CAAC,CAAC;EAC5C,CAAC,CAAC,CAACQ,MAAM,CAAER,MAAM,IAAK;IACpB,OAAOA,MAAM,KAAK,CAAC,CAAC;EACtB,CAAC,CAAC,CAAC,GAAG,CAAC;EACP,OAAO;IACLI,UAAU;IACVE,iBAAiB;IACjBG;EACF,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAMC,KAAK,GAAIC,GAAG,IAAK;EACrB,OAAO,EAAE,CAACC,QAAQ,CAACD,GAAG,EAAE,GAAG,CAAC;AAC9B,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAME,cAAc,GAAGA,CAAC;EACtBC,cAAc;EACd3B,IAAI;EACJ4B,MAAM;EACNC,oCAAoC;EACpCC;AACF,CAAC,KAAK;EACJ,IAAIC,QAAQ,GAAG,KAAK;EACpB;EACA,IAAIrB,KAAK;;EAET;AACF;AACA;AACA;AACA;EACE,MAAMsB,WAAW,GAAGA,CAAC7B,MAAM,EAAE8B,YAAY,KAAK;IAC5C,MAAMC,YAAY,GAAG;MACnBC,KAAK,EAAE,KAAK;MACZxC,IAAI,EAAE,KAAK;MACXE,GAAG,EAAE,KAAK;MACVC,IAAI,EAAE;IACR,CAAC;IAED,IAAIK,MAAM,CAACiC,WAAW,KAAK,EAAE,EAAE;MAC7BF,YAAY,CAACvC,IAAI,GAAG,IAAI;MACxBQ,MAAM,CAACkC,QAAQ,GAAG,EAAE;MAEpB,IAAIlC,MAAM,CAACR,IAAI,KAAK,EAAE,EAAE;QACtBuC,YAAY,CAACpC,IAAI,GAAG,IAAI;QACxBK,MAAM,CAACmC,QAAQ,GAAG,EAAE;QAEpB,IAAInC,MAAM,CAACL,IAAI,KAAK,EAAE,EAAE;UACtBoC,YAAY,CAACrC,GAAG,GAAG,IAAI;UACvBM,MAAM,CAACoC,OAAO,GAAG,EAAE;;UAEnB;UACA,IAAIpC,MAAM,CAACN,GAAG,KAAK,EAAE,EAAE;YACrBqC,YAAY,CAACC,KAAK,GAAG,IAAI;UAC3B;QACF;MACF;IACF;IAEA,IAAIK,qBAAqB,GAAG,CAAC;IAC7B,IAAIC,qBAAqB,GAAG,CAAC;IAC7B,IAAIR,YAAY,CAAChB,UAAU,EAAE;MAC3BiB,YAAY,CAACrC,GAAG,GAAG,IAAI;MACvBM,MAAM,CAACoC,OAAO,GAAG,EAAE;MACnB,IAAIpC,MAAM,CAACR,IAAI,KAAK,EAAE,EAAE;QACtB6C,qBAAqB,GAAGP,YAAY,CAACd,iBAAiB,GAAGhB,MAAM,CAACN,GAAG,CAACgB,MAAM;MAC5E,CAAC,MAAM;QACL2B,qBAAqB,GAAGP,YAAY,CAACd,iBAAiB,GAAGc,YAAY,CAACX,mBAAmB,GAAG,CAAC,GAC3FX,IAAI,CAACC,GAAG,CAAC,CAAC,EAAEqB,YAAY,CAACX,mBAAmB,IAAInB,MAAM,CAACN,GAAG,CAACgB,MAAM,GAAGV,MAAM,CAACR,IAAI,CAACkB,MAAM,GAAG,CAAC,CAAC,CAAC;QAC9F4B,qBAAqB,GAAGR,YAAY,CAACd,iBAAiB,GAAGhB,MAAM,CAACN,GAAG,CAACgB,MAAM;MAC5E;IACF;;IAEA;IACA,IAAIV,MAAM,CAACN,GAAG,KAAK,EAAE,IAAIM,MAAM,CAACL,IAAI,EAAE;MACpC,OAAOK,MAAM;IACf;IAEA,MAAMuC,QAAQ,GAAG;MACfC,aAAa,EAAE,CAAAhB,cAAc,aAAdA,cAAc,uBAAdA,cAAc,CAAEgB,aAAa,KAAI,CAAC;MACjDN,QAAQ,EAAE,CAAAV,cAAc,aAAdA,cAAc,uBAAdA,cAAc,CAAEU,QAAQ,KAAI,CAAC;MACvCE,OAAO,EAAE,CAAAZ,cAAc,aAAdA,cAAc,uBAAdA,cAAc,CAAEY,OAAO,KAAI,CAAC;MACrCD,QAAQ,EAAE,CAAAX,cAAc,aAAdA,cAAc,uBAAdA,cAAc,CAAEW,QAAQ,KAAI;IACxC,CAAC;IAEDnC,MAAM,CAACwC,aAAa,GAAGT,YAAY,CAACC,KAAK,GAAG,EAAE,GAAGZ,KAAK,CAACmB,QAAQ,CAACC,aAAa,CAAC;IAE9E,IAAI,CAACT,YAAY,CAACrC,GAAG,EAAE;MACrBM,MAAM,CAACoC,OAAO,GAAGhB,KAAK,CAACb,KAAK,CAACb,GAAG,GAAGM,MAAM,CAACN,GAAG,CAACgB,MAAM,GAAG6B,QAAQ,CAACH,OAAO,CAAC;IAC1E;IAEA,IAAI,CAACL,YAAY,CAACpC,IAAI,EAAE;MACtBK,MAAM,CAACmC,QAAQ,GAAGf,KAAK,CAACb,KAAK,CAACZ,IAAI,GAAGK,MAAM,CAACL,IAAI,CAACe,MAAM,GAAG6B,QAAQ,CAACJ,QAAQ,GAAGG,qBAAqB,CAAC;IACtG;IAEA,IAAI,CAACP,YAAY,CAACvC,IAAI,EAAE;MACtB;MACAQ,MAAM,CAACkC,QAAQ,GAAG3B,KAAK,CAACf,IAAI,KAAK,CAAC,GAAG,EAAE,GAAG4B,KAAK,CAACb,KAAK,CAACf,IAAI,GAAGQ,MAAM,CAACR,IAAI,CAACkB,MAAM,GAAG6B,QAAQ,CAACL,QAAQ,GAAGG,qBAAqB,CAAC;IAC9H;IAEA,OAAOrC,MAAM;EACf,CAAC;;EAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMyC,MAAM,GAAGA,CAACC,IAAI,EAAE5C,KAAK,EAAEC,MAAM,EAAE+B,YAAY,EAAEa,SAAS,KAAK;IAC/D;IACA,MAAM3C,MAAM,GAAG;MACb,GAAG0C,IAAI,CAAC1C;IACV,CAAC;IAED,IAAIA,MAAM,CAACN,GAAG,KAAK,EAAE,EAAE;MACrBkC,QAAQ,GAAG,IAAI;IACjB;IAEA,MAAMgB,OAAO,GACX5C,MAAM,CAACN,GAAG,KAAK,EAAE,IACjBM,MAAM,CAACR,IAAI,KAAK,EAAE,IAClBQ,MAAM,CAACL,IAAI,KAAK,EAAE,IAClBK,MAAM,CAACiC,WAAW,KAAK,EAAE;;IAE3B;IACA,IAAIjC,MAAM,CAAC6C,GAAG,KAAK,IAAI,IAAID,OAAO,EAAE;MAClC5C,MAAM,CAACP,KAAK,GAAGgC,MAAM,GAAG,GAAG;MAE3B,OAAO;QACL,GAAGiB,IAAI;QACP1C;MACF,CAAC;IACH;IAEA,QAAQA,MAAM,CAACW,SAAS;MACxB,KAAK,KAAK;QACRX,MAAM,CAACP,KAAK,GAAGgC,MAAM;QACrB;MACF,KAAK,GAAG;QACNzB,MAAM,CAACP,KAAK,GAAGgC,MAAM,GAAG,GAAG;QAC3B;MACF;QACEzB,MAAM,CAACW,SAAS,GAAG,EAAE;;QAErB;QACAX,MAAM,CAACP,KAAK,GAAGgC,MAAM,GAAG,IAAI;IAC9B;IAEA,IAAI,CAACG,QAAQ,EAAE;MACb,IAAI5B,MAAM,CAACiC,WAAW,KAAK,EAAE,EAAE;QAC7BjC,MAAM,CAACwC,aAAa,GAAG,EAAE;MAC3B,CAAC,MAAM,IAAI,CAACd,oCAAoC,EAAE;QAChD1B,MAAM,CAACwC,aAAa,GAAG,GAAG;MAC5B;MAEA,OAAO;QACL,GAAGE,IAAI;QACP1C;MACF,CAAC;IACH;IAEA,MAAM8C,iBAAiB,GAAG,CAAAtB,cAAc,aAAdA,cAAc,uBAAdA,cAAc,CAAEuB,UAAU,KAAI,CAAC;IACzD,MAAMC,aAAa,GAAG,WAAW;IACjChD,MAAM,CAACiC,WAAW,GAAGjC,MAAM,CAACiC,WAAW,CAAChC,OAAO,CAC7C+C,aAAa,EAAE,GAAG,GAAG,EAAE,CAAC1B,QAAQ,CAACwB,iBAAiB,EAAE,GAAG,CACzD,CAAC;;IAED;IACA,IAAIlD,WAAW,CAACC,IAAI,EAAEC,KAAK,EAAEC,MAAM,CAAC,EAAE;MACpC8B,WAAW,CAAC7B,MAAM,EAAE8B,YAAY,CAAC;MACjC,IAAIa,SAAS,EAAE;QACb3C,MAAM,CAACwC,aAAa,IAAIb,UAAU;MACpC;IACF;IAEA,OAAO;MACL,GAAGe,IAAI;MACP1C;IACF,CAAC;EACH,CAAC;EAED,OAAO,CAAC;IACND,MAAM;IACN,GAAGc;EACL,CAAC,KAAK;IACJN,KAAK,GAAGR,MAAM,CAACkD,MAAM,CAAC3C,QAAQ,CAACT,IAAI,CAAC,EAAE;MACpC,GAAGN;IACL,CAAC,CAAC;IAEF,MAAMuC,YAAY,GAAGlB,eAAe,CAACC,MAAM,CAAC;IAE5C,IAAIqC,aAAa,GAAG,KAAK;IAEzB,OAAO7D,YAAY,CAAC;MAClB,GAAGwB,MAAM;MACTd,MAAM,EAAEA,MAAM,CAACkB,GAAG,CAAC,CAACyB,IAAI,EAAE5C,KAAK,KAAK;QAClC,MAAM6C,SAAS,GAAGO,aAAa,IAAI,CAACR,IAAI,CAAC1C,MAAM,CAACN,GAAG,IAAIgD,IAAI,CAAC1C,MAAM,CAACiC,WAAW;QAC9E,MAAMkB,GAAG,GAAGV,MAAM,CAACC,IAAI,EAAE5C,KAAK,EAAEC,MAAM,EAAE+B,YAAY,EAAEa,SAAS,CAAC;QAEhE,IAAID,IAAI,CAAC1C,MAAM,CAACN,GAAG,EAAE;UACnBwD,aAAa,GAAG,IAAI;QACtB;QAEA,OAAOC,GAAG;MACZ,CAAC;IACH,CAAC,CAAC;EACJ,CAAC;AACH,CAAC;AAAC,IAAAC,QAAA,GAEa7B,cAAc;AAAA8B,OAAA,CAAAC,OAAA,GAAAF,QAAA;AAAAG,MAAA,CAAAF,OAAA,GAAAA,OAAA,CAAAC,OAAA"}
+{"version":3,"file":"alignTransform.js","names":["_commentParser","require","rewireSource","util","zeroWidth","name","start","tag","type","shouldAlign","tags","index","source","tokens","replace","includesTag","includes","iterator","previousTag","getWidth","width","Math","max","length","delimiter","getTypelessInfo","fields","hasNoTypes","every","maxNamedTagLength","map","filter","maxUnnamedTagLength","space","len","padStart","alignTransform","customSpacings","indent","preserveMainDescriptionPostDelimiter","wrapIndent","intoTags","alignTokens","typelessInfo","nothingAfter","delim","description","postName","postType","postTag","untypedNameAdjustment","untypedTypeAdjustment","spacings","postDelimiter","update","line","indentTag","isEmpty","end","postHyphenSpacing","postHyphen","hyphenSpacing","reduce","tagIndentMode","ret","_default","exports","default","module"],"sources":["../src/alignTransform.js"],"sourcesContent":["/**\n * Transform based on https://github.com/syavorsky/comment-parser/blob/master/src/transforms/align.ts\n *\n * It contains some customizations to align based on the tags, and some custom options.\n */\n\nimport {\n  // `comment-parser/primitives` export\n  util,\n} from 'comment-parser';\n\n/**\n * @typedef {{\n *   hasNoTypes: boolean,\n *   maxNamedTagLength: import('./iterateJsdoc.js').Integer,\n *   maxUnnamedTagLength: import('./iterateJsdoc.js').Integer\n * }} TypelessInfo\n */\n\nconst {\n  rewireSource,\n} = util;\n\n/**\n * @typedef {{\n *   name: import('./iterateJsdoc.js').Integer,\n *   start: import('./iterateJsdoc.js').Integer,\n *   tag: import('./iterateJsdoc.js').Integer,\n *   type: import('./iterateJsdoc.js').Integer\n * }} Width\n */\n\n/** @type {Width} */\nconst zeroWidth = {\n  name: 0,\n  start: 0,\n  tag: 0,\n  type: 0,\n};\n\n/**\n * @param {string[]} tags\n * @param {import('./iterateJsdoc.js').Integer} index\n * @param {import('comment-parser').Line[]} source\n * @returns {boolean}\n */\nconst shouldAlign = (tags, index, source) => {\n  const tag = source[index].tokens.tag.replace('@', '');\n  const includesTag = tags.includes(tag);\n\n  if (includesTag) {\n    return true;\n  }\n\n  if (tag !== '') {\n    return false;\n  }\n\n  for (let iterator = index; iterator >= 0; iterator--) {\n    const previousTag = source[iterator].tokens.tag.replace('@', '');\n\n    if (previousTag !== '') {\n      if (tags.includes(previousTag)) {\n        return true;\n      }\n\n      return false;\n    }\n  }\n\n  return true;\n};\n\n/**\n * @param {string[]} tags\n * @returns {(\n *   width: Width,\n *   line: {\n *     tokens: import('comment-parser').Tokens\n *   },\n *   index: import('./iterateJsdoc.js').Integer,\n *   source: import('comment-parser').Line[]\n * ) => Width}\n */\nconst getWidth = (tags) => {\n  return (width, {\n    tokens,\n  }, index, source) => {\n    if (!shouldAlign(tags, index, source)) {\n      return width;\n    }\n\n    return {\n      name: Math.max(width.name, tokens.name.length),\n      start: tokens.delimiter === '/**' ? tokens.start.length : width.start,\n      tag: Math.max(width.tag, tokens.tag.length),\n      type: Math.max(width.type, tokens.type.length),\n    };\n  };\n};\n\n/**\n * @param {{\n *   description: string;\n *   tags: import('comment-parser').Spec[];\n *   problems: import('comment-parser').Problem[];\n * }} fields\n * @returns {TypelessInfo}\n */\nconst getTypelessInfo = (fields) => {\n  const hasNoTypes = fields.tags.every(({\n    type,\n  }) => {\n    return !type;\n  });\n  const maxNamedTagLength = Math.max(...fields.tags.map(({\n    tag,\n    name,\n  }) => {\n    return name.length === 0 ? -1 : tag.length;\n  }).filter((length) => {\n    return length !== -1;\n  })) + 1;\n  const maxUnnamedTagLength = Math.max(...fields.tags.map(({\n    tag,\n    name,\n  }) => {\n    return name.length === 0 ? tag.length : -1;\n  }).filter((length) => {\n    return length !== -1;\n  })) + 1;\n  return {\n    hasNoTypes,\n    maxNamedTagLength,\n    maxUnnamedTagLength,\n  };\n};\n\n/**\n * @param {import('./iterateJsdoc.js').Integer} len\n * @returns {string}\n */\nconst space = (len) => {\n  return ''.padStart(len, ' ');\n};\n\n/**\n * @param {{\n *   customSpacings: import('../src/rules/checkLineAlignment.js').CustomSpacings,\n *   tags: string[],\n *   indent: string,\n *   preserveMainDescriptionPostDelimiter: boolean,\n *   wrapIndent: string,\n * }} cfg\n * @returns {(\n *   block: import('comment-parser').Block\n * ) => import('comment-parser').Block}\n */\nconst alignTransform = ({\n  customSpacings,\n  tags,\n  indent,\n  preserveMainDescriptionPostDelimiter,\n  wrapIndent,\n}) => {\n  let intoTags = false;\n  /** @type {Width} */\n  let width;\n\n  /**\n   * @param {import('comment-parser').Tokens} tokens\n   * @param {TypelessInfo} typelessInfo\n   * @returns {import('comment-parser').Tokens}\n   */\n  const alignTokens = (tokens, typelessInfo) => {\n    const nothingAfter = {\n      delim: false,\n      name: false,\n      tag: false,\n      type: false,\n    };\n\n    if (tokens.description === '') {\n      nothingAfter.name = true;\n      tokens.postName = '';\n\n      if (tokens.name === '') {\n        nothingAfter.type = true;\n        tokens.postType = '';\n\n        if (tokens.type === '') {\n          nothingAfter.tag = true;\n          tokens.postTag = '';\n\n          /* istanbul ignore next: Never happens because the !intoTags return. But it's here for consistency with the original align transform */\n          if (tokens.tag === '') {\n            nothingAfter.delim = true;\n          }\n        }\n      }\n    }\n\n    let untypedNameAdjustment = 0;\n    let untypedTypeAdjustment = 0;\n    if (typelessInfo.hasNoTypes) {\n      nothingAfter.tag = true;\n      tokens.postTag = '';\n      if (tokens.name === '') {\n        untypedNameAdjustment = typelessInfo.maxNamedTagLength - tokens.tag.length;\n      } else {\n        untypedNameAdjustment = typelessInfo.maxNamedTagLength > typelessInfo.maxUnnamedTagLength ? 0 :\n          Math.max(0, typelessInfo.maxUnnamedTagLength - (tokens.tag.length + tokens.name.length + 1));\n        untypedTypeAdjustment = typelessInfo.maxNamedTagLength - tokens.tag.length;\n      }\n    }\n\n    // Todo: Avoid fixing alignment of blocks with multiline wrapping of type\n    if (tokens.tag === '' && tokens.type) {\n      return tokens;\n    }\n\n    const spacings = {\n      postDelimiter: customSpacings?.postDelimiter || 1,\n      postName: customSpacings?.postName || 1,\n      postTag: customSpacings?.postTag || 1,\n      postType: customSpacings?.postType || 1,\n    };\n\n    tokens.postDelimiter = nothingAfter.delim ? '' : space(spacings.postDelimiter);\n\n    if (!nothingAfter.tag) {\n      tokens.postTag = space(width.tag - tokens.tag.length + spacings.postTag);\n    }\n\n    if (!nothingAfter.type) {\n      tokens.postType = space(width.type - tokens.type.length + spacings.postType + untypedTypeAdjustment);\n    }\n\n    if (!nothingAfter.name) {\n      // If post name is empty for all lines (name width 0), don't add post name spacing.\n      tokens.postName = width.name === 0 ? '' : space(width.name - tokens.name.length + spacings.postName + untypedNameAdjustment);\n    }\n\n    return tokens;\n  };\n\n  /**\n   * @param {import('comment-parser').Line} line\n   * @param {import('./iterateJsdoc.js').Integer} index\n   * @param {import('comment-parser').Line[]} source\n   * @param {TypelessInfo} typelessInfo\n   * @param {string|false} indentTag\n   * @returns {import('comment-parser').Line}\n   */\n  const update = (line, index, source, typelessInfo, indentTag) => {\n    /** @type {import('comment-parser').Tokens} */\n    const tokens = {\n      ...line.tokens,\n    };\n\n    if (tokens.tag !== '') {\n      intoTags = true;\n    }\n\n    const isEmpty =\n      tokens.tag === '' &&\n      tokens.name === '' &&\n      tokens.type === '' &&\n      tokens.description === '';\n\n    // dangling '*/'\n    if (tokens.end === '*/' && isEmpty) {\n      tokens.start = indent + ' ';\n\n      return {\n        ...line,\n        tokens,\n      };\n    }\n\n    switch (tokens.delimiter) {\n    case '/**':\n      tokens.start = indent;\n      break;\n    case '*':\n      tokens.start = indent + ' ';\n      break;\n    default:\n      tokens.delimiter = '';\n\n      // compensate delimiter\n      tokens.start = indent + '  ';\n    }\n\n    if (!intoTags) {\n      if (tokens.description === '') {\n        tokens.postDelimiter = '';\n      } else if (!preserveMainDescriptionPostDelimiter) {\n        tokens.postDelimiter = ' ';\n      }\n\n      return {\n        ...line,\n        tokens,\n      };\n    }\n\n    const postHyphenSpacing = customSpacings?.postHyphen ?? 1;\n    const hyphenSpacing = /^\\s*-\\s+/u;\n    tokens.description = tokens.description.replace(\n      hyphenSpacing, '-' + ''.padStart(postHyphenSpacing, ' '),\n    );\n\n    // Not align.\n    if (shouldAlign(tags, index, source)) {\n      alignTokens(tokens, typelessInfo);\n      if (indentTag) {\n        tokens.postDelimiter += wrapIndent;\n      }\n    }\n\n    return {\n      ...line,\n      tokens,\n    };\n  };\n\n  return ({\n    source,\n    ...fields\n  }) => {\n    width = source.reduce(getWidth(tags), {\n      ...zeroWidth,\n    });\n\n    const typelessInfo = getTypelessInfo(fields);\n\n    let tagIndentMode = false;\n\n    return rewireSource({\n      ...fields,\n      source: source.map((line, index) => {\n        const indentTag = tagIndentMode && !line.tokens.tag && line.tokens.description;\n        const ret = update(line, index, source, typelessInfo, indentTag);\n\n        if (line.tokens.tag) {\n          tagIndentMode = true;\n        }\n\n        return ret;\n      }),\n    });\n  };\n};\n\nexport default alignTransform;\n"],"mappings":";;;;;;AAMA,IAAAA,cAAA,GAAAC,OAAA;AANA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,MAAM;EACJC;AACF,CAAC,GAAGC,mBAAI;;AAER;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA,MAAMC,SAAS,GAAG;EAChBC,IAAI,EAAE,CAAC;EACPC,KAAK,EAAE,CAAC;EACRC,GAAG,EAAE,CAAC;EACNC,IAAI,EAAE;AACR,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,WAAW,GAAGA,CAACC,IAAI,EAAEC,KAAK,EAAEC,MAAM,KAAK;EAC3C,MAAML,GAAG,GAAGK,MAAM,CAACD,KAAK,CAAC,CAACE,MAAM,CAACN,GAAG,CAACO,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;EACrD,MAAMC,WAAW,GAAGL,IAAI,CAACM,QAAQ,CAACT,GAAG,CAAC;EAEtC,IAAIQ,WAAW,EAAE;IACf,OAAO,IAAI;EACb;EAEA,IAAIR,GAAG,KAAK,EAAE,EAAE;IACd,OAAO,KAAK;EACd;EAEA,KAAK,IAAIU,QAAQ,GAAGN,KAAK,EAAEM,QAAQ,IAAI,CAAC,EAAEA,QAAQ,EAAE,EAAE;IACpD,MAAMC,WAAW,GAAGN,MAAM,CAACK,QAAQ,CAAC,CAACJ,MAAM,CAACN,GAAG,CAACO,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;IAEhE,IAAII,WAAW,KAAK,EAAE,EAAE;MACtB,IAAIR,IAAI,CAACM,QAAQ,CAACE,WAAW,CAAC,EAAE;QAC9B,OAAO,IAAI;MACb;MAEA,OAAO,KAAK;IACd;EACF;EAEA,OAAO,IAAI;AACb,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,QAAQ,GAAIT,IAAI,IAAK;EACzB,OAAO,CAACU,KAAK,EAAE;IACbP;EACF,CAAC,EAAEF,KAAK,EAAEC,MAAM,KAAK;IACnB,IAAI,CAACH,WAAW,CAACC,IAAI,EAAEC,KAAK,EAAEC,MAAM,CAAC,EAAE;MACrC,OAAOQ,KAAK;IACd;IAEA,OAAO;MACLf,IAAI,EAAEgB,IAAI,CAACC,GAAG,CAACF,KAAK,CAACf,IAAI,EAAEQ,MAAM,CAACR,IAAI,CAACkB,MAAM,CAAC;MAC9CjB,KAAK,EAAEO,MAAM,CAACW,SAAS,KAAK,KAAK,GAAGX,MAAM,CAACP,KAAK,CAACiB,MAAM,GAAGH,KAAK,CAACd,KAAK;MACrEC,GAAG,EAAEc,IAAI,CAACC,GAAG,CAACF,KAAK,CAACb,GAAG,EAAEM,MAAM,CAACN,GAAG,CAACgB,MAAM,CAAC;MAC3Cf,IAAI,EAAEa,IAAI,CAACC,GAAG,CAACF,KAAK,CAACZ,IAAI,EAAEK,MAAM,CAACL,IAAI,CAACe,MAAM;IAC/C,CAAC;EACH,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAME,eAAe,GAAIC,MAAM,IAAK;EAClC,MAAMC,UAAU,GAAGD,MAAM,CAAChB,IAAI,CAACkB,KAAK,CAAC,CAAC;IACpCpB;EACF,CAAC,KAAK;IACJ,OAAO,CAACA,IAAI;EACd,CAAC,CAAC;EACF,MAAMqB,iBAAiB,GAAGR,IAAI,CAACC,GAAG,CAAC,GAAGI,MAAM,CAAChB,IAAI,CAACoB,GAAG,CAAC,CAAC;IACrDvB,GAAG;IACHF;EACF,CAAC,KAAK;IACJ,OAAOA,IAAI,CAACkB,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC,GAAGhB,GAAG,CAACgB,MAAM;EAC5C,CAAC,CAAC,CAACQ,MAAM,CAAER,MAAM,IAAK;IACpB,OAAOA,MAAM,KAAK,CAAC,CAAC;EACtB,CAAC,CAAC,CAAC,GAAG,CAAC;EACP,MAAMS,mBAAmB,GAAGX,IAAI,CAACC,GAAG,CAAC,GAAGI,MAAM,CAAChB,IAAI,CAACoB,GAAG,CAAC,CAAC;IACvDvB,GAAG;IACHF;EACF,CAAC,KAAK;IACJ,OAAOA,IAAI,CAACkB,MAAM,KAAK,CAAC,GAAGhB,GAAG,CAACgB,MAAM,GAAG,CAAC,CAAC;EAC5C,CAAC,CAAC,CAACQ,MAAM,CAAER,MAAM,IAAK;IACpB,OAAOA,MAAM,KAAK,CAAC,CAAC;EACtB,CAAC,CAAC,CAAC,GAAG,CAAC;EACP,OAAO;IACLI,UAAU;IACVE,iBAAiB;IACjBG;EACF,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAMC,KAAK,GAAIC,GAAG,IAAK;EACrB,OAAO,EAAE,CAACC,QAAQ,CAACD,GAAG,EAAE,GAAG,CAAC;AAC9B,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAME,cAAc,GAAGA,CAAC;EACtBC,cAAc;EACd3B,IAAI;EACJ4B,MAAM;EACNC,oCAAoC;EACpCC;AACF,CAAC,KAAK;EACJ,IAAIC,QAAQ,GAAG,KAAK;EACpB;EACA,IAAIrB,KAAK;;EAET;AACF;AACA;AACA;AACA;EACE,MAAMsB,WAAW,GAAGA,CAAC7B,MAAM,EAAE8B,YAAY,KAAK;IAC5C,MAAMC,YAAY,GAAG;MACnBC,KAAK,EAAE,KAAK;MACZxC,IAAI,EAAE,KAAK;MACXE,GAAG,EAAE,KAAK;MACVC,IAAI,EAAE;IACR,CAAC;IAED,IAAIK,MAAM,CAACiC,WAAW,KAAK,EAAE,EAAE;MAC7BF,YAAY,CAACvC,IAAI,GAAG,IAAI;MACxBQ,MAAM,CAACkC,QAAQ,GAAG,EAAE;MAEpB,IAAIlC,MAAM,CAACR,IAAI,KAAK,EAAE,EAAE;QACtBuC,YAAY,CAACpC,IAAI,GAAG,IAAI;QACxBK,MAAM,CAACmC,QAAQ,GAAG,EAAE;QAEpB,IAAInC,MAAM,CAACL,IAAI,KAAK,EAAE,EAAE;UACtBoC,YAAY,CAACrC,GAAG,GAAG,IAAI;UACvBM,MAAM,CAACoC,OAAO,GAAG,EAAE;;UAEnB;UACA,IAAIpC,MAAM,CAACN,GAAG,KAAK,EAAE,EAAE;YACrBqC,YAAY,CAACC,KAAK,GAAG,IAAI;UAC3B;QACF;MACF;IACF;IAEA,IAAIK,qBAAqB,GAAG,CAAC;IAC7B,IAAIC,qBAAqB,GAAG,CAAC;IAC7B,IAAIR,YAAY,CAAChB,UAAU,EAAE;MAC3BiB,YAAY,CAACrC,GAAG,GAAG,IAAI;MACvBM,MAAM,CAACoC,OAAO,GAAG,EAAE;MACnB,IAAIpC,MAAM,CAACR,IAAI,KAAK,EAAE,EAAE;QACtB6C,qBAAqB,GAAGP,YAAY,CAACd,iBAAiB,GAAGhB,MAAM,CAACN,GAAG,CAACgB,MAAM;MAC5E,CAAC,MAAM;QACL2B,qBAAqB,GAAGP,YAAY,CAACd,iBAAiB,GAAGc,YAAY,CAACX,mBAAmB,GAAG,CAAC,GAC3FX,IAAI,CAACC,GAAG,CAAC,CAAC,EAAEqB,YAAY,CAACX,mBAAmB,IAAInB,MAAM,CAACN,GAAG,CAACgB,MAAM,GAAGV,MAAM,CAACR,IAAI,CAACkB,MAAM,GAAG,CAAC,CAAC,CAAC;QAC9F4B,qBAAqB,GAAGR,YAAY,CAACd,iBAAiB,GAAGhB,MAAM,CAACN,GAAG,CAACgB,MAAM;MAC5E;IACF;;IAEA;IACA,IAAIV,MAAM,CAACN,GAAG,KAAK,EAAE,IAAIM,MAAM,CAACL,IAAI,EAAE;MACpC,OAAOK,MAAM;IACf;IAEA,MAAMuC,QAAQ,GAAG;MACfC,aAAa,EAAE,CAAAhB,cAAc,aAAdA,cAAc,uBAAdA,cAAc,CAAEgB,aAAa,KAAI,CAAC;MACjDN,QAAQ,EAAE,CAAAV,cAAc,aAAdA,cAAc,uBAAdA,cAAc,CAAEU,QAAQ,KAAI,CAAC;MACvCE,OAAO,EAAE,CAAAZ,cAAc,aAAdA,cAAc,uBAAdA,cAAc,CAAEY,OAAO,KAAI,CAAC;MACrCD,QAAQ,EAAE,CAAAX,cAAc,aAAdA,cAAc,uBAAdA,cAAc,CAAEW,QAAQ,KAAI;IACxC,CAAC;IAEDnC,MAAM,CAACwC,aAAa,GAAGT,YAAY,CAACC,KAAK,GAAG,EAAE,GAAGZ,KAAK,CAACmB,QAAQ,CAACC,aAAa,CAAC;IAE9E,IAAI,CAACT,YAAY,CAACrC,GAAG,EAAE;MACrBM,MAAM,CAACoC,OAAO,GAAGhB,KAAK,CAACb,KAAK,CAACb,GAAG,GAAGM,MAAM,CAACN,GAAG,CAACgB,MAAM,GAAG6B,QAAQ,CAACH,OAAO,CAAC;IAC1E;IAEA,IAAI,CAACL,YAAY,CAACpC,IAAI,EAAE;MACtBK,MAAM,CAACmC,QAAQ,GAAGf,KAAK,CAACb,KAAK,CAACZ,IAAI,GAAGK,MAAM,CAACL,IAAI,CAACe,MAAM,GAAG6B,QAAQ,CAACJ,QAAQ,GAAGG,qBAAqB,CAAC;IACtG;IAEA,IAAI,CAACP,YAAY,CAACvC,IAAI,EAAE;MACtB;MACAQ,MAAM,CAACkC,QAAQ,GAAG3B,KAAK,CAACf,IAAI,KAAK,CAAC,GAAG,EAAE,GAAG4B,KAAK,CAACb,KAAK,CAACf,IAAI,GAAGQ,MAAM,CAACR,IAAI,CAACkB,MAAM,GAAG6B,QAAQ,CAACL,QAAQ,GAAGG,qBAAqB,CAAC;IAC9H;IAEA,OAAOrC,MAAM;EACf,CAAC;;EAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMyC,MAAM,GAAGA,CAACC,IAAI,EAAE5C,KAAK,EAAEC,MAAM,EAAE+B,YAAY,EAAEa,SAAS,KAAK;IAC/D;IACA,MAAM3C,MAAM,GAAG;MACb,GAAG0C,IAAI,CAAC1C;IACV,CAAC;IAED,IAAIA,MAAM,CAACN,GAAG,KAAK,EAAE,EAAE;MACrBkC,QAAQ,GAAG,IAAI;IACjB;IAEA,MAAMgB,OAAO,GACX5C,MAAM,CAACN,GAAG,KAAK,EAAE,IACjBM,MAAM,CAACR,IAAI,KAAK,EAAE,IAClBQ,MAAM,CAACL,IAAI,KAAK,EAAE,IAClBK,MAAM,CAACiC,WAAW,KAAK,EAAE;;IAE3B;IACA,IAAIjC,MAAM,CAAC6C,GAAG,KAAK,IAAI,IAAID,OAAO,EAAE;MAClC5C,MAAM,CAACP,KAAK,GAAGgC,MAAM,GAAG,GAAG;MAE3B,OAAO;QACL,GAAGiB,IAAI;QACP1C;MACF,CAAC;IACH;IAEA,QAAQA,MAAM,CAACW,SAAS;MACxB,KAAK,KAAK;QACRX,MAAM,CAACP,KAAK,GAAGgC,MAAM;QACrB;MACF,KAAK,GAAG;QACNzB,MAAM,CAACP,KAAK,GAAGgC,MAAM,GAAG,GAAG;QAC3B;MACF;QACEzB,MAAM,CAACW,SAAS,GAAG,EAAE;;QAErB;QACAX,MAAM,CAACP,KAAK,GAAGgC,MAAM,GAAG,IAAI;IAC9B;IAEA,IAAI,CAACG,QAAQ,EAAE;MACb,IAAI5B,MAAM,CAACiC,WAAW,KAAK,EAAE,EAAE;QAC7BjC,MAAM,CAACwC,aAAa,GAAG,EAAE;MAC3B,CAAC,MAAM,IAAI,CAACd,oCAAoC,EAAE;QAChD1B,MAAM,CAACwC,aAAa,GAAG,GAAG;MAC5B;MAEA,OAAO;QACL,GAAGE,IAAI;QACP1C;MACF,CAAC;IACH;IAEA,MAAM8C,iBAAiB,GAAG,CAAAtB,cAAc,aAAdA,cAAc,uBAAdA,cAAc,CAAEuB,UAAU,KAAI,CAAC;IACzD,MAAMC,aAAa,GAAG,WAAW;IACjChD,MAAM,CAACiC,WAAW,GAAGjC,MAAM,CAACiC,WAAW,CAAChC,OAAO,CAC7C+C,aAAa,EAAE,GAAG,GAAG,EAAE,CAAC1B,QAAQ,CAACwB,iBAAiB,EAAE,GAAG,CACzD,CAAC;;IAED;IACA,IAAIlD,WAAW,CAACC,IAAI,EAAEC,KAAK,EAAEC,MAAM,CAAC,EAAE;MACpC8B,WAAW,CAAC7B,MAAM,EAAE8B,YAAY,CAAC;MACjC,IAAIa,SAAS,EAAE;QACb3C,MAAM,CAACwC,aAAa,IAAIb,UAAU;MACpC;IACF;IAEA,OAAO;MACL,GAAGe,IAAI;MACP1C;IACF,CAAC;EACH,CAAC;EAED,OAAO,CAAC;IACND,MAAM;IACN,GAAGc;EACL,CAAC,KAAK;IACJN,KAAK,GAAGR,MAAM,CAACkD,MAAM,CAAC3C,QAAQ,CAACT,IAAI,CAAC,EAAE;MACpC,GAAGN;IACL,CAAC,CAAC;IAEF,MAAMuC,YAAY,GAAGlB,eAAe,CAACC,MAAM,CAAC;IAE5C,IAAIqC,aAAa,GAAG,KAAK;IAEzB,OAAO7D,YAAY,CAAC;MAClB,GAAGwB,MAAM;MACTd,MAAM,EAAEA,MAAM,CAACkB,GAAG,CAAC,CAACyB,IAAI,EAAE5C,KAAK,KAAK;QAClC,MAAM6C,SAAS,GAAGO,aAAa,IAAI,CAACR,IAAI,CAAC1C,MAAM,CAACN,GAAG,IAAIgD,IAAI,CAAC1C,MAAM,CAACiC,WAAW;QAC9E,MAAMkB,GAAG,GAAGV,MAAM,CAACC,IAAI,EAAE5C,KAAK,EAAEC,MAAM,EAAE+B,YAAY,EAAEa,SAAS,CAAC;QAEhE,IAAID,IAAI,CAAC1C,MAAM,CAACN,GAAG,EAAE;UACnBwD,aAAa,GAAG,IAAI;QACtB;QAEA,OAAOC,GAAG;MACZ,CAAC;IACH,CAAC,CAAC;EACJ,CAAC;AACH,CAAC;AAAC,IAAAC,QAAA,GAEa7B,cAAc;AAAA8B,OAAA,CAAAC,OAAA,GAAAF,QAAA;AAAAG,MAAA,CAAAF,OAAA,GAAAA,OAAA,CAAAC,OAAA"}

package/dist/index.js

@@ -60,7 +60,7 @@ var _validTypes = _interopRequireDefault(require("./rules/validTypes.js"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 /**
  * @type {import('eslint').ESLint.Plugin & {
- *   configs: Record<string, import('eslint').ESLint.ConfigData>
+ *   configs: Record<string, import('eslint').ESLint.ConfigData|{}>
  * }}
  */
 const index = {
@@ -124,11 +124,14 @@ const index = {
 
 /**
  * @param {"warn"|"error"} warnOrError
- * @returns {import('eslint').ESLint.ConfigData}
+ * @param {boolean} [flat]
+ * @returns {import('eslint').ESLint.ConfigData | {plugins: {}, rules: {}}}
  */
-const createRecommendedRuleset = warnOrError => {
+const createRecommendedRuleset = (warnOrError, flat) => {
   return {
-    plugins: ['jsdoc'],
+    plugins: flat ? {
+      jsdoc: index
+    } : ['jsdoc'],
     rules: {
       'jsdoc/check-access': warnOrError,
       'jsdoc/check-alignment': warnOrError,
@@ -189,10 +192,11 @@ const createRecommendedRuleset = warnOrError => {
 
 /**
  * @param {"warn"|"error"} warnOrError
- * @returns {import('eslint').ESLint.ConfigData}
+ * @param {boolean} [flat]
+ * @returns {import('eslint').ESLint.ConfigData|{}}
  */
-const createRecommendedTypeScriptRuleset = warnOrError => {
-  const ruleset = createRecommendedRuleset(warnOrError);
+const createRecommendedTypeScriptRuleset = (warnOrError, flat) => {
+  const ruleset = createRecommendedRuleset(warnOrError, flat);
   return {
     ...ruleset,
     rules: {
@@ -213,10 +217,11 @@ const createRecommendedTypeScriptRuleset = warnOrError => {
 
 /**
  * @param {"warn"|"error"} warnOrError
- * @returns {import('eslint').ESLint.ConfigData}
+ * @param {boolean} [flat]
+ * @returns {import('eslint').ESLint.ConfigData|{}}
  */
-const createRecommendedTypeScriptFlavorRuleset = warnOrError => {
-  const ruleset = createRecommendedRuleset(warnOrError);
+const createRecommendedTypeScriptFlavorRuleset = (warnOrError, flat) => {
+  const ruleset = createRecommendedRuleset(warnOrError, flat);
   return {
     ...ruleset,
     rules: {
@@ -238,6 +243,12 @@ index.configs['recommended-typescript'] = createRecommendedTypeScriptRuleset('wa
 index.configs['recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error');
 index.configs['recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn');
 index.configs['recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error');
+index.configs['flat/recommended'] = createRecommendedRuleset('warn', true);
+index.configs['flat/recommended-error'] = createRecommendedRuleset('error', true);
+index.configs['flat/recommended-typescript'] = createRecommendedTypeScriptRuleset('warn', true);
+index.configs['flat/recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error', true);
+index.configs['flat/recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn', true);
+index.configs['flat/recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error', true);
 var _default = index;
 exports.default = _default;
 module.exports = exports.default;

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["_checkAccess","_interopRequireDefault","require","_checkAlignment","_checkExamples","_checkIndentation","_checkLineAlignment","_checkParamNames","_checkPropertyNames","_checkSyntax","_checkTagNames","_checkTypes","_checkValues","_emptyTags","_implementsOnClasses","_importsAsDependencies","_informativeDocs","_matchDescription","_matchName","_multilineBlocks","_noBadBlocks","_noBlankBlockDescriptions","_noBlankBlocks","_noDefaults","_noMissingSyntax","_noMultiAsterisks","_noRestrictedSyntax","_noTypes","_noUndefinedTypes","_requireAsteriskPrefix","_requireDescription","_requireDescriptionCompleteSentence","_requireExample","_requireFileOverview","_requireHyphenBeforeParamDescription","_requireJsdoc","_requireParam","_requireParamDescription","_requireParamName","_requireParamType","_requireProperty","_requirePropertyDescription","_requirePropertyName","_requirePropertyType","_requireReturns","_requireReturnsCheck","_requireReturnsDescription","_requireReturnsType","_requireThrows","_requireYields","_requireYieldsCheck","_sortTags","_tagLines","_textEscaping","_validTypes","obj","__esModule","default","index","configs","rules","checkAccess","checkAlignment","checkExamples","checkIndentation","checkLineAlignment","checkParamNames","checkPropertyNames","checkSyntax","checkTagNames","checkTypes","checkValues","emptyTags","implementsOnClasses","importsAsDependencies","informativeDocs","matchDescription","matchName","multilineBlocks","noBadBlocks","noBlankBlockDescriptions","noBlankBlocks","noDefaults","noMissingSyntax","noMultiAsterisks","noRestrictedSyntax","noTypes","noUndefinedTypes","requireAsteriskPrefix","requireDescription","requireDescriptionCompleteSentence","requireExample","requireFileOverview","requireHyphenBeforeParamDescription","requireJsdoc","requireParam","requireParamDescription","requireParamName","requireParamType","requireProperty","requirePropertyDescription","requirePropertyName","requirePropertyType","requireReturns","requireReturnsCheck","requireReturnsDescription","requireReturnsType","requireThrows","requireYields","requireYieldsCheck","sortTags","tagLines","textEscaping","validTypes","createRecommendedRuleset","warnOrError","plugins","createRecommendedTypeScriptRuleset","ruleset","typed","createRecommendedTypeScriptFlavorRuleset","Error","recommended","_default","exports","module"],"sources":["../src/index.js"],"sourcesContent":["import checkAccess from './rules/checkAccess.js';\nimport checkAlignment from './rules/checkAlignment.js';\nimport checkExamples from './rules/checkExamples.js';\nimport checkIndentation from './rules/checkIndentation.js';\nimport checkLineAlignment from './rules/checkLineAlignment.js';\nimport checkParamNames from './rules/checkParamNames.js';\nimport checkPropertyNames from './rules/checkPropertyNames.js';\nimport checkSyntax from './rules/checkSyntax.js';\nimport checkTagNames from './rules/checkTagNames.js';\nimport checkTypes from './rules/checkTypes.js';\nimport checkValues from './rules/checkValues.js';\nimport emptyTags from './rules/emptyTags.js';\nimport implementsOnClasses from './rules/implementsOnClasses.js';\nimport importsAsDependencies from './rules/importsAsDependencies.js';\nimport informativeDocs from './rules/informativeDocs.js';\nimport matchDescription from './rules/matchDescription.js';\nimport matchName from './rules/matchName.js';\nimport multilineBlocks from './rules/multilineBlocks.js';\nimport noBadBlocks from './rules/noBadBlocks.js';\nimport noBlankBlockDescriptions from './rules/noBlankBlockDescriptions.js';\nimport noBlankBlocks from './rules/noBlankBlocks.js';\nimport noDefaults from './rules/noDefaults.js';\nimport noMissingSyntax from './rules/noMissingSyntax.js';\nimport noMultiAsterisks from './rules/noMultiAsterisks.js';\nimport noRestrictedSyntax from './rules/noRestrictedSyntax.js';\nimport noTypes from './rules/noTypes.js';\nimport noUndefinedTypes from './rules/noUndefinedTypes.js';\nimport requireAsteriskPrefix from './rules/requireAsteriskPrefix.js';\nimport requireDescription from './rules/requireDescription.js';\nimport requireDescriptionCompleteSentence from './rules/requireDescriptionCompleteSentence.js';\nimport requireExample from './rules/requireExample.js';\nimport requireFileOverview from './rules/requireFileOverview.js';\nimport requireHyphenBeforeParamDescription from './rules/requireHyphenBeforeParamDescription.js';\nimport requireJsdoc from './rules/requireJsdoc.js';\nimport requireParam from './rules/requireParam.js';\nimport requireParamDescription from './rules/requireParamDescription.js';\nimport requireParamName from './rules/requireParamName.js';\nimport requireParamType from './rules/requireParamType.js';\nimport requireProperty from './rules/requireProperty.js';\nimport requirePropertyDescription from './rules/requirePropertyDescription.js';\nimport requirePropertyName from './rules/requirePropertyName.js';\nimport requirePropertyType from './rules/requirePropertyType.js';\nimport requireReturns from './rules/requireReturns.js';\nimport requireReturnsCheck from './rules/requireReturnsCheck.js';\nimport requireReturnsDescription from './rules/requireReturnsDescription.js';\nimport requireReturnsType from './rules/requireReturnsType.js';\nimport requireThrows from './rules/requireThrows.js';\nimport requireYields from './rules/requireYields.js';\nimport requireYieldsCheck from './rules/requireYieldsCheck.js';\nimport sortTags from './rules/sortTags.js';\nimport tagLines from './rules/tagLines.js';\nimport textEscaping from './rules/textEscaping.js';\nimport validTypes from './rules/validTypes.js';\n\n/**\n * @type {import('eslint').ESLint.Plugin & {\n *   configs: Record<string, import('eslint').ESLint.ConfigData>\n * }}\n */\nconst index = {\n  configs: {},\n  rules: {\n    'check-access': checkAccess,\n    'check-alignment': checkAlignment,\n    'check-examples': checkExamples,\n    'check-indentation': checkIndentation,\n    'check-line-alignment': checkLineAlignment,\n    'check-param-names': checkParamNames,\n    'check-property-names': checkPropertyNames,\n    'check-syntax': checkSyntax,\n    'check-tag-names': checkTagNames,\n    'check-types': checkTypes,\n    'check-values': checkValues,\n    'empty-tags': emptyTags,\n    'implements-on-classes': implementsOnClasses,\n    'imports-as-dependencies': importsAsDependencies,\n    'informative-docs': informativeDocs,\n    'match-description': matchDescription,\n    'match-name': matchName,\n    'multiline-blocks': multilineBlocks,\n    'no-bad-blocks': noBadBlocks,\n    'no-blank-block-descriptions': noBlankBlockDescriptions,\n    'no-blank-blocks': noBlankBlocks,\n    'no-defaults': noDefaults,\n    'no-missing-syntax': noMissingSyntax,\n    'no-multi-asterisks': noMultiAsterisks,\n    'no-restricted-syntax': noRestrictedSyntax,\n    'no-types': noTypes,\n    'no-undefined-types': noUndefinedTypes,\n    'require-asterisk-prefix': requireAsteriskPrefix,\n    'require-description': requireDescription,\n    'require-description-complete-sentence': requireDescriptionCompleteSentence,\n    'require-example': requireExample,\n    'require-file-overview': requireFileOverview,\n    'require-hyphen-before-param-description': requireHyphenBeforeParamDescription,\n    'require-jsdoc': requireJsdoc,\n    'require-param': requireParam,\n    'require-param-description': requireParamDescription,\n    'require-param-name': requireParamName,\n    'require-param-type': requireParamType,\n    'require-property': requireProperty,\n    'require-property-description': requirePropertyDescription,\n    'require-property-name': requirePropertyName,\n    'require-property-type': requirePropertyType,\n    'require-returns': requireReturns,\n    'require-returns-check': requireReturnsCheck,\n    'require-returns-description': requireReturnsDescription,\n    'require-returns-type': requireReturnsType,\n    'require-throws': requireThrows,\n    'require-yields': requireYields,\n    'require-yields-check': requireYieldsCheck,\n    'sort-tags': sortTags,\n    'tag-lines': tagLines,\n    'text-escaping': textEscaping,\n    'valid-types': validTypes,\n  },\n};\n\n/**\n * @param {\"warn\"|\"error\"} warnOrError\n * @returns {import('eslint').ESLint.ConfigData}\n */\nconst createRecommendedRuleset = (warnOrError) => {\n  return {\n    plugins: [\n      'jsdoc',\n    ],\n    rules: {\n      'jsdoc/check-access': warnOrError,\n      'jsdoc/check-alignment': warnOrError,\n      'jsdoc/check-examples': 'off',\n      'jsdoc/check-indentation': 'off',\n      'jsdoc/check-line-alignment': 'off',\n      'jsdoc/check-param-names': warnOrError,\n      'jsdoc/check-property-names': warnOrError,\n      'jsdoc/check-syntax': 'off',\n      'jsdoc/check-tag-names': warnOrError,\n      'jsdoc/check-types': warnOrError,\n      'jsdoc/check-values': warnOrError,\n      'jsdoc/empty-tags': warnOrError,\n      'jsdoc/implements-on-classes': warnOrError,\n      'jsdoc/imports-as-dependencies': 'off',\n      'jsdoc/informative-docs': 'off',\n      'jsdoc/match-description': 'off',\n      'jsdoc/match-name': 'off',\n      'jsdoc/multiline-blocks': warnOrError,\n      'jsdoc/no-bad-blocks': 'off',\n      'jsdoc/no-blank-block-descriptions': 'off',\n      'jsdoc/no-blank-blocks': 'off',\n      'jsdoc/no-defaults': warnOrError,\n      'jsdoc/no-missing-syntax': 'off',\n      'jsdoc/no-multi-asterisks': warnOrError,\n      'jsdoc/no-restricted-syntax': 'off',\n      'jsdoc/no-types': 'off',\n      'jsdoc/no-undefined-types': warnOrError,\n      'jsdoc/require-asterisk-prefix': 'off',\n      'jsdoc/require-description': 'off',\n      'jsdoc/require-description-complete-sentence': 'off',\n      'jsdoc/require-example': 'off',\n      'jsdoc/require-file-overview': 'off',\n      'jsdoc/require-hyphen-before-param-description': 'off',\n      'jsdoc/require-jsdoc': warnOrError,\n      'jsdoc/require-param': warnOrError,\n      'jsdoc/require-param-description': warnOrError,\n      'jsdoc/require-param-name': warnOrError,\n      'jsdoc/require-param-type': warnOrError,\n      'jsdoc/require-property': warnOrError,\n      'jsdoc/require-property-description': warnOrError,\n      'jsdoc/require-property-name': warnOrError,\n      'jsdoc/require-property-type': warnOrError,\n      'jsdoc/require-returns': warnOrError,\n      'jsdoc/require-returns-check': warnOrError,\n      'jsdoc/require-returns-description': warnOrError,\n      'jsdoc/require-returns-type': warnOrError,\n      'jsdoc/require-throws': 'off',\n      'jsdoc/require-yields': warnOrError,\n      'jsdoc/require-yields-check': warnOrError,\n      'jsdoc/sort-tags': 'off',\n      'jsdoc/tag-lines': warnOrError,\n      'jsdoc/text-escaping': 'off',\n      'jsdoc/valid-types': warnOrError,\n    },\n  };\n};\n\n/**\n * @param {\"warn\"|\"error\"} warnOrError\n * @returns {import('eslint').ESLint.ConfigData}\n */\nconst createRecommendedTypeScriptRuleset = (warnOrError) => {\n  const ruleset = createRecommendedRuleset(warnOrError);\n\n  return {\n    ...ruleset,\n    rules: {\n      ...ruleset.rules,\n      /* eslint-disable indent -- Extra indent to avoid use by auto-rule-editing */\n        'jsdoc/check-tag-names': [\n          warnOrError, {\n            typed: true,\n          },\n        ],\n        'jsdoc/no-types': warnOrError,\n        'jsdoc/no-undefined-types': 'off',\n        'jsdoc/require-param-type': 'off',\n        'jsdoc/require-property-type': 'off',\n        'jsdoc/require-returns-type': 'off',\n      /* eslint-enable indent */\n    },\n  };\n};\n\n/**\n * @param {\"warn\"|\"error\"} warnOrError\n * @returns {import('eslint').ESLint.ConfigData}\n */\nconst createRecommendedTypeScriptFlavorRuleset = (warnOrError) => {\n  const ruleset = createRecommendedRuleset(warnOrError);\n\n  return {\n    ...ruleset,\n    rules: {\n      ...ruleset.rules,\n      /* eslint-disable indent -- Extra indent to avoid use by auto-rule-editing */\n        'jsdoc/no-undefined-types': 'off',\n      /* eslint-enable indent */\n    },\n  };\n};\n\n/* istanbul ignore if -- TS */\nif (!index.configs) {\n  throw new Error('TypeScript guard');\n}\n\nindex.configs.recommended = createRecommendedRuleset('warn');\nindex.configs['recommended-error'] = createRecommendedRuleset('error');\nindex.configs['recommended-typescript'] = createRecommendedTypeScriptRuleset('warn');\nindex.configs['recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error');\nindex.configs['recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn');\nindex.configs['recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error');\n\nexport default index;\n"],"mappings":";;;;;;AAAA,IAAAA,YAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,eAAA,GAAAF,sBAAA,CAAAC,OAAA;AACA,IAAAE,cAAA,GAAAH,sBAAA,CAAAC,OAAA;AACA,IAAAG,iBAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,mBAAA,GAAAL,sBAAA,CAAAC,OAAA;AACA,IAAAK,gBAAA,GAAAN,sBAAA,CAAAC,OAAA;AACA,IAAAM,mBAAA,GAAAP,sBAAA,CAAAC,OAAA;AACA,IAAAO,YAAA,GAAAR,sBAAA,CAAAC,OAAA;AACA,IAAAQ,cAAA,GAAAT,sBAAA,CAAAC,OAAA;AACA,IAAAS,WAAA,GAAAV,sBAAA,CAAAC,OAAA;AACA,IAAAU,YAAA,GAAAX,sBAAA,CAAAC,OAAA;AACA,IAAAW,UAAA,GAAAZ,sBAAA,CAAAC,OAAA;AACA,IAAAY,oBAAA,GAAAb,sBAAA,CAAAC,OAAA;AACA,IAAAa,sBAAA,GAAAd,sBAAA,CAAAC,OAAA;AACA,IAAAc,gBAAA,GAAAf,sBAAA,CAAAC,OAAA;AACA,IAAAe,iBAAA,GAAAhB,sBAAA,CAAAC,OAAA;AACA,IAAAgB,UAAA,GAAAjB,sBAAA,CAAAC,OAAA;AACA,IAAAiB,gBAAA,GAAAlB,sBAAA,CAAAC,OAAA;AACA,IAAAkB,YAAA,GAAAnB,sBAAA,CAAAC,OAAA;AACA,IAAAmB,yBAAA,GAAApB,sBAAA,CAAAC,OAAA;AACA,IAAAoB,cAAA,GAAArB,sBAAA,CAAAC,OAAA;AACA,IAAAqB,WAAA,GAAAtB,sBAAA,CAAAC,OAAA;AACA,IAAAsB,gBAAA,GAAAvB,sBAAA,CAAAC,OAAA;AACA,IAAAuB,iBAAA,GAAAxB,sBAAA,CAAAC,OAAA;AACA,IAAAwB,mBAAA,GAAAzB,sBAAA,CAAAC,OAAA;AACA,IAAAyB,QAAA,GAAA1B,sBAAA,CAAAC,OAAA;AACA,IAAA0B,iBAAA,GAAA3B,sBAAA,CAAAC,OAAA;AACA,IAAA2B,sBAAA,GAAA5B,sBAAA,CAAAC,OAAA;AACA,IAAA4B,mBAAA,GAAA7B,sBAAA,CAAAC,OAAA;AACA,IAAA6B,mCAAA,GAAA9B,sBAAA,CAAAC,OAAA;AACA,IAAA8B,eAAA,GAAA/B,sBAAA,CAAAC,OAAA;AACA,IAAA+B,oBAAA,GAAAhC,sBAAA,CAAAC,OAAA;AACA,IAAAgC,oCAAA,GAAAjC,sBAAA,CAAAC,OAAA;AACA,IAAAiC,aAAA,GAAAlC,sBAAA,CAAAC,OAAA;AACA,IAAAkC,aAAA,GAAAnC,sBAAA,CAAAC,OAAA;AACA,IAAAmC,wBAAA,GAAApC,sBAAA,CAAAC,OAAA;AACA,IAAAoC,iBAAA,GAAArC,sBAAA,CAAAC,OAAA;AACA,IAAAqC,iBAAA,GAAAtC,sBAAA,CAAAC,OAAA;AACA,IAAAsC,gBAAA,GAAAvC,sBAAA,CAAAC,OAAA;AACA,IAAAuC,2BAAA,GAAAxC,sBAAA,CAAAC,OAAA;AACA,IAAAwC,oBAAA,GAAAzC,sBAAA,CAAAC,OAAA;AACA,IAAAyC,oBAAA,GAAA1C,sBAAA,CAAAC,OAAA;AACA,IAAA0C,eAAA,GAAA3C,sBAAA,CAAAC,OAAA;AACA,IAAA2C,oBAAA,GAAA5C,sBAAA,CAAAC,OAAA;AACA,IAAA4C,0BAAA,GAAA7C,sBAAA,CAAAC,OAAA;AACA,IAAA6C,mBAAA,GAAA9C,sBAAA,CAAAC,OAAA;AACA,IAAA8C,cAAA,GAAA/C,sBAAA,CAAAC,OAAA;AACA,IAAA+C,cAAA,GAAAhD,sBAAA,CAAAC,OAAA;AACA,IAAAgD,mBAAA,GAAAjD,sBAAA,CAAAC,OAAA;AACA,IAAAiD,SAAA,GAAAlD,sBAAA,CAAAC,OAAA;AACA,IAAAkD,SAAA,GAAAnD,sBAAA,CAAAC,OAAA;AACA,IAAAmD,aAAA,GAAApD,sBAAA,CAAAC,OAAA;AACA,IAAAoD,WAAA,GAAArD,sBAAA,CAAAC,OAAA;AAA+C,SAAAD,uBAAAsD,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAE/C;AACA;AACA;AACA;AACA;AACA,MAAMG,KAAK,GAAG;EACZC,OAAO,EAAE,CAAC,CAAC;EACXC,KAAK,EAAE;IACL,cAAc,EAAEC,oBAAW;IAC3B,iBAAiB,EAAEC,uBAAc;IACjC,gBAAgB,EAAEC,sBAAa;IAC/B,mBAAmB,EAAEC,yBAAgB;IACrC,sBAAsB,EAAEC,2BAAkB;IAC1C,mBAAmB,EAAEC,wBAAe;IACpC,sBAAsB,EAAEC,2BAAkB;IAC1C,cAAc,EAAEC,oBAAW;IAC3B,iBAAiB,EAAEC,sBAAa;IAChC,aAAa,EAAEC,mBAAU;IACzB,cAAc,EAAEC,oBAAW;IAC3B,YAAY,EAAEC,kBAAS;IACvB,uBAAuB,EAAEC,4BAAmB;IAC5C,yBAAyB,EAAEC,8BAAqB;IAChD,kBAAkB,EAAEC,wBAAe;IACnC,mBAAmB,EAAEC,yBAAgB;IACrC,YAAY,EAAEC,kBAAS;IACvB,kBAAkB,EAAEC,wBAAe;IACnC,eAAe,EAAEC,oBAAW;IAC5B,6BAA6B,EAAEC,iCAAwB;IACvD,iBAAiB,EAAEC,sBAAa;IAChC,aAAa,EAAEC,mBAAU;IACzB,mBAAmB,EAAEC,wBAAe;IACpC,oBAAoB,EAAEC,yBAAgB;IACtC,sBAAsB,EAAEC,2BAAkB;IAC1C,UAAU,EAAEC,gBAAO;IACnB,oBAAoB,EAAEC,yBAAgB;IACtC,yBAAyB,EAAEC,8BAAqB;IAChD,qBAAqB,EAAEC,2BAAkB;IACzC,uCAAuC,EAAEC,2CAAkC;IAC3E,iBAAiB,EAAEC,uBAAc;IACjC,uBAAuB,EAAEC,4BAAmB;IAC5C,yCAAyC,EAAEC,4CAAmC;IAC9E,eAAe,EAAEC,qBAAY;IAC7B,eAAe,EAAEC,qBAAY;IAC7B,2BAA2B,EAAEC,gCAAuB;IACpD,oBAAoB,EAAEC,yBAAgB;IACtC,oBAAoB,EAAEC,yBAAgB;IACtC,kBAAkB,EAAEC,wBAAe;IACnC,8BAA8B,EAAEC,mCAA0B;IAC1D,uBAAuB,EAAEC,4BAAmB;IAC5C,uBAAuB,EAAEC,4BAAmB;IAC5C,iBAAiB,EAAEC,uBAAc;IACjC,uBAAuB,EAAEC,4BAAmB;IAC5C,6BAA6B,EAAEC,kCAAyB;IACxD,sBAAsB,EAAEC,2BAAkB;IAC1C,gBAAgB,EAAEC,sBAAa;IAC/B,gBAAgB,EAAEC,sBAAa;IAC/B,sBAAsB,EAAEC,2BAAkB;IAC1C,WAAW,EAAEC,iBAAQ;IACrB,WAAW,EAAEC,iBAAQ;IACrB,eAAe,EAAEC,qBAAY;IAC7B,aAAa,EAAEC;EACjB;AACF,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAMC,wBAAwB,GAAIC,WAAW,IAAK;EAChD,OAAO;IACLC,OAAO,EAAE,CACP,OAAO,CACR;IACDxD,KAAK,EAAE;MACL,oBAAoB,EAAEuD,WAAW;MACjC,uBAAuB,EAAEA,WAAW;MACpC,sBAAsB,EAAE,KAAK;MAC7B,yBAAyB,EAAE,KAAK;MAChC,4BAA4B,EAAE,KAAK;MACnC,yBAAyB,EAAEA,WAAW;MACtC,4BAA4B,EAAEA,WAAW;MACzC,oBAAoB,EAAE,KAAK;MAC3B,uBAAuB,EAAEA,WAAW;MACpC,mBAAmB,EAAEA,WAAW;MAChC,oBAAoB,EAAEA,WAAW;MACjC,kBAAkB,EAAEA,WAAW;MAC/B,6BAA6B,EAAEA,WAAW;MAC1C,+BAA+B,EAAE,KAAK;MACtC,wBAAwB,EAAE,KAAK;MAC/B,yBAAyB,EAAE,KAAK;MAChC,kBAAkB,EAAE,KAAK;MACzB,wBAAwB,EAAEA,WAAW;MACrC,qBAAqB,EAAE,KAAK;MAC5B,mCAAmC,EAAE,KAAK;MAC1C,uBAAuB,EAAE,KAAK;MAC9B,mBAAmB,EAAEA,WAAW;MAChC,yBAAyB,EAAE,KAAK;MAChC,0BAA0B,EAAEA,WAAW;MACvC,4BAA4B,EAAE,KAAK;MACnC,gBAAgB,EAAE,KAAK;MACvB,0BAA0B,EAAEA,WAAW;MACvC,+BAA+B,EAAE,KAAK;MACtC,2BAA2B,EAAE,KAAK;MAClC,6CAA6C,EAAE,KAAK;MACpD,uBAAuB,EAAE,KAAK;MAC9B,6BAA6B,EAAE,KAAK;MACpC,+CAA+C,EAAE,KAAK;MACtD,qBAAqB,EAAEA,WAAW;MAClC,qBAAqB,EAAEA,WAAW;MAClC,iCAAiC,EAAEA,WAAW;MAC9C,0BAA0B,EAAEA,WAAW;MACvC,0BAA0B,EAAEA,WAAW;MACvC,wBAAwB,EAAEA,WAAW;MACrC,oCAAoC,EAAEA,WAAW;MACjD,6BAA6B,EAAEA,WAAW;MAC1C,6BAA6B,EAAEA,WAAW;MAC1C,uBAAuB,EAAEA,WAAW;MACpC,6BAA6B,EAAEA,WAAW;MAC1C,mCAAmC,EAAEA,WAAW;MAChD,4BAA4B,EAAEA,WAAW;MACzC,sBAAsB,EAAE,KAAK;MAC7B,sBAAsB,EAAEA,WAAW;MACnC,4BAA4B,EAAEA,WAAW;MACzC,iBAAiB,EAAE,KAAK;MACxB,iBAAiB,EAAEA,WAAW;MAC9B,qBAAqB,EAAE,KAAK;MAC5B,mBAAmB,EAAEA;IACvB;EACF,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAME,kCAAkC,GAAIF,WAAW,IAAK;EAC1D,MAAMG,OAAO,GAAGJ,wBAAwB,CAACC,WAAW,CAAC;EAErD,OAAO;IACL,GAAGG,OAAO;IACV1D,KAAK,EAAE;MACL,GAAG0D,OAAO,CAAC1D,KAAK;MAChB;MACE,uBAAuB,EAAE,CACvBuD,WAAW,EAAE;QACXI,KAAK,EAAE;MACT,CAAC,CACF;MACD,gBAAgB,EAAEJ,WAAW;MAC7B,0BAA0B,EAAE,KAAK;MACjC,0BAA0B,EAAE,KAAK;MACjC,6BAA6B,EAAE,KAAK;MACpC,4BAA4B,EAAE;MAChC;IACF;EACF,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAMK,wCAAwC,GAAIL,WAAW,IAAK;EAChE,MAAMG,OAAO,GAAGJ,wBAAwB,CAACC,WAAW,CAAC;EAErD,OAAO;IACL,GAAGG,OAAO;IACV1D,KAAK,EAAE;MACL,GAAG0D,OAAO,CAAC1D,KAAK;MAChB;MACE,0BAA0B,EAAE;MAC9B;IACF;EACF,CAAC;AACH,CAAC;;AAED;AACA,IAAI,CAACF,KAAK,CAACC,OAAO,EAAE;EAClB,MAAM,IAAI8D,KAAK,CAAC,kBAAkB,CAAC;AACrC;AAEA/D,KAAK,CAACC,OAAO,CAAC+D,WAAW,GAAGR,wBAAwB,CAAC,MAAM,CAAC;AAC5DxD,KAAK,CAACC,OAAO,CAAC,mBAAmB,CAAC,GAAGuD,wBAAwB,CAAC,OAAO,CAAC;AACtExD,KAAK,CAACC,OAAO,CAAC,wBAAwB,CAAC,GAAG0D,kCAAkC,CAAC,MAAM,CAAC;AACpF3D,KAAK,CAACC,OAAO,CAAC,8BAA8B,CAAC,GAAG0D,kCAAkC,CAAC,OAAO,CAAC;AAC3F3D,KAAK,CAACC,OAAO,CAAC,+BAA+B,CAAC,GAAG6D,wCAAwC,CAAC,MAAM,CAAC;AACjG9D,KAAK,CAACC,OAAO,CAAC,qCAAqC,CAAC,GAAG6D,wCAAwC,CAAC,OAAO,CAAC;AAAC,IAAAG,QAAA,GAE1FjE,KAAK;AAAAkE,OAAA,CAAAnE,OAAA,GAAAkE,QAAA;AAAAE,MAAA,CAAAD,OAAA,GAAAA,OAAA,CAAAnE,OAAA"}
+{"version":3,"file":"index.js","names":["_checkAccess","_interopRequireDefault","require","_checkAlignment","_checkExamples","_checkIndentation","_checkLineAlignment","_checkParamNames","_checkPropertyNames","_checkSyntax","_checkTagNames","_checkTypes","_checkValues","_emptyTags","_implementsOnClasses","_importsAsDependencies","_informativeDocs","_matchDescription","_matchName","_multilineBlocks","_noBadBlocks","_noBlankBlockDescriptions","_noBlankBlocks","_noDefaults","_noMissingSyntax","_noMultiAsterisks","_noRestrictedSyntax","_noTypes","_noUndefinedTypes","_requireAsteriskPrefix","_requireDescription","_requireDescriptionCompleteSentence","_requireExample","_requireFileOverview","_requireHyphenBeforeParamDescription","_requireJsdoc","_requireParam","_requireParamDescription","_requireParamName","_requireParamType","_requireProperty","_requirePropertyDescription","_requirePropertyName","_requirePropertyType","_requireReturns","_requireReturnsCheck","_requireReturnsDescription","_requireReturnsType","_requireThrows","_requireYields","_requireYieldsCheck","_sortTags","_tagLines","_textEscaping","_validTypes","obj","__esModule","default","index","configs","rules","checkAccess","checkAlignment","checkExamples","checkIndentation","checkLineAlignment","checkParamNames","checkPropertyNames","checkSyntax","checkTagNames","checkTypes","checkValues","emptyTags","implementsOnClasses","importsAsDependencies","informativeDocs","matchDescription","matchName","multilineBlocks","noBadBlocks","noBlankBlockDescriptions","noBlankBlocks","noDefaults","noMissingSyntax","noMultiAsterisks","noRestrictedSyntax","noTypes","noUndefinedTypes","requireAsteriskPrefix","requireDescription","requireDescriptionCompleteSentence","requireExample","requireFileOverview","requireHyphenBeforeParamDescription","requireJsdoc","requireParam","requireParamDescription","requireParamName","requireParamType","requireProperty","requirePropertyDescription","requirePropertyName","requirePropertyType","requireReturns","requireReturnsCheck","requireReturnsDescription","requireReturnsType","requireThrows","requireYields","requireYieldsCheck","sortTags","tagLines","textEscaping","validTypes","createRecommendedRuleset","warnOrError","flat","plugins","jsdoc","createRecommendedTypeScriptRuleset","ruleset","typed","createRecommendedTypeScriptFlavorRuleset","Error","recommended","_default","exports","module"],"sources":["../src/index.js"],"sourcesContent":["import checkAccess from './rules/checkAccess.js';\nimport checkAlignment from './rules/checkAlignment.js';\nimport checkExamples from './rules/checkExamples.js';\nimport checkIndentation from './rules/checkIndentation.js';\nimport checkLineAlignment from './rules/checkLineAlignment.js';\nimport checkParamNames from './rules/checkParamNames.js';\nimport checkPropertyNames from './rules/checkPropertyNames.js';\nimport checkSyntax from './rules/checkSyntax.js';\nimport checkTagNames from './rules/checkTagNames.js';\nimport checkTypes from './rules/checkTypes.js';\nimport checkValues from './rules/checkValues.js';\nimport emptyTags from './rules/emptyTags.js';\nimport implementsOnClasses from './rules/implementsOnClasses.js';\nimport importsAsDependencies from './rules/importsAsDependencies.js';\nimport informativeDocs from './rules/informativeDocs.js';\nimport matchDescription from './rules/matchDescription.js';\nimport matchName from './rules/matchName.js';\nimport multilineBlocks from './rules/multilineBlocks.js';\nimport noBadBlocks from './rules/noBadBlocks.js';\nimport noBlankBlockDescriptions from './rules/noBlankBlockDescriptions.js';\nimport noBlankBlocks from './rules/noBlankBlocks.js';\nimport noDefaults from './rules/noDefaults.js';\nimport noMissingSyntax from './rules/noMissingSyntax.js';\nimport noMultiAsterisks from './rules/noMultiAsterisks.js';\nimport noRestrictedSyntax from './rules/noRestrictedSyntax.js';\nimport noTypes from './rules/noTypes.js';\nimport noUndefinedTypes from './rules/noUndefinedTypes.js';\nimport requireAsteriskPrefix from './rules/requireAsteriskPrefix.js';\nimport requireDescription from './rules/requireDescription.js';\nimport requireDescriptionCompleteSentence from './rules/requireDescriptionCompleteSentence.js';\nimport requireExample from './rules/requireExample.js';\nimport requireFileOverview from './rules/requireFileOverview.js';\nimport requireHyphenBeforeParamDescription from './rules/requireHyphenBeforeParamDescription.js';\nimport requireJsdoc from './rules/requireJsdoc.js';\nimport requireParam from './rules/requireParam.js';\nimport requireParamDescription from './rules/requireParamDescription.js';\nimport requireParamName from './rules/requireParamName.js';\nimport requireParamType from './rules/requireParamType.js';\nimport requireProperty from './rules/requireProperty.js';\nimport requirePropertyDescription from './rules/requirePropertyDescription.js';\nimport requirePropertyName from './rules/requirePropertyName.js';\nimport requirePropertyType from './rules/requirePropertyType.js';\nimport requireReturns from './rules/requireReturns.js';\nimport requireReturnsCheck from './rules/requireReturnsCheck.js';\nimport requireReturnsDescription from './rules/requireReturnsDescription.js';\nimport requireReturnsType from './rules/requireReturnsType.js';\nimport requireThrows from './rules/requireThrows.js';\nimport requireYields from './rules/requireYields.js';\nimport requireYieldsCheck from './rules/requireYieldsCheck.js';\nimport sortTags from './rules/sortTags.js';\nimport tagLines from './rules/tagLines.js';\nimport textEscaping from './rules/textEscaping.js';\nimport validTypes from './rules/validTypes.js';\n\n/**\n * @type {import('eslint').ESLint.Plugin & {\n *   configs: Record<string, import('eslint').ESLint.ConfigData|{}>\n * }}\n */\nconst index = {\n  configs: {},\n  rules: {\n    'check-access': checkAccess,\n    'check-alignment': checkAlignment,\n    'check-examples': checkExamples,\n    'check-indentation': checkIndentation,\n    'check-line-alignment': checkLineAlignment,\n    'check-param-names': checkParamNames,\n    'check-property-names': checkPropertyNames,\n    'check-syntax': checkSyntax,\n    'check-tag-names': checkTagNames,\n    'check-types': checkTypes,\n    'check-values': checkValues,\n    'empty-tags': emptyTags,\n    'implements-on-classes': implementsOnClasses,\n    'imports-as-dependencies': importsAsDependencies,\n    'informative-docs': informativeDocs,\n    'match-description': matchDescription,\n    'match-name': matchName,\n    'multiline-blocks': multilineBlocks,\n    'no-bad-blocks': noBadBlocks,\n    'no-blank-block-descriptions': noBlankBlockDescriptions,\n    'no-blank-blocks': noBlankBlocks,\n    'no-defaults': noDefaults,\n    'no-missing-syntax': noMissingSyntax,\n    'no-multi-asterisks': noMultiAsterisks,\n    'no-restricted-syntax': noRestrictedSyntax,\n    'no-types': noTypes,\n    'no-undefined-types': noUndefinedTypes,\n    'require-asterisk-prefix': requireAsteriskPrefix,\n    'require-description': requireDescription,\n    'require-description-complete-sentence': requireDescriptionCompleteSentence,\n    'require-example': requireExample,\n    'require-file-overview': requireFileOverview,\n    'require-hyphen-before-param-description': requireHyphenBeforeParamDescription,\n    'require-jsdoc': requireJsdoc,\n    'require-param': requireParam,\n    'require-param-description': requireParamDescription,\n    'require-param-name': requireParamName,\n    'require-param-type': requireParamType,\n    'require-property': requireProperty,\n    'require-property-description': requirePropertyDescription,\n    'require-property-name': requirePropertyName,\n    'require-property-type': requirePropertyType,\n    'require-returns': requireReturns,\n    'require-returns-check': requireReturnsCheck,\n    'require-returns-description': requireReturnsDescription,\n    'require-returns-type': requireReturnsType,\n    'require-throws': requireThrows,\n    'require-yields': requireYields,\n    'require-yields-check': requireYieldsCheck,\n    'sort-tags': sortTags,\n    'tag-lines': tagLines,\n    'text-escaping': textEscaping,\n    'valid-types': validTypes,\n  },\n};\n\n/**\n * @param {\"warn\"|\"error\"} warnOrError\n * @param {boolean} [flat]\n * @returns {import('eslint').ESLint.ConfigData | {plugins: {}, rules: {}}}\n */\nconst createRecommendedRuleset = (warnOrError, flat) => {\n  return {\n    plugins: flat ? {\n      jsdoc: index,\n    } : [\n      'jsdoc',\n    ],\n    rules: {\n      'jsdoc/check-access': warnOrError,\n      'jsdoc/check-alignment': warnOrError,\n      'jsdoc/check-examples': 'off',\n      'jsdoc/check-indentation': 'off',\n      'jsdoc/check-line-alignment': 'off',\n      'jsdoc/check-param-names': warnOrError,\n      'jsdoc/check-property-names': warnOrError,\n      'jsdoc/check-syntax': 'off',\n      'jsdoc/check-tag-names': warnOrError,\n      'jsdoc/check-types': warnOrError,\n      'jsdoc/check-values': warnOrError,\n      'jsdoc/empty-tags': warnOrError,\n      'jsdoc/implements-on-classes': warnOrError,\n      'jsdoc/imports-as-dependencies': 'off',\n      'jsdoc/informative-docs': 'off',\n      'jsdoc/match-description': 'off',\n      'jsdoc/match-name': 'off',\n      'jsdoc/multiline-blocks': warnOrError,\n      'jsdoc/no-bad-blocks': 'off',\n      'jsdoc/no-blank-block-descriptions': 'off',\n      'jsdoc/no-blank-blocks': 'off',\n      'jsdoc/no-defaults': warnOrError,\n      'jsdoc/no-missing-syntax': 'off',\n      'jsdoc/no-multi-asterisks': warnOrError,\n      'jsdoc/no-restricted-syntax': 'off',\n      'jsdoc/no-types': 'off',\n      'jsdoc/no-undefined-types': warnOrError,\n      'jsdoc/require-asterisk-prefix': 'off',\n      'jsdoc/require-description': 'off',\n      'jsdoc/require-description-complete-sentence': 'off',\n      'jsdoc/require-example': 'off',\n      'jsdoc/require-file-overview': 'off',\n      'jsdoc/require-hyphen-before-param-description': 'off',\n      'jsdoc/require-jsdoc': warnOrError,\n      'jsdoc/require-param': warnOrError,\n      'jsdoc/require-param-description': warnOrError,\n      'jsdoc/require-param-name': warnOrError,\n      'jsdoc/require-param-type': warnOrError,\n      'jsdoc/require-property': warnOrError,\n      'jsdoc/require-property-description': warnOrError,\n      'jsdoc/require-property-name': warnOrError,\n      'jsdoc/require-property-type': warnOrError,\n      'jsdoc/require-returns': warnOrError,\n      'jsdoc/require-returns-check': warnOrError,\n      'jsdoc/require-returns-description': warnOrError,\n      'jsdoc/require-returns-type': warnOrError,\n      'jsdoc/require-throws': 'off',\n      'jsdoc/require-yields': warnOrError,\n      'jsdoc/require-yields-check': warnOrError,\n      'jsdoc/sort-tags': 'off',\n      'jsdoc/tag-lines': warnOrError,\n      'jsdoc/text-escaping': 'off',\n      'jsdoc/valid-types': warnOrError,\n    },\n  };\n};\n\n/**\n * @param {\"warn\"|\"error\"} warnOrError\n * @param {boolean} [flat]\n * @returns {import('eslint').ESLint.ConfigData|{}}\n */\nconst createRecommendedTypeScriptRuleset = (warnOrError, flat) => {\n  const ruleset = createRecommendedRuleset(warnOrError, flat);\n\n  return {\n    ...ruleset,\n    rules: {\n      ...ruleset.rules,\n      /* eslint-disable indent -- Extra indent to avoid use by auto-rule-editing */\n        'jsdoc/check-tag-names': [\n          warnOrError, {\n            typed: true,\n          },\n        ],\n        'jsdoc/no-types': warnOrError,\n        'jsdoc/no-undefined-types': 'off',\n        'jsdoc/require-param-type': 'off',\n        'jsdoc/require-property-type': 'off',\n        'jsdoc/require-returns-type': 'off',\n      /* eslint-enable indent */\n    },\n  };\n};\n\n/**\n * @param {\"warn\"|\"error\"} warnOrError\n * @param {boolean} [flat]\n * @returns {import('eslint').ESLint.ConfigData|{}}\n */\nconst createRecommendedTypeScriptFlavorRuleset = (warnOrError, flat) => {\n  const ruleset = createRecommendedRuleset(warnOrError, flat);\n\n  return {\n    ...ruleset,\n    rules: {\n      ...ruleset.rules,\n      /* eslint-disable indent -- Extra indent to avoid use by auto-rule-editing */\n        'jsdoc/no-undefined-types': 'off',\n      /* eslint-enable indent */\n    },\n  };\n};\n\n/* istanbul ignore if -- TS */\nif (!index.configs) {\n  throw new Error('TypeScript guard');\n}\n\nindex.configs.recommended = createRecommendedRuleset('warn');\nindex.configs['recommended-error'] = createRecommendedRuleset('error');\nindex.configs['recommended-typescript'] = createRecommendedTypeScriptRuleset('warn');\nindex.configs['recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error');\nindex.configs['recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn');\nindex.configs['recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error');\n\nindex.configs['flat/recommended'] = createRecommendedRuleset('warn', true);\nindex.configs['flat/recommended-error'] = createRecommendedRuleset('error', true);\nindex.configs['flat/recommended-typescript'] = createRecommendedTypeScriptRuleset('warn', true);\nindex.configs['flat/recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error', true);\nindex.configs['flat/recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn', true);\nindex.configs['flat/recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error', true);\n\nexport default index;\n"],"mappings":";;;;;;AAAA,IAAAA,YAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,eAAA,GAAAF,sBAAA,CAAAC,OAAA;AACA,IAAAE,cAAA,GAAAH,sBAAA,CAAAC,OAAA;AACA,IAAAG,iBAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,mBAAA,GAAAL,sBAAA,CAAAC,OAAA;AACA,IAAAK,gBAAA,GAAAN,sBAAA,CAAAC,OAAA;AACA,IAAAM,mBAAA,GAAAP,sBAAA,CAAAC,OAAA;AACA,IAAAO,YAAA,GAAAR,sBAAA,CAAAC,OAAA;AACA,IAAAQ,cAAA,GAAAT,sBAAA,CAAAC,OAAA;AACA,IAAAS,WAAA,GAAAV,sBAAA,CAAAC,OAAA;AACA,IAAAU,YAAA,GAAAX,sBAAA,CAAAC,OAAA;AACA,IAAAW,UAAA,GAAAZ,sBAAA,CAAAC,OAAA;AACA,IAAAY,oBAAA,GAAAb,sBAAA,CAAAC,OAAA;AACA,IAAAa,sBAAA,GAAAd,sBAAA,CAAAC,OAAA;AACA,IAAAc,gBAAA,GAAAf,sBAAA,CAAAC,OAAA;AACA,IAAAe,iBAAA,GAAAhB,sBAAA,CAAAC,OAAA;AACA,IAAAgB,UAAA,GAAAjB,sBAAA,CAAAC,OAAA;AACA,IAAAiB,gBAAA,GAAAlB,sBAAA,CAAAC,OAAA;AACA,IAAAkB,YAAA,GAAAnB,sBAAA,CAAAC,OAAA;AACA,IAAAmB,yBAAA,GAAApB,sBAAA,CAAAC,OAAA;AACA,IAAAoB,cAAA,GAAArB,sBAAA,CAAAC,OAAA;AACA,IAAAqB,WAAA,GAAAtB,sBAAA,CAAAC,OAAA;AACA,IAAAsB,gBAAA,GAAAvB,sBAAA,CAAAC,OAAA;AACA,IAAAuB,iBAAA,GAAAxB,sBAAA,CAAAC,OAAA;AACA,IAAAwB,mBAAA,GAAAzB,sBAAA,CAAAC,OAAA;AACA,IAAAyB,QAAA,GAAA1B,sBAAA,CAAAC,OAAA;AACA,IAAA0B,iBAAA,GAAA3B,sBAAA,CAAAC,OAAA;AACA,IAAA2B,sBAAA,GAAA5B,sBAAA,CAAAC,OAAA;AACA,IAAA4B,mBAAA,GAAA7B,sBAAA,CAAAC,OAAA;AACA,IAAA6B,mCAAA,GAAA9B,sBAAA,CAAAC,OAAA;AACA,IAAA8B,eAAA,GAAA/B,sBAAA,CAAAC,OAAA;AACA,IAAA+B,oBAAA,GAAAhC,sBAAA,CAAAC,OAAA;AACA,IAAAgC,oCAAA,GAAAjC,sBAAA,CAAAC,OAAA;AACA,IAAAiC,aAAA,GAAAlC,sBAAA,CAAAC,OAAA;AACA,IAAAkC,aAAA,GAAAnC,sBAAA,CAAAC,OAAA;AACA,IAAAmC,wBAAA,GAAApC,sBAAA,CAAAC,OAAA;AACA,IAAAoC,iBAAA,GAAArC,sBAAA,CAAAC,OAAA;AACA,IAAAqC,iBAAA,GAAAtC,sBAAA,CAAAC,OAAA;AACA,IAAAsC,gBAAA,GAAAvC,sBAAA,CAAAC,OAAA;AACA,IAAAuC,2BAAA,GAAAxC,sBAAA,CAAAC,OAAA;AACA,IAAAwC,oBAAA,GAAAzC,sBAAA,CAAAC,OAAA;AACA,IAAAyC,oBAAA,GAAA1C,sBAAA,CAAAC,OAAA;AACA,IAAA0C,eAAA,GAAA3C,sBAAA,CAAAC,OAAA;AACA,IAAA2C,oBAAA,GAAA5C,sBAAA,CAAAC,OAAA;AACA,IAAA4C,0BAAA,GAAA7C,sBAAA,CAAAC,OAAA;AACA,IAAA6C,mBAAA,GAAA9C,sBAAA,CAAAC,OAAA;AACA,IAAA8C,cAAA,GAAA/C,sBAAA,CAAAC,OAAA;AACA,IAAA+C,cAAA,GAAAhD,sBAAA,CAAAC,OAAA;AACA,IAAAgD,mBAAA,GAAAjD,sBAAA,CAAAC,OAAA;AACA,IAAAiD,SAAA,GAAAlD,sBAAA,CAAAC,OAAA;AACA,IAAAkD,SAAA,GAAAnD,sBAAA,CAAAC,OAAA;AACA,IAAAmD,aAAA,GAAApD,sBAAA,CAAAC,OAAA;AACA,IAAAoD,WAAA,GAAArD,sBAAA,CAAAC,OAAA;AAA+C,SAAAD,uBAAAsD,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAE/C;AACA;AACA;AACA;AACA;AACA,MAAMG,KAAK,GAAG;EACZC,OAAO,EAAE,CAAC,CAAC;EACXC,KAAK,EAAE;IACL,cAAc,EAAEC,oBAAW;IAC3B,iBAAiB,EAAEC,uBAAc;IACjC,gBAAgB,EAAEC,sBAAa;IAC/B,mBAAmB,EAAEC,yBAAgB;IACrC,sBAAsB,EAAEC,2BAAkB;IAC1C,mBAAmB,EAAEC,wBAAe;IACpC,sBAAsB,EAAEC,2BAAkB;IAC1C,cAAc,EAAEC,oBAAW;IAC3B,iBAAiB,EAAEC,sBAAa;IAChC,aAAa,EAAEC,mBAAU;IACzB,cAAc,EAAEC,oBAAW;IAC3B,YAAY,EAAEC,kBAAS;IACvB,uBAAuB,EAAEC,4BAAmB;IAC5C,yBAAyB,EAAEC,8BAAqB;IAChD,kBAAkB,EAAEC,wBAAe;IACnC,mBAAmB,EAAEC,yBAAgB;IACrC,YAAY,EAAEC,kBAAS;IACvB,kBAAkB,EAAEC,wBAAe;IACnC,eAAe,EAAEC,oBAAW;IAC5B,6BAA6B,EAAEC,iCAAwB;IACvD,iBAAiB,EAAEC,sBAAa;IAChC,aAAa,EAAEC,mBAAU;IACzB,mBAAmB,EAAEC,wBAAe;IACpC,oBAAoB,EAAEC,yBAAgB;IACtC,sBAAsB,EAAEC,2BAAkB;IAC1C,UAAU,EAAEC,gBAAO;IACnB,oBAAoB,EAAEC,yBAAgB;IACtC,yBAAyB,EAAEC,8BAAqB;IAChD,qBAAqB,EAAEC,2BAAkB;IACzC,uCAAuC,EAAEC,2CAAkC;IAC3E,iBAAiB,EAAEC,uBAAc;IACjC,uBAAuB,EAAEC,4BAAmB;IAC5C,yCAAyC,EAAEC,4CAAmC;IAC9E,eAAe,EAAEC,qBAAY;IAC7B,eAAe,EAAEC,qBAAY;IAC7B,2BAA2B,EAAEC,gCAAuB;IACpD,oBAAoB,EAAEC,yBAAgB;IACtC,oBAAoB,EAAEC,yBAAgB;IACtC,kBAAkB,EAAEC,wBAAe;IACnC,8BAA8B,EAAEC,mCAA0B;IAC1D,uBAAuB,EAAEC,4BAAmB;IAC5C,uBAAuB,EAAEC,4BAAmB;IAC5C,iBAAiB,EAAEC,uBAAc;IACjC,uBAAuB,EAAEC,4BAAmB;IAC5C,6BAA6B,EAAEC,kCAAyB;IACxD,sBAAsB,EAAEC,2BAAkB;IAC1C,gBAAgB,EAAEC,sBAAa;IAC/B,gBAAgB,EAAEC,sBAAa;IAC/B,sBAAsB,EAAEC,2BAAkB;IAC1C,WAAW,EAAEC,iBAAQ;IACrB,WAAW,EAAEC,iBAAQ;IACrB,eAAe,EAAEC,qBAAY;IAC7B,aAAa,EAAEC;EACjB;AACF,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAMC,wBAAwB,GAAGA,CAACC,WAAW,EAAEC,IAAI,KAAK;EACtD,OAAO;IACLC,OAAO,EAAED,IAAI,GAAG;MACdE,KAAK,EAAE5D;IACT,CAAC,GAAG,CACF,OAAO,CACR;IACDE,KAAK,EAAE;MACL,oBAAoB,EAAEuD,WAAW;MACjC,uBAAuB,EAAEA,WAAW;MACpC,sBAAsB,EAAE,KAAK;MAC7B,yBAAyB,EAAE,KAAK;MAChC,4BAA4B,EAAE,KAAK;MACnC,yBAAyB,EAAEA,WAAW;MACtC,4BAA4B,EAAEA,WAAW;MACzC,oBAAoB,EAAE,KAAK;MAC3B,uBAAuB,EAAEA,WAAW;MACpC,mBAAmB,EAAEA,WAAW;MAChC,oBAAoB,EAAEA,WAAW;MACjC,kBAAkB,EAAEA,WAAW;MAC/B,6BAA6B,EAAEA,WAAW;MAC1C,+BAA+B,EAAE,KAAK;MACtC,wBAAwB,EAAE,KAAK;MAC/B,yBAAyB,EAAE,KAAK;MAChC,kBAAkB,EAAE,KAAK;MACzB,wBAAwB,EAAEA,WAAW;MACrC,qBAAqB,EAAE,KAAK;MAC5B,mCAAmC,EAAE,KAAK;MAC1C,uBAAuB,EAAE,KAAK;MAC9B,mBAAmB,EAAEA,WAAW;MAChC,yBAAyB,EAAE,KAAK;MAChC,0BAA0B,EAAEA,WAAW;MACvC,4BAA4B,EAAE,KAAK;MACnC,gBAAgB,EAAE,KAAK;MACvB,0BAA0B,EAAEA,WAAW;MACvC,+BAA+B,EAAE,KAAK;MACtC,2BAA2B,EAAE,KAAK;MAClC,6CAA6C,EAAE,KAAK;MACpD,uBAAuB,EAAE,KAAK;MAC9B,6BAA6B,EAAE,KAAK;MACpC,+CAA+C,EAAE,KAAK;MACtD,qBAAqB,EAAEA,WAAW;MAClC,qBAAqB,EAAEA,WAAW;MAClC,iCAAiC,EAAEA,WAAW;MAC9C,0BAA0B,EAAEA,WAAW;MACvC,0BAA0B,EAAEA,WAAW;MACvC,wBAAwB,EAAEA,WAAW;MACrC,oCAAoC,EAAEA,WAAW;MACjD,6BAA6B,EAAEA,WAAW;MAC1C,6BAA6B,EAAEA,WAAW;MAC1C,uBAAuB,EAAEA,WAAW;MACpC,6BAA6B,EAAEA,WAAW;MAC1C,mCAAmC,EAAEA,WAAW;MAChD,4BAA4B,EAAEA,WAAW;MACzC,sBAAsB,EAAE,KAAK;MAC7B,sBAAsB,EAAEA,WAAW;MACnC,4BAA4B,EAAEA,WAAW;MACzC,iBAAiB,EAAE,KAAK;MACxB,iBAAiB,EAAEA,WAAW;MAC9B,qBAAqB,EAAE,KAAK;MAC5B,mBAAmB,EAAEA;IACvB;EACF,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAMI,kCAAkC,GAAGA,CAACJ,WAAW,EAAEC,IAAI,KAAK;EAChE,MAAMI,OAAO,GAAGN,wBAAwB,CAACC,WAAW,EAAEC,IAAI,CAAC;EAE3D,OAAO;IACL,GAAGI,OAAO;IACV5D,KAAK,EAAE;MACL,GAAG4D,OAAO,CAAC5D,KAAK;MAChB;MACE,uBAAuB,EAAE,CACvBuD,WAAW,EAAE;QACXM,KAAK,EAAE;MACT,CAAC,CACF;MACD,gBAAgB,EAAEN,WAAW;MAC7B,0BAA0B,EAAE,KAAK;MACjC,0BAA0B,EAAE,KAAK;MACjC,6BAA6B,EAAE,KAAK;MACpC,4BAA4B,EAAE;MAChC;IACF;EACF,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAMO,wCAAwC,GAAGA,CAACP,WAAW,EAAEC,IAAI,KAAK;EACtE,MAAMI,OAAO,GAAGN,wBAAwB,CAACC,WAAW,EAAEC,IAAI,CAAC;EAE3D,OAAO;IACL,GAAGI,OAAO;IACV5D,KAAK,EAAE;MACL,GAAG4D,OAAO,CAAC5D,KAAK;MAChB;MACE,0BAA0B,EAAE;MAC9B;IACF;EACF,CAAC;AACH,CAAC;;AAED;AACA,IAAI,CAACF,KAAK,CAACC,OAAO,EAAE;EAClB,MAAM,IAAIgE,KAAK,CAAC,kBAAkB,CAAC;AACrC;AAEAjE,KAAK,CAACC,OAAO,CAACiE,WAAW,GAAGV,wBAAwB,CAAC,MAAM,CAAC;AAC5DxD,KAAK,CAACC,OAAO,CAAC,mBAAmB,CAAC,GAAGuD,wBAAwB,CAAC,OAAO,CAAC;AACtExD,KAAK,CAACC,OAAO,CAAC,wBAAwB,CAAC,GAAG4D,kCAAkC,CAAC,MAAM,CAAC;AACpF7D,KAAK,CAACC,OAAO,CAAC,8BAA8B,CAAC,GAAG4D,kCAAkC,CAAC,OAAO,CAAC;AAC3F7D,KAAK,CAACC,OAAO,CAAC,+BAA+B,CAAC,GAAG+D,wCAAwC,CAAC,MAAM,CAAC;AACjGhE,KAAK,CAACC,OAAO,CAAC,qCAAqC,CAAC,GAAG+D,wCAAwC,CAAC,OAAO,CAAC;AAExGhE,KAAK,CAACC,OAAO,CAAC,kBAAkB,CAAC,GAAGuD,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC;AAC1ExD,KAAK,CAACC,OAAO,CAAC,wBAAwB,CAAC,GAAGuD,wBAAwB,CAAC,OAAO,EAAE,IAAI,CAAC;AACjFxD,KAAK,CAACC,OAAO,CAAC,6BAA6B,CAAC,GAAG4D,kCAAkC,CAAC,MAAM,EAAE,IAAI,CAAC;AAC/F7D,KAAK,CAACC,OAAO,CAAC,mCAAmC,CAAC,GAAG4D,kCAAkC,CAAC,OAAO,EAAE,IAAI,CAAC;AACtG7D,KAAK,CAACC,OAAO,CAAC,oCAAoC,CAAC,GAAG+D,wCAAwC,CAAC,MAAM,EAAE,IAAI,CAAC;AAC5GhE,KAAK,CAACC,OAAO,CAAC,0CAA0C,CAAC,GAAG+D,wCAAwC,CAAC,OAAO,EAAE,IAAI,CAAC;AAAC,IAAAG,QAAA,GAErGnE,KAAK;AAAAoE,OAAA,CAAArE,OAAA,GAAAoE,QAAA;AAAAE,MAAA,CAAAD,OAAA,GAAAA,OAAA,CAAArE,OAAA"}

package/dist/iterateJsdoc.js

@@ -1794,7 +1794,7 @@ const getIndentAndJSDoc = function (lines, jsdocNode) {
 /**
  * @typedef {object} RuleConfig
  * @property {EslintRuleMeta} meta ESLint rule meta
- * @property {import('./jsdocUtils').DefaultContexts} [contextDefaults] Any default contexts
+ * @property {import('./jsdocUtils.js').DefaultContexts} [contextDefaults] Any default contexts
  * @property {true} [contextSelected] Whether to force a `contexts` check
  * @property {true} [iterateAllJsdocs] Whether to iterate all JSDoc blocks by default
  *   regardless of context