eslint-plugin-jsdoc 52.0.4 → 53.0.1

package/dist/rules/informativeDocs.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"informativeDocs.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","_areDocsInformative","e","__esModule","default","defaultAliases","a","defaultUselessWords","getNamesFromNode","node","type","parent","key","id","declaration","name","declarations","init","filter","Boolean","_default","exports","iterateJsdoc","context","jsdoc","report","utils","aliases","excludedTags","uselessWords","options","nodeNames","descriptionIsRedundant","text","extraName","textTrimmed","trim","areDocsInformative","join","description","lastDescriptionLine","getDescription","descriptionReported","tag","tags","includes","reportJSDoc","line","iterateAllJsdocs","meta","docs","url","schema","additionalProperties","properties","patternProperties","items","module"],"sources":["../../src/rules/informativeDocs.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  areDocsInformative,\n} from 'are-docs-informative';\n\nconst defaultAliases = {\n  a: [\n    'an', 'our',\n  ],\n};\n\nconst defaultUselessWords = [\n  'a', 'an', 'i', 'in', 'of', 's', 'the',\n];\n\n/* eslint-disable complexity -- Temporary */\n\n/**\n * @param {import('eslint').Rule.Node|import('@typescript-eslint/types').TSESTree.Node|null|undefined} node\n * @returns {string[]}\n */\nconst getNamesFromNode = (node) => {\n  switch (node?.type) {\n    case 'AccessorProperty':\n    case 'MethodDefinition':\n    case 'PropertyDefinition':\n    case 'TSAbstractAccessorProperty':\n    case 'TSAbstractMethodDefinition':\n    case 'TSAbstractPropertyDefinition':\n      return [\n        ...getNamesFromNode(\n        /** @type {import('@typescript-eslint/types').TSESTree.Node} */ (\n            node.parent\n          ).parent,\n        ),\n        ...getNamesFromNode(\n        /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n          (node.key),\n        ),\n      ];\n\n    case 'ClassDeclaration':\n    case 'ClassExpression':\n    case 'FunctionDeclaration':\n    case 'FunctionExpression':\n    case 'TSDeclareFunction':\n    case 'TSEnumDeclaration':\n    case 'TSEnumMember':\n    case 'TSInterfaceDeclaration':\n    case 'TSMethodSignature':\n    case 'TSModuleDeclaration':\n    case 'TSTypeAliasDeclaration':\n      return getNamesFromNode(\n      /** @type {import('@typescript-eslint/types').TSESTree.ClassDeclaration} */\n        (node).id,\n      );\n    case 'ExportDefaultDeclaration':\n    case 'ExportNamedDeclaration':\n      return getNamesFromNode(\n      /** @type {import('@typescript-eslint/types').TSESTree.ExportNamedDeclaration} */\n        (node).declaration,\n      );\n    case 'Identifier':\n      return [\n        node.name,\n      ];\n    case 'Property':\n      return getNamesFromNode(\n      /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n        (node.key),\n      );\n    case 'VariableDeclaration':\n      return getNamesFromNode(\n      /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n        (node.declarations[0]),\n      );\n    case 'VariableDeclarator':\n      return [\n        ...getNamesFromNode(\n        /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n          (node.id),\n        ),\n        ...getNamesFromNode(\n        /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n          (node.init),\n        ),\n      ].filter(Boolean);\n    default:\n      return [];\n  }\n};\n/* eslint-enable complexity -- Temporary */\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  node,\n  report,\n  utils,\n}) => {\n  const /** @type {{aliases: {[key: string]: string[]}, excludedTags: string[], uselessWords: string[]}} */ {\n    aliases = defaultAliases,\n    excludedTags = [],\n    uselessWords = defaultUselessWords,\n  } = context.options[0] || {};\n  const nodeNames = getNamesFromNode(node);\n\n  /**\n   * @param {string} text\n   * @param {string} extraName\n   * @returns {boolean}\n   */\n  const descriptionIsRedundant = (text, extraName = '') => {\n    const textTrimmed = text.trim();\n    return Boolean(textTrimmed) && !areDocsInformative(textTrimmed, [\n      extraName, nodeNames,\n    ].filter(Boolean).join(' '), {\n      aliases,\n      uselessWords,\n    });\n  };\n\n  const {\n    description,\n    lastDescriptionLine,\n  } = utils.getDescription();\n  let descriptionReported = false;\n\n  for (const tag of jsdoc.tags) {\n    if (excludedTags.includes(tag.tag)) {\n      continue;\n    }\n\n    if (descriptionIsRedundant(tag.description, tag.name)) {\n      utils.reportJSDoc(\n        'This tag description only repeats the name it describes.',\n        tag,\n      );\n    }\n\n    descriptionReported ||= tag.description === description &&\n      /** @type {import('comment-parser').Spec & {line: import('../iterateJsdoc.js').Integer}} */\n      (tag).line === lastDescriptionLine;\n  }\n\n  if (!descriptionReported && descriptionIsRedundant(description)) {\n    report('This description only repeats the name it describes.');\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description:\n        'This rule reports doc comments that only restate their attached name.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/informative-docs.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          aliases: {\n            patternProperties: {\n              '.*': {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n            },\n          },\n          excludedTags: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          uselessWords: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,mBAAA,GAAAD,OAAA;AAE8B,SAAAD,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9B,MAAMG,cAAc,GAAG;EACrBC,CAAC,EAAE,CACD,IAAI,EAAE,KAAK;AAEf,CAAC;AAED,MAAMC,mBAAmB,GAAG,CAC1B,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,CACvC;;AAED;;AAEA;AACA;AACA;AACA;AACA,MAAMC,gBAAgB,GAAIC,IAAI,IAAK;EACjC,QAAQA,IAAI,EAAEC,IAAI;IAChB,KAAK,kBAAkB;IACvB,KAAK,kBAAkB;IACvB,KAAK,oBAAoB;IACzB,KAAK,4BAA4B;IACjC,KAAK,4BAA4B;IACjC,KAAK,8BAA8B;MACjC,OAAO,CACL,GAAGF,gBAAgB,CACnB,+DACIC,IAAI,CAACE,MAAM,CACXA,MACJ,CAAC,EACD,GAAGH,gBAAgB,CACnB;MACGC,IAAI,CAACG,GACR,CAAC,CACF;IAEH,KAAK,kBAAkB;IACvB,KAAK,iBAAiB;IACtB,KAAK,qBAAqB;IAC1B,KAAK,oBAAoB;IACzB,KAAK,mBAAmB;IACxB,KAAK,mBAAmB;IACxB,KAAK,cAAc;IACnB,KAAK,wBAAwB;IAC7B,KAAK,mBAAmB;IACxB,KAAK,qBAAqB;IAC1B,KAAK,wBAAwB;MAC3B,OAAOJ,gBAAgB,CACvB;MACGC,IAAI,CAAEI,EACT,CAAC;IACH,KAAK,0BAA0B;IAC/B,KAAK,wBAAwB;MAC3B,OAAOL,gBAAgB,CACvB;MACGC,IAAI,CAAEK,WACT,CAAC;IACH,KAAK,YAAY;MACf,OAAO,CACLL,IAAI,CAACM,IAAI,CACV;IACH,KAAK,UAAU;MACb,OAAOP,gBAAgB,CACvB;MACGC,IAAI,CAACG,GACR,CAAC;IACH,KAAK,qBAAqB;MACxB,OAAOJ,gBAAgB,CACvB;MACGC,IAAI,CAACO,YAAY,CAAC,CAAC,CACtB,CAAC;IACH,KAAK,oBAAoB;MACvB,OAAO,CACL,GAAGR,gBAAgB,CACnB;MACGC,IAAI,CAACI,EACR,CAAC,EACD,GAAGL,gBAAgB,CACnB;MACGC,IAAI,CAACQ,IACR,CAAC,CACF,CAACC,MAAM,CAACC,OAAO,CAAC;IACnB;MACE,OAAO,EAAE;EACb;AACF,CAAC;AACD;AAAA,IAAAC,QAAA,GAAAC,OAAA,CAAAjB,OAAA,GAEe,IAAAkB,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,KAAK;EACLf,IAAI;EACJgB,MAAM;EACNC;AACF,CAAC,KAAK;EACJ,MAAM,mGAAoG;IACxGC,OAAO,GAAGtB,cAAc;IACxBuB,YAAY,GAAG,EAAE;IACjBC,YAAY,GAAGtB;EACjB,CAAC,GAAGgB,OAAO,CAACO,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAC5B,MAAMC,SAAS,GAAGvB,gBAAgB,CAACC,IAAI,CAAC;;EAExC;AACF;AACA;AACA;AACA;EACE,MAAMuB,sBAAsB,GAAGA,CAACC,IAAI,EAAEC,SAAS,GAAG,EAAE,KAAK;IACvD,MAAMC,WAAW,GAAGF,IAAI,CAACG,IAAI,CAAC,CAAC;IAC/B,OAAOjB,OAAO,CAACgB,WAAW,CAAC,IAAI,CAAC,IAAAE,sCAAkB,EAACF,WAAW,EAAE,CAC9DD,SAAS,EAAEH,SAAS,CACrB,CAACb,MAAM,CAACC,OAAO,CAAC,CAACmB,IAAI,CAAC,GAAG,CAAC,EAAE;MAC3BX,OAAO;MACPE;IACF,CAAC,CAAC;EACJ,CAAC;EAED,MAAM;IACJU,WAAW;IACXC;EACF,CAAC,GAAGd,KAAK,CAACe,cAAc,CAAC,CAAC;EAC1B,IAAIC,mBAAmB,GAAG,KAAK;EAE/B,KAAK,MAAMC,GAAG,IAAInB,KAAK,CAACoB,IAAI,EAAE;IAC5B,IAAIhB,YAAY,CAACiB,QAAQ,CAACF,GAAG,CAACA,GAAG,CAAC,EAAE;MAClC;IACF;IAEA,IAAIX,sBAAsB,CAACW,GAAG,CAACJ,WAAW,EAAEI,GAAG,CAAC5B,IAAI,CAAC,EAAE;MACrDW,KAAK,CAACoB,WAAW,CACf,0DAA0D,EAC1DH,GACF,CAAC;IACH;IAEAD,mBAAmB,KAAKC,GAAG,CAACJ,WAAW,KAAKA,WAAW,IACrD;IACCI,GAAG,CAAEI,IAAI,KAAKP,mBAAmB;EACtC;EAEA,IAAI,CAACE,mBAAmB,IAAIV,sBAAsB,CAACO,WAAW,CAAC,EAAE;IAC/Dd,MAAM,CAAC,sDAAsD,CAAC;EAChE;AACF,CAAC,EAAE;EACDuB,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJX,WAAW,EACT,uEAAuE;MACzEY,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACV3B,OAAO,EAAE;UACP4B,iBAAiB,EAAE;YACjB,IAAI,EAAE;cACJC,KAAK,EAAE;gBACL9C,IAAI,EAAE;cACR,CAAC;cACDA,IAAI,EAAE;YACR;UACF;QACF,CAAC;QACDkB,YAAY,EAAE;UACZ4B,KAAK,EAAE;YACL9C,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACDmB,YAAY,EAAE;UACZ2B,KAAK,EAAE;YACL9C,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA+C,MAAA,CAAApC,OAAA,GAAAA,OAAA,CAAAjB,OAAA","ignoreList":[]}
+{"version":3,"file":"informativeDocs.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/informativeDocs.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  areDocsInformative,\n} from 'are-docs-informative';\n\nconst defaultAliases = {\n  a: [\n    'an', 'our',\n  ],\n};\n\nconst defaultUselessWords = [\n  'a', 'an', 'i', 'in', 'of', 's', 'the',\n];\n\n/* eslint-disable complexity -- Temporary */\n\n/**\n * @param {import('eslint').Rule.Node|import('@typescript-eslint/types').TSESTree.Node|null|undefined} node\n * @returns {string[]}\n */\nconst getNamesFromNode = (node) => {\n  switch (node?.type) {\n    case 'AccessorProperty':\n    case 'MethodDefinition':\n    case 'PropertyDefinition':\n    case 'TSAbstractAccessorProperty':\n    case 'TSAbstractMethodDefinition':\n    case 'TSAbstractPropertyDefinition':\n      return [\n        ...getNamesFromNode(\n        /** @type {import('@typescript-eslint/types').TSESTree.Node} */ (\n            node.parent\n          ).parent,\n        ),\n        ...getNamesFromNode(\n        /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n          (node.key),\n        ),\n      ];\n\n    case 'ClassDeclaration':\n    case 'ClassExpression':\n    case 'FunctionDeclaration':\n    case 'FunctionExpression':\n    case 'TSDeclareFunction':\n    case 'TSEnumDeclaration':\n    case 'TSEnumMember':\n    case 'TSInterfaceDeclaration':\n    case 'TSMethodSignature':\n    case 'TSModuleDeclaration':\n    case 'TSTypeAliasDeclaration':\n      return getNamesFromNode(\n      /** @type {import('@typescript-eslint/types').TSESTree.ClassDeclaration} */\n        (node).id,\n      );\n    case 'ExportDefaultDeclaration':\n    case 'ExportNamedDeclaration':\n      return getNamesFromNode(\n      /** @type {import('@typescript-eslint/types').TSESTree.ExportNamedDeclaration} */\n        (node).declaration,\n      );\n    case 'Identifier':\n      return [\n        node.name,\n      ];\n    case 'Property':\n      return getNamesFromNode(\n      /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n        (node.key),\n      );\n    case 'VariableDeclaration':\n      return getNamesFromNode(\n      /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n        (node.declarations[0]),\n      );\n    case 'VariableDeclarator':\n      return [\n        ...getNamesFromNode(\n        /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n          (node.id),\n        ),\n        ...getNamesFromNode(\n        /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n          (node.init),\n        ),\n      ].filter(Boolean);\n    default:\n      return [];\n  }\n};\n/* eslint-enable complexity -- Temporary */\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  node,\n  report,\n  utils,\n}) => {\n  const /** @type {{aliases: {[key: string]: string[]}, excludedTags: string[], uselessWords: string[]}} */ {\n    aliases = defaultAliases,\n    excludedTags = [],\n    uselessWords = defaultUselessWords,\n  } = context.options[0] || {};\n  const nodeNames = getNamesFromNode(node);\n\n  /**\n   * @param {string} text\n   * @param {string} extraName\n   * @returns {boolean}\n   */\n  const descriptionIsRedundant = (text, extraName = '') => {\n    const textTrimmed = text.trim();\n    return Boolean(textTrimmed) && !areDocsInformative(textTrimmed, [\n      extraName, nodeNames,\n    ].filter(Boolean).join(' '), {\n      aliases,\n      uselessWords,\n    });\n  };\n\n  const {\n    description,\n    lastDescriptionLine,\n  } = utils.getDescription();\n  let descriptionReported = false;\n\n  for (const tag of jsdoc.tags) {\n    if (excludedTags.includes(tag.tag)) {\n      continue;\n    }\n\n    if (descriptionIsRedundant(tag.description, tag.name)) {\n      utils.reportJSDoc(\n        'This tag description only repeats the name it describes.',\n        tag,\n      );\n    }\n\n    descriptionReported ||= tag.description === description &&\n      /** @type {import('comment-parser').Spec & {line: import('../iterateJsdoc.js').Integer}} */\n      (tag).line === lastDescriptionLine;\n  }\n\n  if (!descriptionReported && descriptionIsRedundant(description)) {\n    report('This description only repeats the name it describes.');\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description:\n        'This rule reports doc comments that only restate their attached name.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/informative-docs.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          aliases: {\n            patternProperties: {\n              '.*': {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n            },\n          },\n          excludedTags: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          uselessWords: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;AAKA,MAAM,iBAAiB,EACrB,GAAG,CACD,MAAM,KACP,EACF;AAED,MAAM,sBAAsB;CAC1B;CAAK;CAAM;CAAK;CAAM;CAAM;CAAK;AAClC;;;;;AAQD,MAAM,mBAAmB,CAAC,SAAS;AACjC,SAAQ,MAAM,MAAd;EACE,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK,+BACH,QAAO,CACL,GAAG;;GAEC,KAAK,OACL;GACH,EACD,GAAG,iBAEA,KAAK,IACP,AACF;EAEH,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK,yBACH,QAAO;;GAEJ,KAAM;GACR;EACH,KAAK;EACL,KAAK,yBACH,QAAO;;GAEJ,KAAM;GACR;EACH,KAAK,aACH,QAAO,CACL,KAAK,IACN;EACH,KAAK,WACH,QAAO,iBAEJ,KAAK,IACP;EACH,KAAK,sBACH,QAAO,iBAEJ,KAAK,aAAa,GACpB;EACH,KAAK,qBACH,QAAO,CACL,GAAG,iBAEA,KAAK,GACP,EACD,GAAG,iBAEA,KAAK,KACP,AACF,EAAC,OAAO,QAAQ;EACnB,QACE,QAAO,CAAE;CACZ;AACF;AAGD,8BAAeA,6BAAa,CAAC,EAC3B,SACA,OACA,MACA,QACA,OACD,KAAK;CACJ,MAA0G,EACxG,UAAU,gBACV,eAAe,CAAE,GACjB,eAAe,qBAChB,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAC5B,MAAM,YAAY,iBAAiB,KAAK;;;;;;CAOxC,MAAM,yBAAyB,CAAC,MAAM,YAAY,OAAO;EACvD,MAAM,cAAc,KAAK,MAAM;AAC/B,SAAO,QAAQ,YAAY,IAAI,8CAAoB,aAAa,CAC9D,WAAW,SACZ,EAAC,OAAO,QAAQ,CAAC,KAAK,IAAI,EAAE;GAC3B;GACA;EACD,EAAC;CACH;CAED,MAAM,EACJ,aACA,qBACD,GAAG,MAAM,gBAAgB;CAC1B,IAAI,sBAAsB;AAE1B,MAAK,MAAM,OAAO,MAAM,MAAM;AAC5B,MAAI,aAAa,SAAS,IAAI,IAAI,CAChC;AAGF,MAAI,uBAAuB,IAAI,aAAa,IAAI,KAAK,EACnD,MAAM,YACJ,4DACA,IACD;EAGH,wBAAwB,IAAI,gBAAgB,eAEzC,IAAK,SAAS;CAClB;AAED,KAAI,CAAC,uBAAuB,uBAAuB,YAAY,EAC7D,OAAO,uDAAuD;AAEjE,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aACE;GACF,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,SAAS,EACP,mBAAmB,EACjB,MAAM;KACJ,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP,EACF,EACF;IACD,cAAc;KACZ,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,cAAc;KACZ,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/informativeDocs.js

@@ -0,0 +1,110 @@
+import iterateJsdoc from "../iterateJsdoc.js";
+import { areDocsInformative } from "are-docs-informative";
+
+//#region src/rules/informativeDocs.js
+const defaultAliases = { a: ["an", "our"] };
+const defaultUselessWords = [
+	"a",
+	"an",
+	"i",
+	"in",
+	"of",
+	"s",
+	"the"
+];
+/**
+* @param {import('eslint').Rule.Node|import('@typescript-eslint/types').TSESTree.Node|null|undefined} node
+* @returns {string[]}
+*/
+const getNamesFromNode = (node) => {
+	switch (node?.type) {
+		case "AccessorProperty":
+		case "MethodDefinition":
+		case "PropertyDefinition":
+		case "TSAbstractAccessorProperty":
+		case "TSAbstractMethodDefinition":
+		case "TSAbstractPropertyDefinition": return [...getNamesFromNode(
+			/** @type {import('@typescript-eslint/types').TSESTree.Node} */
+			node.parent.parent
+		), ...getNamesFromNode(node.key)];
+		case "ClassDeclaration":
+		case "ClassExpression":
+		case "FunctionDeclaration":
+		case "FunctionExpression":
+		case "TSDeclareFunction":
+		case "TSEnumDeclaration":
+		case "TSEnumMember":
+		case "TSInterfaceDeclaration":
+		case "TSMethodSignature":
+		case "TSModuleDeclaration":
+		case "TSTypeAliasDeclaration": return getNamesFromNode(
+			/** @type {import('@typescript-eslint/types').TSESTree.ClassDeclaration} */
+			node.id
+		);
+		case "ExportDefaultDeclaration":
+		case "ExportNamedDeclaration": return getNamesFromNode(
+			/** @type {import('@typescript-eslint/types').TSESTree.ExportNamedDeclaration} */
+			node.declaration
+		);
+		case "Identifier": return [node.name];
+		case "Property": return getNamesFromNode(node.key);
+		case "VariableDeclaration": return getNamesFromNode(node.declarations[0]);
+		case "VariableDeclarator": return [...getNamesFromNode(node.id), ...getNamesFromNode(node.init)].filter(Boolean);
+		default: return [];
+	}
+};
+var informativeDocs_default = iterateJsdoc(({ context, jsdoc, node, report, utils }) => {
+	const { aliases = defaultAliases, excludedTags = [], uselessWords = defaultUselessWords } = context.options[0] || {};
+	const nodeNames = getNamesFromNode(node);
+	/**
+	* @param {string} text
+	* @param {string} extraName
+	* @returns {boolean}
+	*/
+	const descriptionIsRedundant = (text, extraName = "") => {
+		const textTrimmed = text.trim();
+		return Boolean(textTrimmed) && !areDocsInformative(textTrimmed, [extraName, nodeNames].filter(Boolean).join(" "), {
+			aliases,
+			uselessWords
+		});
+	};
+	const { description, lastDescriptionLine } = utils.getDescription();
+	let descriptionReported = false;
+	for (const tag of jsdoc.tags) {
+		if (excludedTags.includes(tag.tag)) continue;
+		if (descriptionIsRedundant(tag.description, tag.name)) utils.reportJSDoc("This tag description only repeats the name it describes.", tag);
+		descriptionReported ||= tag.description === description && tag.line === lastDescriptionLine;
+	}
+	if (!descriptionReported && descriptionIsRedundant(description)) report("This description only repeats the name it describes.");
+}, {
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "This rule reports doc comments that only restate their attached name.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/informative-docs.md#repos-sticky-header"
+		},
+		schema: [{
+			additionalProperties: false,
+			properties: {
+				aliases: { patternProperties: { ".*": {
+					items: { type: "string" },
+					type: "array"
+				} } },
+				excludedTags: {
+					items: { type: "string" },
+					type: "array"
+				},
+				uselessWords: {
+					items: { type: "string" },
+					type: "array"
+				}
+			},
+			type: "object"
+		}],
+		type: "suggestion"
+	}
+});
+
+//#endregion
+export { informativeDocs_default as default };
+//# sourceMappingURL=informativeDocs.js.map

