eslint-plugin-jsdoc 63.3.2 → 64.0.0

package/dist/rules/informativeDocs.cjs

@@ -1,187 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-var _areDocsInformative = require("are-docs-informative");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-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(/** @type {import('@typescript-eslint/types').TSESTree.Node} */
-      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(/** @type {import('@typescript-eslint/types').TSESTree.Node} */
-      node.key);
-    case 'VariableDeclaration':
-      return getNamesFromNode(/** @type {import('@typescript-eslint/types').TSESTree.Node} */
-      node.declarations[0]);
-    case 'VariableDeclarator':
-      return [...getNamesFromNode(/** @type {import('@typescript-eslint/types').TSESTree.Node} */
-      node.id), ...getNamesFromNode(/** @type {import('@typescript-eslint/types').TSESTree.Node} */
-      node.init)].filter(Boolean);
-    default:
-      return [];
-  }
-};
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  context,
-  jsdoc,
-  node,
-  report,
-  utils
-}) => {
-  const /** @type {{aliases: {[key: string]: string[]}, excludedTags: string[], uselessWords: string[]}} */{
-    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) && !(0, _areDocsInformative.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 && /** @type {import('comment-parser').Spec & {line: import('../iterateJsdoc.js').Integer}} */
-    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: {
-          description: `The \`aliases\` option allows indicating words as synonyms (aliases) of each other.
-
-For example, with \`{ aliases: { emoji: ["smiley", "winkey"] } }\`, the following comment would be considered uninformative:
-
-\`\`\`js
-/** A smiley/winkey. */
-let emoji;
-\`\`\`
-
-The default \`aliases\` option is:
-
-\`\`\`json
-{
-  "a": ["an", "our"]
-}
-\`\`\``,
-          patternProperties: {
-            '.*': {
-              items: {
-                type: 'string'
-              },
-              type: 'array'
-            }
-          }
-        },
-        excludedTags: {
-          description: `Tags that should not be checked for valid contents.
-
-For example, with \`{ excludedTags: ["category"] }\`, the following comment would not be considered uninformative:
-
-\`\`\`js
-/** @category Types */
-function computeTypes(node) {
-  // ...
-}
-\`\`\`
-
-No tags are excluded by default.`,
-          items: {
-            type: 'string'
-          },
-          type: 'array'
-        },
-        uselessWords: {
-          description: `Words that are ignored when searching for one that adds meaning.
-
-For example, with \`{ uselessWords: ["our"] }\`, the following comment would be considered uninformative:
-
-\`\`\`js
-/** Our text. */
-let text;
-\`\`\`
-
-The default \`uselessWords\` option is:
-
-\`\`\`json
-["a", "an", "i", "in", "of", "s", "the"]
-\`\`\``,
-          items: {
-            type: 'string'
-          },
-          type: 'array'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'suggestion'
-  }
-});
-module.exports = exports.default;
-//# sourceMappingURL=informativeDocs.cjs.map