package/dist/rules/informativeDocs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"informativeDocs.js","names":[],"sources":["../../src/rules/informativeDocs.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  areDocsInformative,\n} from 'are-docs-informative';\n\nconst defaultAliases = {\n  a: [\n    'an', 'our',\n  ],\n};\n\nconst defaultUselessWords = [\n  'a', 'an', 'i', 'in', 'of', 's', 'the',\n];\n\n/* eslint-disable complexity -- Temporary */\n\n/**\n * @param {import('eslint').Rule.Node|import('@typescript-eslint/types').TSESTree.Node|null|undefined} node\n * @returns {string[]}\n */\nconst getNamesFromNode = (node) => {\n  switch (node?.type) {\n    case 'AccessorProperty':\n    case 'MethodDefinition':\n    case 'PropertyDefinition':\n    case 'TSAbstractAccessorProperty':\n    case 'TSAbstractMethodDefinition':\n    case 'TSAbstractPropertyDefinition':\n      return [\n        ...getNamesFromNode(\n        /** @type {import('@typescript-eslint/types').TSESTree.Node} */ (\n            node.parent\n          ).parent,\n        ),\n        ...getNamesFromNode(\n        /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n          (node.key),\n        ),\n      ];\n\n    case 'ClassDeclaration':\n    case 'ClassExpression':\n    case 'FunctionDeclaration':\n    case 'FunctionExpression':\n    case 'TSDeclareFunction':\n    case 'TSEnumDeclaration':\n    case 'TSEnumMember':\n    case 'TSInterfaceDeclaration':\n    case 'TSMethodSignature':\n    case 'TSModuleDeclaration':\n    case 'TSTypeAliasDeclaration':\n      return getNamesFromNode(\n      /** @type {import('@typescript-eslint/types').TSESTree.ClassDeclaration} */\n        (node).id,\n      );\n    case 'ExportDefaultDeclaration':\n    case 'ExportNamedDeclaration':\n      return getNamesFromNode(\n      /** @type {import('@typescript-eslint/types').TSESTree.ExportNamedDeclaration} */\n        (node).declaration,\n      );\n    case 'Identifier':\n      return [\n        node.name,\n      ];\n    case 'Property':\n      return getNamesFromNode(\n      /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n        (node.key),\n      );\n    case 'VariableDeclaration':\n      return getNamesFromNode(\n      /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n        (node.declarations[0]),\n      );\n    case 'VariableDeclarator':\n      return [\n        ...getNamesFromNode(\n        /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n          (node.id),\n        ),\n        ...getNamesFromNode(\n        /** @type {import('@typescript-eslint/types').TSESTree.Node} */\n          (node.init),\n        ),\n      ].filter(Boolean);\n    default:\n      return [];\n  }\n};\n/* eslint-enable complexity -- Temporary */\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  node,\n  report,\n  utils,\n}) => {\n  const /** @type {{aliases: {[key: string]: string[]}, excludedTags: string[], uselessWords: string[]}} */ {\n    aliases = defaultAliases,\n    excludedTags = [],\n    uselessWords = defaultUselessWords,\n  } = context.options[0] || {};\n  const nodeNames = getNamesFromNode(node);\n\n  /**\n   * @param {string} text\n   * @param {string} extraName\n   * @returns {boolean}\n   */\n  const descriptionIsRedundant = (text, extraName = '') => {\n    const textTrimmed = text.trim();\n    return Boolean(textTrimmed) && !areDocsInformative(textTrimmed, [\n      extraName, nodeNames,\n    ].filter(Boolean).join(' '), {\n      aliases,\n      uselessWords,\n    });\n  };\n\n  const {\n    description,\n    lastDescriptionLine,\n  } = utils.getDescription();\n  let descriptionReported = false;\n\n  for (const tag of jsdoc.tags) {\n    if (excludedTags.includes(tag.tag)) {\n      continue;\n    }\n\n    if (descriptionIsRedundant(tag.description, tag.name)) {\n      utils.reportJSDoc(\n        'This tag description only repeats the name it describes.',\n        tag,\n      );\n    }\n\n    descriptionReported ||= tag.description === description &&\n      /** @type {import('comment-parser').Spec & {line: import('../iterateJsdoc.js').Integer}} */\n      (tag).line === lastDescriptionLine;\n  }\n\n  if (!descriptionReported && descriptionIsRedundant(description)) {\n    report('This description only repeats the name it describes.');\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description:\n        'This rule reports doc comments that only restate their attached name.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/informative-docs.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          aliases: {\n            patternProperties: {\n              '.*': {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n            },\n          },\n          excludedTags: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          uselessWords: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;AAKA,MAAM,iBAAiB,EACrB,GAAG,CACD,MAAM,KACP,EACF;AAED,MAAM,sBAAsB;CAC1B;CAAK;CAAM;CAAK;CAAM;CAAM;CAAK;AAClC;;;;;AAQD,MAAM,mBAAmB,CAAC,SAAS;AACjC,SAAQ,MAAM,MAAd;EACE,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK,+BACH,QAAO,CACL,GAAG;;GAEC,KAAK,OACL;GACH,EACD,GAAG,iBAEA,KAAK,IACP,AACF;EAEH,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK,yBACH,QAAO;;GAEJ,KAAM;GACR;EACH,KAAK;EACL,KAAK,yBACH,QAAO;;GAEJ,KAAM;GACR;EACH,KAAK,aACH,QAAO,CACL,KAAK,IACN;EACH,KAAK,WACH,QAAO,iBAEJ,KAAK,IACP;EACH,KAAK,sBACH,QAAO,iBAEJ,KAAK,aAAa,GACpB;EACH,KAAK,qBACH,QAAO,CACL,GAAG,iBAEA,KAAK,GACP,EACD,GAAG,iBAEA,KAAK,KACP,AACF,EAAC,OAAO,QAAQ;EACnB,QACE,QAAO,CAAE;CACZ;AACF;AAGD,8BAAe,aAAa,CAAC,EAC3B,SACA,OACA,MACA,QACA,OACD,KAAK;CACJ,MAA0G,EACxG,UAAU,gBACV,eAAe,CAAE,GACjB,eAAe,qBAChB,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAC5B,MAAM,YAAY,iBAAiB,KAAK;;;;;;CAOxC,MAAM,yBAAyB,CAAC,MAAM,YAAY,OAAO;EACvD,MAAM,cAAc,KAAK,MAAM;AAC/B,SAAO,QAAQ,YAAY,IAAI,CAAC,mBAAmB,aAAa,CAC9D,WAAW,SACZ,EAAC,OAAO,QAAQ,CAAC,KAAK,IAAI,EAAE;GAC3B;GACA;EACD,EAAC;CACH;CAED,MAAM,EACJ,aACA,qBACD,GAAG,MAAM,gBAAgB;CAC1B,IAAI,sBAAsB;AAE1B,MAAK,MAAM,OAAO,MAAM,MAAM;AAC5B,MAAI,aAAa,SAAS,IAAI,IAAI,CAChC;AAGF,MAAI,uBAAuB,IAAI,aAAa,IAAI,KAAK,EACnD,MAAM,YACJ,4DACA,IACD;EAGH,wBAAwB,IAAI,gBAAgB,eAEzC,IAAK,SAAS;CAClB;AAED,KAAI,CAAC,uBAAuB,uBAAuB,YAAY,EAC7D,OAAO,uDAAuD;AAEjE,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aACE;GACF,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,SAAS,EACP,mBAAmB,EACjB,MAAM;KACJ,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP,EACF,EACF;IACD,cAAc;KACZ,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,cAAc;KACZ,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/linesBeforeBlock.cjs

@@ -1,110 +1,75 @@
-"use strict";
+const require_iterateJsdoc = require('../iterateJsdoc.cjs');
 
-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 }; }
+//#region src/rules/linesBeforeBlock.js
 /**
- * Punctuators that begin a logical group should not require a line before it skipped. Specifically
- * `[` starts an array, `{` starts an object or block, `(` starts a grouping, and `=` starts a
- * declaration (like a variable or a type alias).
- */
-const startPunctuators = new Set(['(', '=', '[', '{']);
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  context,
-  jsdocNode,
-  report,
-  sourceCode,
-  utils
-}) => {
-  const {
-    checkBlockStarts,
-    excludedTags = ['type'],
-    ignoreSameLine = true,
-    ignoreSingleLines = true,
-    lines = 1
-  } = context.options[0] || {};
-  if (utils.hasATag(excludedTags)) {
-    return;
-  }
-  const tokensBefore = sourceCode.getTokensBefore(jsdocNode, {
-    includeComments: true
-  });
-  const tokenBefore = tokensBefore.at(-1);
-  if (!tokenBefore || tokenBefore.type === 'Punctuator' && !checkBlockStarts && startPunctuators.has(tokenBefore.value)) {
-    return;
-  }
-  if (tokenBefore.loc?.end?.line + lines >= (/** @type {number} */
-  jsdocNode.loc?.start?.line)) {
-    const startLine = jsdocNode.loc?.start?.line;
-    const sameLine = tokenBefore.loc?.end?.line === startLine;
-    if (sameLine && ignoreSameLine) {
-      return;
-    }
-    if (ignoreSingleLines && jsdocNode.loc?.start.line === jsdocNode.loc?.end.line) {
-      return;
-    }
-
-    /** @type {import('eslint').Rule.ReportFixer} */
-    const fix = fixer => {
-      let indent = '';
-      if (sameLine) {
-        const spaceDiff = /** @type {number} */jsdocNode.loc?.start?.column - (/** @type {number} */tokenBefore.loc?.end?.column);
-        // @ts-expect-error Should be a comment
-        indent = /** @type {import('estree').Comment} */jsdocNode.value.match(/^\*\n([\t ]*) \*/v)?.[1]?.slice(spaceDiff);
-        if (!indent) {
-          /** @type {import('eslint').AST.Token|import('estree').Comment|undefined} */
-          let tokenPrior = tokenBefore;
-          let startColumn;
-          while (tokenPrior && tokenPrior?.loc?.start?.line === startLine) {
-            startColumn = tokenPrior.loc?.start?.column;
-            tokenPrior = tokensBefore.pop();
-          }
-          indent = ' '.repeat(/* c8 ignore next */
-          /** @type {number} */startColumn ? startColumn - 1 : 0);
-        }
-      }
-      return fixer.insertTextAfter(/** @type {import('eslint').AST.Token} */
-      tokenBefore, '\n'.repeat(lines) + (sameLine ? '\n' + indent : ''));
-    };
-    report(`Required ${lines} line(s) before JSDoc block`, fix);
-  }
+* Punctuators that begin a logical group should not require a line before it skipped. Specifically
+* `[` starts an array, `{` starts an object or block, `(` starts a grouping, and `=` starts a
+* declaration (like a variable or a type alias).
+*/
+const startPunctuators = new Set([
+	"(",
+	"=",
+	"[",
+	"{"
+]);
+var linesBeforeBlock_default = require_iterateJsdoc.default(({ context, jsdocNode, report, sourceCode, utils }) => {
+	const { checkBlockStarts, excludedTags = ["type"], ignoreSameLine = true, ignoreSingleLines = true, lines = 1 } = context.options[0] || {};
+	if (utils.hasATag(excludedTags)) return;
+	const tokensBefore = sourceCode.getTokensBefore(jsdocNode, { includeComments: true });
+	const tokenBefore = tokensBefore.at(-1);
+	if (!tokenBefore || tokenBefore.type === "Punctuator" && !checkBlockStarts && startPunctuators.has(tokenBefore.value)) return;
+	if (tokenBefore.loc?.end?.line + lines >= jsdocNode.loc?.start?.line) {
+		const startLine = jsdocNode.loc?.start?.line;
+		const sameLine = tokenBefore.loc?.end?.line === startLine;
+		if (sameLine && ignoreSameLine) return;
+		if (ignoreSingleLines && jsdocNode.loc?.start.line === jsdocNode.loc?.end.line) return;
+		/** @type {import('eslint').Rule.ReportFixer} */
+		const fix = (fixer) => {
+			let indent = "";
+			if (sameLine) {
+				const spaceDiff = jsdocNode.loc?.start?.column - tokenBefore.loc?.end?.column;
+				indent = jsdocNode.value.match(/^\*\n([\t ]*) \*/v)?.[1]?.slice(spaceDiff);
+				if (!indent) {
+					/** @type {import('eslint').AST.Token|import('estree').Comment|undefined} */
+					let tokenPrior = tokenBefore;
+					let startColumn;
+					while (tokenPrior && tokenPrior?.loc?.start?.line === startLine) {
+						startColumn = tokenPrior.loc?.start?.column;
+						tokenPrior = tokensBefore.pop();
+					}
+					indent = " ".repeat(startColumn ? startColumn - 1 : 0);
+				}
+			}
+			return fixer.insertTextAfter(tokenBefore, "\n".repeat(lines) + (sameLine ? "\n" + indent : ""));
+		};
+		report(`Required ${lines} line(s) before JSDoc block`, fix);
+	}
 }, {
-  iterateAllJsdocs: true,
-  meta: {
-    docs: {
-      description: 'Enforces minimum number of newlines before JSDoc comment blocks',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/lines-before-block.md#repos-sticky-header'
-    },
-    fixable: 'code',
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        checkBlockStarts: {
-          type: 'boolean'
-        },
-        excludedTags: {
-          items: {
-            type: 'string'
-          },
-          type: 'array'
-        },
-        ignoreSameLine: {
-          type: 'boolean'
-        },
-        ignoreSingleLines: {
-          type: 'boolean'
-        },
-        lines: {
-          type: 'integer'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'suggestion'
-  }
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "Enforces minimum number of newlines before JSDoc comment blocks",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/lines-before-block.md#repos-sticky-header"
+		},
+		fixable: "code",
+		schema: [{
+			additionalProperties: false,
+			properties: {
+				checkBlockStarts: { type: "boolean" },
+				excludedTags: {
+					items: { type: "string" },
+					type: "array"
+				},
+				ignoreSameLine: { type: "boolean" },
+				ignoreSingleLines: { type: "boolean" },
+				lines: { type: "integer" }
+			},
+			type: "object"
+		}],
+		type: "suggestion"
+	}
 });