package/dist/rules/informativeDocs.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"informativeDocs.cjs","names":["iterateJsdoc","areDocsInformative"],"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/**\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\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            description: `The \\`aliases\\` option allows indicating words as synonyms (aliases) of each other.\n\nFor example, with \\`{ aliases: { emoji: [\"smiley\", \"winkey\"] } }\\`, the following comment would be considered uninformative:\n\n\\`\\`\\`js\n/** A smiley/winkey. */\nlet emoji;\n\\`\\`\\`\n\nThe default \\`aliases\\` option is:\n\n\\`\\`\\`json\n{\n  \"a\": [\"an\", \"our\"]\n}\n\\`\\`\\``,\n            patternProperties: {\n              '.*': {\n                items: {\n                  type: 'string',\n                },\n                type: 'array',\n              },\n            },\n          },\n          excludedTags: {\n            description: `Tags that should not be checked for valid contents.\n\nFor example, with \\`{ excludedTags: [\"category\"] }\\`, the following comment would not be considered uninformative:\n\n\\`\\`\\`js\n/** @category Types */\nfunction computeTypes(node) {\n  // ...\n}\n\\`\\`\\`\n\nNo tags are excluded by default.`,\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          uselessWords: {\n            description: `Words that are ignored when searching for one that adds meaning.\n\nFor example, with \\`{ uselessWords: [\"our\"] }\\`, the following comment would be considered uninformative:\n\n\\`\\`\\`js\n/** Our text. */\nlet text;\n\\`\\`\\`\n\nThe default \\`uselessWords\\` option is:\n\n\\`\\`\\`json\n[\"a\", \"an\", \"i\", \"in\", \"of\", \"s\", \"the\"]\n\\`\\`\\``,\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA;AACA;AAE8B;AAE9B,MAAM,cAAc,GAAG;EACrB,CAAC,EAAE,CACD,IAAI,EAAE,KAAK;AAEf,CAAC;AAED,MAAM,mBAAmB,GAAG,CAC1B,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,CACvC;;AAED;AACA;AACA;AACA;AACA,MAAM,gBAAgB,GAAI,IAAI,IAAK;EACjC,QAAQ,IAAI,EAAE,IAAI;IAChB,KAAK,kBAAkB;IACvB,KAAK,kBAAkB;IACvB,KAAK,oBAAoB;IACzB,KAAK,4BAA4B;IACjC,KAAK,4BAA4B;IACjC,KAAK,8BAA8B;MACjC,OAAO,CACL,GAAG,gBAAgB,CACnB,+DACI,IAAI,CAAC,MAAM,CACX,MACJ,CAAC,EACD,GAAG,gBAAgB,CACnB;MACG,IAAI,CAAC,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,OAAO,gBAAgB,CACvB;MACG,IAAI,CAAE,EACT,CAAC;IACH,KAAK,0BAA0B;IAC/B,KAAK,wBAAwB;MAC3B,OAAO,gBAAgB,CACvB;MACG,IAAI,CAAE,WACT,CAAC;IACH,KAAK,YAAY;MACf,OAAO,CACL,IAAI,CAAC,IAAI,CACV;IACH,KAAK,UAAU;MACb,OAAO,gBAAgB,CACvB;MACG,IAAI,CAAC,GACR,CAAC;IACH,KAAK,qBAAqB;MACxB,OAAO,gBAAgB,CACvB;MACG,IAAI,CAAC,YAAY,CAAC,CAAC,CACtB,CAAC;IACH,KAAK,oBAAoB;MACvB,OAAO,CACL,GAAG,gBAAgB,CACnB;MACG,IAAI,CAAC,EACR,CAAC,EACD,GAAG,gBAAgB,CACnB;MACG,IAAI,CAAC,IACR,CAAC,CACF,CAAC,MAAM,CAAC,OAAO,CAAC;IACnB;MACE,OAAO,EAAE;EACb;AACF,CAAC;AAAC,iCAEa,IAAAA,qBAAY,EAAC,CAAC;EAC3B,OAAO;EACP,KAAK;EACL,IAAI;EACJ,MAAM;EACN;AACF,CAAC,KAAK;EACJ,MAAM,mGAAoG;IACxG,OAAO,GAAG,cAAc;IACxB,YAAY,GAAG,EAAE;IACjB,YAAY,GAAG;EACjB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAC5B,MAAM,SAAS,GAAG,gBAAgB,CAAC,IAAI,CAAC;;EAExC;AACF;AACA;AACA;AACA;EACE,MAAM,sBAAsB,GAAG,CAAC,IAAI,EAAE,SAAS,GAAG,EAAE,KAAK;IACvD,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,OAAO,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,IAAAC,oBAAA,kBAAkB,EAAC,WAAW,EAAE,CAC9D,SAAS,EAAE,SAAS,CACrB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;MAC3B,OAAO;MACP;IACF,CAAC,CAAC;EACJ,CAAC;EAED,MAAM;IACJ,WAAW;IACX;EACF,CAAC,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;EAC1B,IAAI,mBAAmB,GAAG,KAAK;EAE/B,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,IAAI,EAAE;IAC5B,IAAI,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;MAClC;IACF;IAEA,IAAI,sBAAsB,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE;MACrD,KAAK,CAAC,WAAW,CACf,0DAA0D,EAC1D,GACF,CAAC;IACH;IAEA,mBAAmB,KAAK,GAAG,CAAC,WAAW,KAAK,WAAW,IACrD;IACC,GAAG,CAAE,IAAI,KAAK,mBAAmB;EACtC;EAEA,IAAI,CAAC,mBAAmB,IAAI,sBAAsB,CAAC,WAAW,CAAC,EAAE;IAC/D,MAAM,CAAC,sDAAsD,CAAC;EAChE;AACF,CAAC,EAAE;EACD,gBAAgB,EAAE,IAAI;EACtB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EACT,uEAAuE;MACzE,GAAG,EAAE;IACP,CAAC;IACD,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,OAAO,EAAE;UACP,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO;UACK,iBAAiB,EAAE;YACjB,IAAI,EAAE;cACJ,KAAK,EAAE;gBACL,IAAI,EAAE;cACR,CAAC;cACD,IAAI,EAAE;YACR;UACF;QACF,CAAC;QACD,YAAY,EAAE;UACZ,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,iCAAiC;UACrB,KAAK,EAAE;YACL,IAAI,EAAE;UACR,CAAC;UACD,IAAI,EAAE;QACR,CAAC;QACD,YAAY,EAAE;UACZ,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO;UACK,KAAK,EAAE;YACL,IAAI,EAAE;UACR,CAAC;UACD,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}