-module.exports = exports.default;
+
+//#endregion
+exports.default = linesBeforeBlock_default;
 //# sourceMappingURL=linesBeforeBlock.cjs.map

package/dist/rules/linesBeforeBlock.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"linesBeforeBlock.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","startPunctuators","Set","_default","exports","iterateJsdoc","context","jsdocNode","report","sourceCode","utils","checkBlockStarts","excludedTags","ignoreSameLine","ignoreSingleLines","lines","options","hasATag","tokensBefore","getTokensBefore","includeComments","tokenBefore","at","type","has","value","loc","end","line","start","startLine","sameLine","fix","fixer","indent","spaceDiff","column","match","slice","tokenPrior","startColumn","pop","repeat","insertTextAfter","iterateAllJsdocs","meta","docs","description","url","fixable","schema","additionalProperties","properties","items","module"],"sources":["../../src/rules/linesBeforeBlock.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * Punctuators that begin a logical group should not require a line before it skipped. Specifically\n * `[` starts an array, `{` starts an object or block, `(` starts a grouping, and `=` starts a\n * declaration (like a variable or a type alias).\n */\nconst startPunctuators = new Set([\n  '(', '=', '[', '{',\n]);\n\nexport default iterateJsdoc(({\n  context,\n  jsdocNode,\n  report,\n  sourceCode,\n  utils,\n}) => {\n  const {\n    checkBlockStarts,\n    excludedTags = [\n      'type',\n    ],\n    ignoreSameLine = true,\n    ignoreSingleLines = true,\n    lines = 1,\n  } = context.options[0] || {};\n\n  if (utils.hasATag(excludedTags)) {\n    return;\n  }\n\n  const tokensBefore = sourceCode.getTokensBefore(jsdocNode, {\n    includeComments: true,\n  });\n  const tokenBefore = tokensBefore.at(-1);\n  if (\n    !tokenBefore || (\n      tokenBefore.type === 'Punctuator' &&\n      !checkBlockStarts &&\n      startPunctuators.has(tokenBefore.value)\n    )\n  ) {\n    return;\n  }\n\n  if (tokenBefore.loc?.end?.line + lines >=\n  /** @type {number} */\n      (jsdocNode.loc?.start?.line)\n  ) {\n    const startLine = jsdocNode.loc?.start?.line;\n    const sameLine = tokenBefore.loc?.end?.line === startLine;\n\n    if (sameLine && ignoreSameLine) {\n      return;\n    }\n\n    if (ignoreSingleLines && jsdocNode.loc?.start.line === jsdocNode.loc?.end.line) {\n      return;\n    }\n\n    /** @type {import('eslint').Rule.ReportFixer} */\n    const fix = (fixer) => {\n      let indent = '';\n      if (sameLine) {\n        const spaceDiff = /** @type {number} */ (jsdocNode.loc?.start?.column) -\n        /** @type {number} */ (tokenBefore.loc?.end?.column);\n        // @ts-expect-error Should be a comment\n        indent = /** @type {import('estree').Comment} */ (\n          jsdocNode\n        ).value.match(/^\\*\\n([\\t ]*) \\*/v)?.[1]?.slice(spaceDiff);\n        if (!indent) {\n          /** @type {import('eslint').AST.Token|import('estree').Comment|undefined} */\n          let tokenPrior = tokenBefore;\n          let startColumn;\n          while (tokenPrior && tokenPrior?.loc?.start?.line === startLine) {\n            startColumn = tokenPrior.loc?.start?.column;\n            tokenPrior = tokensBefore.pop();\n          }\n\n          indent = ' '.repeat(\n            /* c8 ignore next */\n            /** @type {number} */ (startColumn ? startColumn - 1 : 0),\n          );\n        }\n      }\n\n      return fixer.insertTextAfter(\n        /** @type {import('eslint').AST.Token} */\n        (tokenBefore),\n        '\\n'.repeat(lines) +\n        (sameLine ? '\\n' + indent : ''),\n      );\n    };\n\n    report(`Required ${lines} line(s) before JSDoc block`, fix);\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Enforces minimum number of newlines before JSDoc comment blocks',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/lines-before-block.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          checkBlockStarts: {\n            type: 'boolean',\n          },\n          excludedTags: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          ignoreSameLine: {\n            type: 'boolean',\n          },\n          ignoreSingleLines: {\n            type: 'boolean',\n          },\n          lines: {\n            type: 'integer',\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,MAAMG,gBAAgB,GAAG,IAAIC,GAAG,CAAC,CAC/B,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CACnB,CAAC;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAJ,OAAA,GAEY,IAAAK,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,SAAS;EACTC,MAAM;EACNC,UAAU;EACVC;AACF,CAAC,KAAK;EACJ,MAAM;IACJC,gBAAgB;IAChBC,YAAY,GAAG,CACb,MAAM,CACP;IACDC,cAAc,GAAG,IAAI;IACrBC,iBAAiB,GAAG,IAAI;IACxBC,KAAK,GAAG;EACV,CAAC,GAAGT,OAAO,CAACU,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,IAAIN,KAAK,CAACO,OAAO,CAACL,YAAY,CAAC,EAAE;IAC/B;EACF;EAEA,MAAMM,YAAY,GAAGT,UAAU,CAACU,eAAe,CAACZ,SAAS,EAAE;IACzDa,eAAe,EAAE;EACnB,CAAC,CAAC;EACF,MAAMC,WAAW,GAAGH,YAAY,CAACI,EAAE,CAAC,CAAC,CAAC,CAAC;EACvC,IACE,CAACD,WAAW,IACVA,WAAW,CAACE,IAAI,KAAK,YAAY,IACjC,CAACZ,gBAAgB,IACjBV,gBAAgB,CAACuB,GAAG,CAACH,WAAW,CAACI,KAAK,CACvC,EACD;IACA;EACF;EAEA,IAAIJ,WAAW,CAACK,GAAG,EAAEC,GAAG,EAAEC,IAAI,GAAGb,KAAK,KACtC;EACKR,SAAS,CAACmB,GAAG,EAAEG,KAAK,EAAED,IAAI,CAAC,EAC9B;IACA,MAAME,SAAS,GAAGvB,SAAS,CAACmB,GAAG,EAAEG,KAAK,EAAED,IAAI;IAC5C,MAAMG,QAAQ,GAAGV,WAAW,CAACK,GAAG,EAAEC,GAAG,EAAEC,IAAI,KAAKE,SAAS;IAEzD,IAAIC,QAAQ,IAAIlB,cAAc,EAAE;MAC9B;IACF;IAEA,IAAIC,iBAAiB,IAAIP,SAAS,CAACmB,GAAG,EAAEG,KAAK,CAACD,IAAI,KAAKrB,SAAS,CAACmB,GAAG,EAAEC,GAAG,CAACC,IAAI,EAAE;MAC9E;IACF;;IAEA;IACA,MAAMI,GAAG,GAAIC,KAAK,IAAK;MACrB,IAAIC,MAAM,GAAG,EAAE;MACf,IAAIH,QAAQ,EAAE;QACZ,MAAMI,SAAS,GAAG,qBAAuB5B,SAAS,CAACmB,GAAG,EAAEG,KAAK,EAAEO,MAAM,IACrE,qBAAuBf,WAAW,CAACK,GAAG,EAAEC,GAAG,EAAES,MAAM,CAAC;QACpD;QACAF,MAAM,GAAG,uCACP3B,SAAS,CACTkB,KAAK,CAACY,KAAK,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,EAAEC,KAAK,CAACH,SAAS,CAAC;QACzD,IAAI,CAACD,MAAM,EAAE;UACX;UACA,IAAIK,UAAU,GAAGlB,WAAW;UAC5B,IAAImB,WAAW;UACf,OAAOD,UAAU,IAAIA,UAAU,EAAEb,GAAG,EAAEG,KAAK,EAAED,IAAI,KAAKE,SAAS,EAAE;YAC/DU,WAAW,GAAGD,UAAU,CAACb,GAAG,EAAEG,KAAK,EAAEO,MAAM;YAC3CG,UAAU,GAAGrB,YAAY,CAACuB,GAAG,CAAC,CAAC;UACjC;UAEAP,MAAM,GAAG,GAAG,CAACQ,MAAM,CACjB;UACA,qBAAuBF,WAAW,GAAGA,WAAW,GAAG,CAAC,GAAG,CACzD,CAAC;QACH;MACF;MAEA,OAAOP,KAAK,CAACU,eAAe,CAC1B;MACCtB,WAAW,EACZ,IAAI,CAACqB,MAAM,CAAC3B,KAAK,CAAC,IACjBgB,QAAQ,GAAG,IAAI,GAAGG,MAAM,GAAG,EAAE,CAChC,CAAC;IACH,CAAC;IAED1B,MAAM,CAAC,YAAYO,KAAK,6BAA6B,EAAEiB,GAAG,CAAC;EAC7D;AACF,CAAC,EAAE;EACDY,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,iEAAiE;MAC9EC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVzC,gBAAgB,EAAE;UAChBY,IAAI,EAAE;QACR,CAAC;QACDX,YAAY,EAAE;UACZyC,KAAK,EAAE;YACL9B,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACDV,cAAc,EAAE;UACdU,IAAI,EAAE;QACR,CAAC;QACDT,iBAAiB,EAAE;UACjBS,IAAI,EAAE;QACR,CAAC;QACDR,KAAK,EAAE;UACLQ,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA+B,MAAA,CAAAlD,OAAA,GAAAA,OAAA,CAAAJ,OAAA","ignoreList":[]}
+{"version":3,"file":"linesBeforeBlock.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/linesBeforeBlock.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * Punctuators that begin a logical group should not require a line before it skipped. Specifically\n * `[` starts an array, `{` starts an object or block, `(` starts a grouping, and `=` starts a\n * declaration (like a variable or a type alias).\n */\nconst startPunctuators = new Set([\n  '(', '=', '[', '{',\n]);\n\nexport default iterateJsdoc(({\n  context,\n  jsdocNode,\n  report,\n  sourceCode,\n  utils,\n}) => {\n  const {\n    checkBlockStarts,\n    excludedTags = [\n      'type',\n    ],\n    ignoreSameLine = true,\n    ignoreSingleLines = true,\n    lines = 1,\n  } = context.options[0] || {};\n\n  if (utils.hasATag(excludedTags)) {\n    return;\n  }\n\n  const tokensBefore = sourceCode.getTokensBefore(jsdocNode, {\n    includeComments: true,\n  });\n  const tokenBefore = tokensBefore.at(-1);\n  if (\n    !tokenBefore || (\n      tokenBefore.type === 'Punctuator' &&\n      !checkBlockStarts &&\n      startPunctuators.has(tokenBefore.value)\n    )\n  ) {\n    return;\n  }\n\n  if (tokenBefore.loc?.end?.line + lines >=\n  /** @type {number} */\n      (jsdocNode.loc?.start?.line)\n  ) {\n    const startLine = jsdocNode.loc?.start?.line;\n    const sameLine = tokenBefore.loc?.end?.line === startLine;\n\n    if (sameLine && ignoreSameLine) {\n      return;\n    }\n\n    if (ignoreSingleLines && jsdocNode.loc?.start.line === jsdocNode.loc?.end.line) {\n      return;\n    }\n\n    /** @type {import('eslint').Rule.ReportFixer} */\n    const fix = (fixer) => {\n      let indent = '';\n      if (sameLine) {\n        const spaceDiff = /** @type {number} */ (jsdocNode.loc?.start?.column) -\n        /** @type {number} */ (tokenBefore.loc?.end?.column);\n        // @ts-expect-error Should be a comment\n        indent = /** @type {import('estree').Comment} */ (\n          jsdocNode\n        ).value.match(/^\\*\\n([\\t ]*) \\*/v)?.[1]?.slice(spaceDiff);\n        if (!indent) {\n          /** @type {import('eslint').AST.Token|import('estree').Comment|undefined} */\n          let tokenPrior = tokenBefore;\n          let startColumn;\n          while (tokenPrior && tokenPrior?.loc?.start?.line === startLine) {\n            startColumn = tokenPrior.loc?.start?.column;\n            tokenPrior = tokensBefore.pop();\n          }\n\n          indent = ' '.repeat(\n            /* c8 ignore next */\n            /** @type {number} */ (startColumn ? startColumn - 1 : 0),\n          );\n        }\n      }\n\n      return fixer.insertTextAfter(\n        /** @type {import('eslint').AST.Token} */\n        (tokenBefore),\n        '\\n'.repeat(lines) +\n        (sameLine ? '\\n' + indent : ''),\n      );\n    };\n\n    report(`Required ${lines} line(s) before JSDoc block`, fix);\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Enforces minimum number of newlines before JSDoc comment blocks',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/lines-before-block.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          checkBlockStarts: {\n            type: 'boolean',\n          },\n          excludedTags: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          ignoreSameLine: {\n            type: 'boolean',\n          },\n          ignoreSingleLines: {\n            type: 'boolean',\n          },\n          lines: {\n            type: 'integer',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;AAOA,MAAM,mBAAmB,IAAI,IAAI;CAC/B;CAAK;CAAK;CAAK;AAChB;AAED,+BAAeA,6BAAa,CAAC,EAC3B,SACA,WACA,QACA,YACA,OACD,KAAK;CACJ,MAAM,EACJ,kBACA,eAAe,CACb,MACD,GACD,iBAAiB,MACjB,oBAAoB,MACpB,QAAQ,GACT,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAE5B,KAAI,MAAM,QAAQ,aAAa,CAC7B;CAGF,MAAM,eAAe,WAAW,gBAAgB,WAAW,EACzD,iBAAiB,KAClB,EAAC;CACF,MAAM,cAAc,aAAa,GAAG,GAAG;AACvC,KACE,CAAC,eACC,YAAY,SAAS,gBACrB,CAAC,oBACD,iBAAiB,IAAI,YAAY,MAAM,CAGzC;AAGF,KAAI,YAAY,KAAK,KAAK,OAAO,SAE5B,UAAU,KAAK,OAAO,MACzB;EACA,MAAM,YAAY,UAAU,KAAK,OAAO;EACxC,MAAM,WAAW,YAAY,KAAK,KAAK,SAAS;AAEhD,MAAI,YAAY,eACd;AAGF,MAAI,qBAAqB,UAAU,KAAK,MAAM,SAAS,UAAU,KAAK,IAAI,KACxE;;EAIF,MAAM,MAAM,CAAC,UAAU;GACrB,IAAI,SAAS;AACb,OAAI,UAAU;IACZ,MAAM,YAAmC,UAAU,KAAK,OAAO,SACxC,YAAY,KAAK,KAAK;IAE7C,SACE,UACA,MAAM,MAAM,oBAAoB,GAAG,IAAI,MAAM,UAAU;AACzD,QAAI,CAAC,QAAQ;;KAEX,IAAI,aAAa;KACjB,IAAI;AACJ,YAAO,cAAc,YAAY,KAAK,OAAO,SAAS,WAAW;MAC/D,cAAc,WAAW,KAAK,OAAO;MACrC,aAAa,aAAa,KAAK;KAChC;KAED,SAAS,IAAI,OAEY,cAAc,cAAc,IAAI,EACxD;IACF;GACF;AAED,UAAO,MAAM,gBAEV,aACD,KAAK,OAAO,MAAM,IACjB,WAAW,OAAO,SAAS,IAC7B;EACF;EAED,OAAO,CAAC,SAAS,EAAE,MAAM,2BAA2B,CAAC,EAAE,IAAI;CAC5D;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,kBAAkB,EAChB,MAAM,UACP;IACD,cAAc;KACZ,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,gBAAgB,EACd,MAAM,UACP;IACD,mBAAmB,EACjB,MAAM,UACP;IACD,OAAO,EACL,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/linesBeforeBlock.js

@@ -0,0 +1,75 @@
+import iterateJsdoc from "../iterateJsdoc.js";
+
+//#region src/rules/linesBeforeBlock.js
+/**
+* Punctuators that begin a logical group should not require a line before it skipped. Specifically
+* `[` starts an array, `{` starts an object or block, `(` starts a grouping, and `=` starts a
+* declaration (like a variable or a type alias).
+*/
+const startPunctuators = new Set([
+	"(",
+	"=",
+	"[",
+	"{"
+]);
+var linesBeforeBlock_default = iterateJsdoc(({ context, jsdocNode, report, sourceCode, utils }) => {
+	const { checkBlockStarts, excludedTags = ["type"], ignoreSameLine = true, ignoreSingleLines = true, lines = 1 } = context.options[0] || {};
+	if (utils.hasATag(excludedTags)) return;
+	const tokensBefore = sourceCode.getTokensBefore(jsdocNode, { includeComments: true });
+	const tokenBefore = tokensBefore.at(-1);
+	if (!tokenBefore || tokenBefore.type === "Punctuator" && !checkBlockStarts && startPunctuators.has(tokenBefore.value)) return;
+	if (tokenBefore.loc?.end?.line + lines >= jsdocNode.loc?.start?.line) {
+		const startLine = jsdocNode.loc?.start?.line;
+		const sameLine = tokenBefore.loc?.end?.line === startLine;
+		if (sameLine && ignoreSameLine) return;
+		if (ignoreSingleLines && jsdocNode.loc?.start.line === jsdocNode.loc?.end.line) return;
+		/** @type {import('eslint').Rule.ReportFixer} */
+		const fix = (fixer) => {
+			let indent = "";
+			if (sameLine) {
+				const spaceDiff = jsdocNode.loc?.start?.column - tokenBefore.loc?.end?.column;
+				indent = jsdocNode.value.match(/^\*\n([\t ]*) \*/v)?.[1]?.slice(spaceDiff);
+				if (!indent) {
+					/** @type {import('eslint').AST.Token|import('estree').Comment|undefined} */
+					let tokenPrior = tokenBefore;
+					let startColumn;
+					while (tokenPrior && tokenPrior?.loc?.start?.line === startLine) {
+						startColumn = tokenPrior.loc?.start?.column;
+						tokenPrior = tokensBefore.pop();
+					}
+					indent = " ".repeat(startColumn ? startColumn - 1 : 0);
+				}
+			}
+			return fixer.insertTextAfter(tokenBefore, "\n".repeat(lines) + (sameLine ? "\n" + indent : ""));
+		};
+		report(`Required ${lines} line(s) before JSDoc block`, fix);
+	}
+}, {
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "Enforces minimum number of newlines before JSDoc comment blocks",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/lines-before-block.md#repos-sticky-header"
+		},
+		fixable: "code",
+		schema: [{
+			additionalProperties: false,
+			properties: {
+				checkBlockStarts: { type: "boolean" },
+				excludedTags: {
+					items: { type: "string" },
+					type: "array"
+				},
+				ignoreSameLine: { type: "boolean" },
+				ignoreSingleLines: { type: "boolean" },
+				lines: { type: "integer" }
+			},
+			type: "object"
+		}],
+		type: "suggestion"
+	}
+});
+
+//#endregion
+export { linesBeforeBlock_default as default };
+//# sourceMappingURL=linesBeforeBlock.js.map