package/dist/rules/linesBeforeBlock.cjs

@@ -1,120 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * 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);
-  }
-}, {
-  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: {
-          description: `Whether to additionally check the start of blocks, such as classes or functions.
-Defaults to \`false\`.`,
-          type: 'boolean'
-        },
-        excludedTags: {
-          description: `An array of tags whose presence in the JSDoc block will prevent the
-application of the rule. Defaults to \`['type']\` (i.e., if \`@type\` is present,
-lines before the block will not be added).`,
-          items: {
-            type: 'string'
-          },
-          type: 'array'
-        },
-        ignoreSameLine: {
-          description: `This option excludes cases where the JSDoc block occurs on the same line as a
-preceding code or comment. Defaults to \`true\`.`,
-          type: 'boolean'
-        },
-        ignoreSingleLines: {
-          description: `This option excludes cases where the JSDoc block is only one line long.
-Defaults to \`true\`.`,
-          type: 'boolean'
-        },
-        lines: {
-          description: 'The minimum number of lines to require. Defaults to 1.',
-          type: 'integer'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'suggestion'
-  }
-});
-module.exports = exports.default;
-//# sourceMappingURL=linesBeforeBlock.cjs.map

package/dist/rules/linesBeforeBlock.cjs.map

@@ -1 +0,0 @@
-{"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            description: `Whether to additionally check the start of blocks, such as classes or functions.\nDefaults to \\`false\\`.`,\n            type: 'boolean',\n          },\n          excludedTags: {\n            description: `An array of tags whose presence in the JSDoc block will prevent the\napplication of the rule. Defaults to \\`['type']\\` (i.e., if \\`@type\\` is present,\nlines before the block will not be added).`,\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          ignoreSameLine: {\n            description: `This option excludes cases where the JSDoc block occurs on the same line as a\npreceding code or comment. Defaults to \\`true\\`.`,\n            type: 'boolean',\n          },\n          ignoreSingleLines: {\n            description: `This option excludes cases where the JSDoc block is only one line long.\nDefaults to \\`true\\`.`,\n            type: 'boolean',\n          },\n          lines: {\n            description: 'The minimum number of lines to require. Defaults to 1.',\n            type: 'integer',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA;AAA8C;AAE9C;AACA;AACA;AACA;AACA;AACA,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,CAC/B,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CACnB,CAAC;AAAC,iCAEY,IAAAA,qBAAY,EAAC,CAAC;EAC3B,OAAO;EACP,SAAS;EACT,MAAM;EACN,UAAU;EACV;AACF,CAAC,KAAK;EACJ,MAAM;IACJ,gBAAgB;IAChB,YAAY,GAAG,CACb,MAAM,CACP;IACD,cAAc,GAAG,IAAI;IACrB,iBAAiB,GAAG,IAAI;IACxB,KAAK,GAAG;EACV,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;IAC/B;EACF;EAEA,MAAM,YAAY,GAAG,UAAU,CAAC,eAAe,CAAC,SAAS,EAAE;IACzD,eAAe,EAAE;EACnB,CAAC,CAAC;EACF,MAAM,WAAW,GAAG,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;EACvC,IACE,CAAC,WAAW,IACV,WAAW,CAAC,IAAI,KAAK,YAAY,IACjC,CAAC,gBAAgB,IACjB,gBAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,CACvC,EACD;IACA;EACF;EAEA,IAAI,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,GAAG,KAAK,KACtC;EACK,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,EAC9B;IACA,MAAM,SAAS,GAAG,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI;IAC5C,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,KAAK,SAAS;IAEzD,IAAI,QAAQ,IAAI,cAAc,EAAE;MAC9B;IACF;IAEA,IAAI,iBAAiB,IAAI,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,EAAE;MAC9E;IACF;;IAEA;IACA,MAAM,GAAG,GAAI,KAAK,IAAK;MACrB,IAAI,MAAM,GAAG,EAAE;MACf,IAAI,QAAQ,EAAE;QACZ,MAAM,SAAS,GAAG,qBAAuB,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,IACrE,qBAAuB,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC;QACpD;QACA,MAAM,GAAG,uCACP,SAAS,CACT,KAAK,CAAC,KAAK,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;QACzD,IAAI,CAAC,MAAM,EAAE;UACX;UACA,IAAI,UAAU,GAAG,WAAW;UAC5B,IAAI,WAAW;UACf,OAAO,UAAU,IAAI,UAAU,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,KAAK,SAAS,EAAE;YAC/D,WAAW,GAAG,UAAU,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM;YAC3C,UAAU,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;UACjC;UAEA,MAAM,GAAG,GAAG,CAAC,MAAM,CACjB;UACA,qBAAuB,WAAW,GAAG,WAAW,GAAG,CAAC,GAAG,CACzD,CAAC;QACH;MACF;MAEA,OAAO,KAAK,CAAC,eAAe,CAC1B;MACC,WAAW,EACZ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IACjB,QAAQ,GAAG,IAAI,GAAG,MAAM,GAAG,EAAE,CAChC,CAAC;IACH,CAAC;IAED,MAAM,CAAC,YAAY,KAAK,6BAA6B,EAAE,GAAG,CAAC;EAC7D;AACF,CAAC,EAAE;EACD,gBAAgB,EAAE,IAAI;EACtB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,iEAAiE;MAC9E,GAAG,EAAE;IACP,CAAC;IACD,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,gBAAgB,EAAE;UAChB,WAAW,EAAE;AACzB,uBAAuB;UACX,IAAI,EAAE;QACR,CAAC;QACD,YAAY,EAAE;UACZ,WAAW,EAAE;AACzB;AACA,2CAA2C;UAC/B,KAAK,EAAE;YACL,IAAI,EAAE;UACR,CAAC;UACD,IAAI,EAAE;QACR,CAAC;QACD,cAAc,EAAE;UACd,WAAW,EAAE;AACzB,iDAAiD;UACrC,IAAI,EAAE;QACR,CAAC;QACD,iBAAiB,EAAE;UACjB,WAAW,EAAE;AACzB,sBAAsB;UACV,IAAI,EAAE;QACR,CAAC;QACD,KAAK,EAAE;UACL,WAAW,EAAE,wDAAwD;UACrE,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}