package/dist/rules/linesBeforeBlock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"linesBeforeBlock.js","names":[],"sources":["../../src/rules/linesBeforeBlock.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * Punctuators that begin a logical group should not require a line before it skipped. Specifically\n * `[` starts an array, `{` starts an object or block, `(` starts a grouping, and `=` starts a\n * declaration (like a variable or a type alias).\n */\nconst startPunctuators = new Set([\n  '(', '=', '[', '{',\n]);\n\nexport default iterateJsdoc(({\n  context,\n  jsdocNode,\n  report,\n  sourceCode,\n  utils,\n}) => {\n  const {\n    checkBlockStarts,\n    excludedTags = [\n      'type',\n    ],\n    ignoreSameLine = true,\n    ignoreSingleLines = true,\n    lines = 1,\n  } = context.options[0] || {};\n\n  if (utils.hasATag(excludedTags)) {\n    return;\n  }\n\n  const tokensBefore = sourceCode.getTokensBefore(jsdocNode, {\n    includeComments: true,\n  });\n  const tokenBefore = tokensBefore.at(-1);\n  if (\n    !tokenBefore || (\n      tokenBefore.type === 'Punctuator' &&\n      !checkBlockStarts &&\n      startPunctuators.has(tokenBefore.value)\n    )\n  ) {\n    return;\n  }\n\n  if (tokenBefore.loc?.end?.line + lines >=\n  /** @type {number} */\n      (jsdocNode.loc?.start?.line)\n  ) {\n    const startLine = jsdocNode.loc?.start?.line;\n    const sameLine = tokenBefore.loc?.end?.line === startLine;\n\n    if (sameLine && ignoreSameLine) {\n      return;\n    }\n\n    if (ignoreSingleLines && jsdocNode.loc?.start.line === jsdocNode.loc?.end.line) {\n      return;\n    }\n\n    /** @type {import('eslint').Rule.ReportFixer} */\n    const fix = (fixer) => {\n      let indent = '';\n      if (sameLine) {\n        const spaceDiff = /** @type {number} */ (jsdocNode.loc?.start?.column) -\n        /** @type {number} */ (tokenBefore.loc?.end?.column);\n        // @ts-expect-error Should be a comment\n        indent = /** @type {import('estree').Comment} */ (\n          jsdocNode\n        ).value.match(/^\\*\\n([\\t ]*) \\*/v)?.[1]?.slice(spaceDiff);\n        if (!indent) {\n          /** @type {import('eslint').AST.Token|import('estree').Comment|undefined} */\n          let tokenPrior = tokenBefore;\n          let startColumn;\n          while (tokenPrior && tokenPrior?.loc?.start?.line === startLine) {\n            startColumn = tokenPrior.loc?.start?.column;\n            tokenPrior = tokensBefore.pop();\n          }\n\n          indent = ' '.repeat(\n            /* c8 ignore next */\n            /** @type {number} */ (startColumn ? startColumn - 1 : 0),\n          );\n        }\n      }\n\n      return fixer.insertTextAfter(\n        /** @type {import('eslint').AST.Token} */\n        (tokenBefore),\n        '\\n'.repeat(lines) +\n        (sameLine ? '\\n' + indent : ''),\n      );\n    };\n\n    report(`Required ${lines} line(s) before JSDoc block`, fix);\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Enforces minimum number of newlines before JSDoc comment blocks',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/lines-before-block.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          checkBlockStarts: {\n            type: 'boolean',\n          },\n          excludedTags: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          ignoreSameLine: {\n            type: 'boolean',\n          },\n          ignoreSingleLines: {\n            type: 'boolean',\n          },\n          lines: {\n            type: 'integer',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;AAOA,MAAM,mBAAmB,IAAI,IAAI;CAC/B;CAAK;CAAK;CAAK;AAChB;AAED,+BAAe,aAAa,CAAC,EAC3B,SACA,WACA,QACA,YACA,OACD,KAAK;CACJ,MAAM,EACJ,kBACA,eAAe,CACb,MACD,GACD,iBAAiB,MACjB,oBAAoB,MACpB,QAAQ,GACT,GAAG,QAAQ,QAAQ,MAAM,CAAE;AAE5B,KAAI,MAAM,QAAQ,aAAa,CAC7B;CAGF,MAAM,eAAe,WAAW,gBAAgB,WAAW,EACzD,iBAAiB,KAClB,EAAC;CACF,MAAM,cAAc,aAAa,GAAG,GAAG;AACvC,KACE,CAAC,eACC,YAAY,SAAS,gBACrB,CAAC,oBACD,iBAAiB,IAAI,YAAY,MAAM,CAGzC;AAGF,KAAI,YAAY,KAAK,KAAK,OAAO,SAE5B,UAAU,KAAK,OAAO,MACzB;EACA,MAAM,YAAY,UAAU,KAAK,OAAO;EACxC,MAAM,WAAW,YAAY,KAAK,KAAK,SAAS;AAEhD,MAAI,YAAY,eACd;AAGF,MAAI,qBAAqB,UAAU,KAAK,MAAM,SAAS,UAAU,KAAK,IAAI,KACxE;;EAIF,MAAM,MAAM,CAAC,UAAU;GACrB,IAAI,SAAS;AACb,OAAI,UAAU;IACZ,MAAM,YAAmC,UAAU,KAAK,OAAO,SACxC,YAAY,KAAK,KAAK;IAE7C,SACE,UACA,MAAM,MAAM,oBAAoB,GAAG,IAAI,MAAM,UAAU;AACzD,QAAI,CAAC,QAAQ;;KAEX,IAAI,aAAa;KACjB,IAAI;AACJ,YAAO,cAAc,YAAY,KAAK,OAAO,SAAS,WAAW;MAC/D,cAAc,WAAW,KAAK,OAAO;MACrC,aAAa,aAAa,KAAK;KAChC;KAED,SAAS,IAAI,OAEY,cAAc,cAAc,IAAI,EACxD;IACF;GACF;AAED,UAAO,MAAM,gBAEV,aACD,KAAK,OAAO,MAAM,IACjB,WAAW,OAAO,SAAS,IAC7B;EACF;EAED,OAAO,CAAC,SAAS,EAAE,MAAM,2BAA2B,CAAC,EAAE,IAAI;CAC5D;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,kBAAkB,EAChB,MAAM,UACP;IACD,cAAc;KACZ,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,gBAAgB,EACd,MAAM,UACP;IACD,mBAAmB,EACjB,MAAM,UACP;IACD,OAAO,EACL,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}