eslint-plugin-jsdoc 39.3.5 → 39.3.12

package/dist/rules/requireYields.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * We can skip checking for a yield value, in case the documentation is inherited
  * or the method has a constructor or abstract tag.
@@ -19,40 +16,39 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @returns {boolean} true in case deep checking can be skipped; otherwise false.
  */
 const canSkip = utils => {
-  return utils.hasATag([// inheritdoc implies that all documentation is inherited
+  return utils.hasATag([
+  // inheritdoc implies that all documentation is inherited
   // see https://jsdoc.app/tags-inheritdoc.html
   //
   // Abstract methods are by definition incomplete,
   // so it is not an error if it declares a yield value but does not implement it.
-  'abstract', 'virtual', // Constructors do not have a yield value
+  'abstract', 'virtual',
+  // Constructors do not have a yield value
   // so we can bail out here, too.
-  'class', 'constructor', // Yield (and any `next`) type is specified accompanying the targeted
+  'class', 'constructor',
+  // Yield (and any `next`) type is specified accompanying the targeted
   //   @type
-  'type', // This seems to imply a class as well
+  'type',
+  // This seems to imply a class as well
   'interface']) || utils.avoidDocs();
 };
-
 const checkTagName = (utils, report, tagName) => {
   const preferredTagName = utils.getPreferredTagName({
     tagName
   });
-
   if (!preferredTagName) {
     return [];
   }
-
   const tags = utils.getTags(preferredTagName);
-
   if (tags.length > 1) {
     report(`Found more than one @${preferredTagName} declaration.`);
-  } // In case the code yields something, we expect a yields value in JSDoc.
-
+  }
 
+  // In case the code yields something, we expect a yields value in JSDoc.
   const [tag] = tags;
   const missingTag = typeof tag === 'undefined' || tag === null;
   return [preferredTagName, missingTag];
 };
-
 var _default = (0, _iterateJsdoc.default)(({
   report,
   utils,
@@ -64,57 +60,46 @@ var _default = (0, _iterateJsdoc.default)(({
     forceRequireNext = false,
     forceRequireYields = false,
     withGeneratorTag = true
-  } = context.options[0] || {}; // A preflight check. We do not need to run a deep check
-  // in case the @yield comment is optional or undefined.
+  } = context.options[0] || {};
 
+  // A preflight check. We do not need to run a deep check
+  // in case the @yield comment is optional or undefined.
   if (canSkip(utils)) {
     return;
   }
-
   const iteratingFunction = utils.isIteratingFunction();
   const [preferredYieldTagName, missingYieldTag] = checkTagName(utils, report, 'yields');
-
   if (preferredYieldTagName) {
     const shouldReportYields = () => {
       if (!missingYieldTag) {
         return false;
       }
-
       if (withGeneratorTag && utils.hasTag('generator') || forceRequireYields && iteratingFunction && utils.isGenerator()) {
         return true;
       }
-
       return iteratingFunction && utils.isGenerator() && utils.hasYieldValue();
     };
-
     if (shouldReportYields()) {
       report(`Missing JSDoc @${preferredYieldTagName} declaration.`);
     }
   }
-
   if (next || nextWithGeneratorTag || forceRequireNext) {
     const [preferredNextTagName, missingNextTag] = checkTagName(utils, report, 'next');
-
     if (!preferredNextTagName) {
       return;
     }
-
     const shouldReportNext = () => {
       if (!missingNextTag) {
         return false;
       }
-
       if (nextWithGeneratorTag && utils.hasTag('generator')) {
         return true;
       }
-
       if (!next && !forceRequireNext || !iteratingFunction || !utils.isGenerator()) {
         return false;
       }
-
       return forceRequireNext || utils.hasYieldReturnValue();
     };
-
     if (shouldReportNext()) {
       report(`Missing JSDoc @${preferredNextTagName} declaration.`);
     }
@@ -180,7 +165,6 @@ var _default = (0, _iterateJsdoc.default)(({
     type: 'suggestion'
   }
 });
-
 exports.default = _default;
 module.exports = exports.default;
 //# sourceMappingURL=requireYields.js.map

package/dist/rules/requireYields.js.map

@@ -1 +1 @@
-{"version":3,"file":"requireYields.js","names":["canSkip","utils","hasATag","avoidDocs","checkTagName","report","tagName","preferredTagName","getPreferredTagName","tags","getTags","length","tag","missingTag","iterateJsdoc","context","next","nextWithGeneratorTag","forceRequireNext","forceRequireYields","withGeneratorTag","options","iteratingFunction","isIteratingFunction","preferredYieldTagName","missingYieldTag","shouldReportYields","hasTag","isGenerator","hasYieldValue","preferredNextTagName","missingNextTag","shouldReportNext","hasYieldReturnValue","contextDefaults","meta","docs","description","url","schema","additionalProperties","properties","contexts","items","anyOf","type","comment","exemptedBy","default"],"sources":["../../src/rules/requireYields.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc';\n\n/**\n * We can skip checking for a yield value, in case the documentation is inherited\n * or the method has a constructor or abstract tag.\n *\n * In either of these cases the yield value is optional or not defined.\n *\n * @param {*} utils a reference to the utils which are used to probe if a tag is present or not.\n * @returns {boolean} true in case deep checking can be skipped; otherwise false.\n */\nconst canSkip = (utils) => {\n  return utils.hasATag([\n    // inheritdoc implies that all documentation is inherited\n    // see https://jsdoc.app/tags-inheritdoc.html\n    //\n    // Abstract methods are by definition incomplete,\n    // so it is not an error if it declares a yield value but does not implement it.\n    'abstract',\n    'virtual',\n\n    // Constructors do not have a yield value\n    // so we can bail out here, too.\n    'class',\n    'constructor',\n\n    // Yield (and any `next`) type is specified accompanying the targeted\n    //   @type\n    'type',\n\n    // This seems to imply a class as well\n    'interface',\n  ]) ||\n    utils.avoidDocs();\n};\n\nconst checkTagName = (utils, report, tagName) => {\n  const preferredTagName = utils.getPreferredTagName({\n    tagName,\n  });\n  if (!preferredTagName) {\n    return [];\n  }\n\n  const tags = utils.getTags(preferredTagName);\n\n  if (tags.length > 1) {\n    report(`Found more than one @${preferredTagName} declaration.`);\n  }\n\n  // In case the code yields something, we expect a yields value in JSDoc.\n  const [\n    tag,\n  ] = tags;\n  const missingTag = typeof tag === 'undefined' || tag === null;\n\n  return [\n    preferredTagName, missingTag,\n  ];\n};\n\nexport default iterateJsdoc(({\n  report,\n  utils,\n  context,\n}) => {\n  const {\n    next = false,\n    nextWithGeneratorTag = false,\n    forceRequireNext = false,\n    forceRequireYields = false,\n    withGeneratorTag = true,\n  } = context.options[0] || {};\n\n  // A preflight check. We do not need to run a deep check\n  // in case the @yield comment is optional or undefined.\n  if (canSkip(utils)) {\n    return;\n  }\n\n  const iteratingFunction = utils.isIteratingFunction();\n\n  const [\n    preferredYieldTagName,\n    missingYieldTag,\n  ] = checkTagName(\n    utils, report, 'yields',\n  );\n  if (preferredYieldTagName) {\n    const shouldReportYields = () => {\n      if (!missingYieldTag) {\n        return false;\n      }\n\n      if (\n        withGeneratorTag && utils.hasTag('generator') ||\n        forceRequireYields && iteratingFunction && utils.isGenerator()\n      ) {\n        return true;\n      }\n\n      return iteratingFunction && utils.isGenerator() && utils.hasYieldValue();\n    };\n\n    if (shouldReportYields()) {\n      report(`Missing JSDoc @${preferredYieldTagName} declaration.`);\n    }\n  }\n\n  if (next || nextWithGeneratorTag || forceRequireNext) {\n    const [\n      preferredNextTagName,\n      missingNextTag,\n    ] = checkTagName(\n      utils, report, 'next',\n    );\n    if (!preferredNextTagName) {\n      return;\n    }\n\n    const shouldReportNext = () => {\n      if (!missingNextTag) {\n        return false;\n      }\n\n      if (\n        nextWithGeneratorTag && utils.hasTag('generator')) {\n        return true;\n      }\n\n      if (\n        !next && !forceRequireNext ||\n        !iteratingFunction ||\n        !utils.isGenerator()\n      ) {\n        return false;\n      }\n\n      return forceRequireNext || utils.hasYieldReturnValue();\n    };\n\n    if (shouldReportNext()) {\n      report(`Missing JSDoc @${preferredNextTagName} declaration.`);\n    }\n  }\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires yields are documented.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-yields',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          forceRequireNext: {\n            default: false,\n            type: 'boolean',\n          },\n          forceRequireYields: {\n            default: false,\n            type: 'boolean',\n          },\n          next: {\n            default: false,\n            type: 'boolean',\n          },\n          nextWithGeneratorTag: {\n            default: false,\n            type: 'boolean',\n          },\n          withGeneratorTag: {\n            default: true,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;AAAA;;;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMA,OAAO,GAAIC,KAAD,IAAW;EACzB,OAAOA,KAAK,CAACC,OAAN,CAAc,CACnB;EACA;EACA;EACA;EACA;EACA,UANmB,EAOnB,SAPmB,EASnB;EACA;EACA,OAXmB,EAYnB,aAZmB,EAcnB;EACA;EACA,MAhBmB,EAkBnB;EACA,WAnBmB,CAAd,KAqBLD,KAAK,CAACE,SAAN,EArBF;AAsBD,CAvBD;;AAyBA,MAAMC,YAAY,GAAG,CAACH,KAAD,EAAQI,MAAR,EAAgBC,OAAhB,KAA4B;EAC/C,MAAMC,gBAAgB,GAAGN,KAAK,CAACO,mBAAN,CAA0B;IACjDF;EADiD,CAA1B,CAAzB;;EAGA,IAAI,CAACC,gBAAL,EAAuB;IACrB,OAAO,EAAP;EACD;;EAED,MAAME,IAAI,GAAGR,KAAK,CAACS,OAAN,CAAcH,gBAAd,CAAb;;EAEA,IAAIE,IAAI,CAACE,MAAL,GAAc,CAAlB,EAAqB;IACnBN,MAAM,CAAE,wBAAuBE,gBAAiB,eAA1C,CAAN;EACD,CAZ8C,CAc/C;;;EACA,MAAM,CACJK,GADI,IAEFH,IAFJ;EAGA,MAAMI,UAAU,GAAG,OAAOD,GAAP,KAAe,WAAf,IAA8BA,GAAG,KAAK,IAAzD;EAEA,OAAO,CACLL,gBADK,EACaM,UADb,CAAP;AAGD,CAvBD;;eAyBe,IAAAC,qBAAA,EAAa,CAAC;EAC3BT,MAD2B;EAE3BJ,KAF2B;EAG3Bc;AAH2B,CAAD,KAItB;EACJ,MAAM;IACJC,IAAI,GAAG,KADH;IAEJC,oBAAoB,GAAG,KAFnB;IAGJC,gBAAgB,GAAG,KAHf;IAIJC,kBAAkB,GAAG,KAJjB;IAKJC,gBAAgB,GAAG;EALf,IAMFL,OAAO,CAACM,OAAR,CAAgB,CAAhB,KAAsB,EAN1B,CADI,CASJ;EACA;;EACA,IAAIrB,OAAO,CAACC,KAAD,CAAX,EAAoB;IAClB;EACD;;EAED,MAAMqB,iBAAiB,GAAGrB,KAAK,CAACsB,mBAAN,EAA1B;EAEA,MAAM,CACJC,qBADI,EAEJC,eAFI,IAGFrB,YAAY,CACdH,KADc,EACPI,MADO,EACC,QADD,CAHhB;;EAMA,IAAImB,qBAAJ,EAA2B;IACzB,MAAME,kBAAkB,GAAG,MAAM;MAC/B,IAAI,CAACD,eAAL,EAAsB;QACpB,OAAO,KAAP;MACD;;MAED,IACEL,gBAAgB,IAAInB,KAAK,CAAC0B,MAAN,CAAa,WAAb,CAApB,IACAR,kBAAkB,IAAIG,iBAAtB,IAA2CrB,KAAK,CAAC2B,WAAN,EAF7C,EAGE;QACA,OAAO,IAAP;MACD;;MAED,OAAON,iBAAiB,IAAIrB,KAAK,CAAC2B,WAAN,EAArB,IAA4C3B,KAAK,CAAC4B,aAAN,EAAnD;IACD,CAbD;;IAeA,IAAIH,kBAAkB,EAAtB,EAA0B;MACxBrB,MAAM,CAAE,kBAAiBmB,qBAAsB,eAAzC,CAAN;IACD;EACF;;EAED,IAAIR,IAAI,IAAIC,oBAAR,IAAgCC,gBAApC,EAAsD;IACpD,MAAM,CACJY,oBADI,EAEJC,cAFI,IAGF3B,YAAY,CACdH,KADc,EACPI,MADO,EACC,MADD,CAHhB;;IAMA,IAAI,CAACyB,oBAAL,EAA2B;MACzB;IACD;;IAED,MAAME,gBAAgB,GAAG,MAAM;MAC7B,IAAI,CAACD,cAAL,EAAqB;QACnB,OAAO,KAAP;MACD;;MAED,IACEd,oBAAoB,IAAIhB,KAAK,CAAC0B,MAAN,CAAa,WAAb,CAD1B,EACqD;QACnD,OAAO,IAAP;MACD;;MAED,IACE,CAACX,IAAD,IAAS,CAACE,gBAAV,IACA,CAACI,iBADD,IAEA,CAACrB,KAAK,CAAC2B,WAAN,EAHH,EAIE;QACA,OAAO,KAAP;MACD;;MAED,OAAOV,gBAAgB,IAAIjB,KAAK,CAACgC,mBAAN,EAA3B;IACD,CAnBD;;IAqBA,IAAID,gBAAgB,EAApB,EAAwB;MACtB3B,MAAM,CAAE,kBAAiByB,oBAAqB,eAAxC,CAAN;IACD;EACF;AACF,CApFc,EAoFZ;EACDI,eAAe,EAAE,IADhB;EAEDC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,iCADT;MAEJC,GAAG,EAAE;IAFD,CADF;IAKJC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KADxB;MAEEC,UAAU,EAAE;QACVC,QAAQ,EAAE;UACRC,KAAK,EAAE;YACLC,KAAK,EAAE,CACL;cACEC,IAAI,EAAE;YADR,CADK,EAIL;cACEL,oBAAoB,EAAE,KADxB;cAEEC,UAAU,EAAE;gBACVK,OAAO,EAAE;kBACPD,IAAI,EAAE;gBADC,CADC;gBAIV9B,OAAO,EAAE;kBACP8B,IAAI,EAAE;gBADC;cAJC,CAFd;cAUEA,IAAI,EAAE;YAVR,CAJK;UADF,CADC;UAoBRA,IAAI,EAAE;QApBE,CADA;QAuBVE,UAAU,EAAE;UACVJ,KAAK,EAAE;YACLE,IAAI,EAAE;UADD,CADG;UAIVA,IAAI,EAAE;QAJI,CAvBF;QA6BV3B,gBAAgB,EAAE;UAChB8B,OAAO,EAAE,KADO;UAEhBH,IAAI,EAAE;QAFU,CA7BR;QAiCV1B,kBAAkB,EAAE;UAClB6B,OAAO,EAAE,KADS;UAElBH,IAAI,EAAE;QAFY,CAjCV;QAqCV7B,IAAI,EAAE;UACJgC,OAAO,EAAE,KADL;UAEJH,IAAI,EAAE;QAFF,CArCI;QAyCV5B,oBAAoB,EAAE;UACpB+B,OAAO,EAAE,KADW;UAEpBH,IAAI,EAAE;QAFc,CAzCZ;QA6CVzB,gBAAgB,EAAE;UAChB4B,OAAO,EAAE,IADO;UAEhBH,IAAI,EAAE;QAFU;MA7CR,CAFd;MAoDEA,IAAI,EAAE;IApDR,CADM,CALJ;IA6DJA,IAAI,EAAE;EA7DF;AAFL,CApFY,C"}
+{"version":3,"file":"requireYields.js","names":["canSkip","utils","hasATag","avoidDocs","checkTagName","report","tagName","preferredTagName","getPreferredTagName","tags","getTags","length","tag","missingTag","iterateJsdoc","context","next","nextWithGeneratorTag","forceRequireNext","forceRequireYields","withGeneratorTag","options","iteratingFunction","isIteratingFunction","preferredYieldTagName","missingYieldTag","shouldReportYields","hasTag","isGenerator","hasYieldValue","preferredNextTagName","missingNextTag","shouldReportNext","hasYieldReturnValue","contextDefaults","meta","docs","description","url","schema","additionalProperties","properties","contexts","items","anyOf","type","comment","exemptedBy","default"],"sources":["../../src/rules/requireYields.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc';\n\n/**\n * We can skip checking for a yield value, in case the documentation is inherited\n * or the method has a constructor or abstract tag.\n *\n * In either of these cases the yield value is optional or not defined.\n *\n * @param {*} utils a reference to the utils which are used to probe if a tag is present or not.\n * @returns {boolean} true in case deep checking can be skipped; otherwise false.\n */\nconst canSkip = (utils) => {\n  return utils.hasATag([\n    // inheritdoc implies that all documentation is inherited\n    // see https://jsdoc.app/tags-inheritdoc.html\n    //\n    // Abstract methods are by definition incomplete,\n    // so it is not an error if it declares a yield value but does not implement it.\n    'abstract',\n    'virtual',\n\n    // Constructors do not have a yield value\n    // so we can bail out here, too.\n    'class',\n    'constructor',\n\n    // Yield (and any `next`) type is specified accompanying the targeted\n    //   @type\n    'type',\n\n    // This seems to imply a class as well\n    'interface',\n  ]) ||\n    utils.avoidDocs();\n};\n\nconst checkTagName = (utils, report, tagName) => {\n  const preferredTagName = utils.getPreferredTagName({\n    tagName,\n  });\n  if (!preferredTagName) {\n    return [];\n  }\n\n  const tags = utils.getTags(preferredTagName);\n\n  if (tags.length > 1) {\n    report(`Found more than one @${preferredTagName} declaration.`);\n  }\n\n  // In case the code yields something, we expect a yields value in JSDoc.\n  const [\n    tag,\n  ] = tags;\n  const missingTag = typeof tag === 'undefined' || tag === null;\n\n  return [\n    preferredTagName, missingTag,\n  ];\n};\n\nexport default iterateJsdoc(({\n  report,\n  utils,\n  context,\n}) => {\n  const {\n    next = false,\n    nextWithGeneratorTag = false,\n    forceRequireNext = false,\n    forceRequireYields = false,\n    withGeneratorTag = true,\n  } = context.options[0] || {};\n\n  // A preflight check. We do not need to run a deep check\n  // in case the @yield comment is optional or undefined.\n  if (canSkip(utils)) {\n    return;\n  }\n\n  const iteratingFunction = utils.isIteratingFunction();\n\n  const [\n    preferredYieldTagName,\n    missingYieldTag,\n  ] = checkTagName(\n    utils, report, 'yields',\n  );\n  if (preferredYieldTagName) {\n    const shouldReportYields = () => {\n      if (!missingYieldTag) {\n        return false;\n      }\n\n      if (\n        withGeneratorTag && utils.hasTag('generator') ||\n        forceRequireYields && iteratingFunction && utils.isGenerator()\n      ) {\n        return true;\n      }\n\n      return iteratingFunction && utils.isGenerator() && utils.hasYieldValue();\n    };\n\n    if (shouldReportYields()) {\n      report(`Missing JSDoc @${preferredYieldTagName} declaration.`);\n    }\n  }\n\n  if (next || nextWithGeneratorTag || forceRequireNext) {\n    const [\n      preferredNextTagName,\n      missingNextTag,\n    ] = checkTagName(\n      utils, report, 'next',\n    );\n    if (!preferredNextTagName) {\n      return;\n    }\n\n    const shouldReportNext = () => {\n      if (!missingNextTag) {\n        return false;\n      }\n\n      if (\n        nextWithGeneratorTag && utils.hasTag('generator')) {\n        return true;\n      }\n\n      if (\n        !next && !forceRequireNext ||\n        !iteratingFunction ||\n        !utils.isGenerator()\n      ) {\n        return false;\n      }\n\n      return forceRequireNext || utils.hasYieldReturnValue();\n    };\n\n    if (shouldReportNext()) {\n      report(`Missing JSDoc @${preferredNextTagName} declaration.`);\n    }\n  }\n}, {\n  contextDefaults: true,\n  meta: {\n    docs: {\n      description: 'Requires yields are documented.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-yields',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          forceRequireNext: {\n            default: false,\n            type: 'boolean',\n          },\n          forceRequireYields: {\n            default: false,\n            type: 'boolean',\n          },\n          next: {\n            default: false,\n            type: 'boolean',\n          },\n          nextWithGeneratorTag: {\n            default: false,\n            type: 'boolean',\n          },\n          withGeneratorTag: {\n            default: true,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA;AAA2C;AAE3C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMA,OAAO,GAAIC,KAAK,IAAK;EACzB,OAAOA,KAAK,CAACC,OAAO,CAAC;EACnB;EACA;EACA;EACA;EACA;EACA,UAAU,EACV,SAAS;EAET;EACA;EACA,OAAO,EACP,aAAa;EAEb;EACA;EACA,MAAM;EAEN;EACA,WAAW,CACZ,CAAC,IACAD,KAAK,CAACE,SAAS,EAAE;AACrB,CAAC;AAED,MAAMC,YAAY,GAAG,CAACH,KAAK,EAAEI,MAAM,EAAEC,OAAO,KAAK;EAC/C,MAAMC,gBAAgB,GAAGN,KAAK,CAACO,mBAAmB,CAAC;IACjDF;EACF,CAAC,CAAC;EACF,IAAI,CAACC,gBAAgB,EAAE;IACrB,OAAO,EAAE;EACX;EAEA,MAAME,IAAI,GAAGR,KAAK,CAACS,OAAO,CAACH,gBAAgB,CAAC;EAE5C,IAAIE,IAAI,CAACE,MAAM,GAAG,CAAC,EAAE;IACnBN,MAAM,CAAE,wBAAuBE,gBAAiB,eAAc,CAAC;EACjE;;EAEA;EACA,MAAM,CACJK,GAAG,CACJ,GAAGH,IAAI;EACR,MAAMI,UAAU,GAAG,OAAOD,GAAG,KAAK,WAAW,IAAIA,GAAG,KAAK,IAAI;EAE7D,OAAO,CACLL,gBAAgB,EAAEM,UAAU,CAC7B;AACH,CAAC;AAAC,eAEa,IAAAC,qBAAY,EAAC,CAAC;EAC3BT,MAAM;EACNJ,KAAK;EACLc;AACF,CAAC,KAAK;EACJ,MAAM;IACJC,IAAI,GAAG,KAAK;IACZC,oBAAoB,GAAG,KAAK;IAC5BC,gBAAgB,GAAG,KAAK;IACxBC,kBAAkB,GAAG,KAAK;IAC1BC,gBAAgB,GAAG;EACrB,CAAC,GAAGL,OAAO,CAACM,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;EAE5B;EACA;EACA,IAAIrB,OAAO,CAACC,KAAK,CAAC,EAAE;IAClB;EACF;EAEA,MAAMqB,iBAAiB,GAAGrB,KAAK,CAACsB,mBAAmB,EAAE;EAErD,MAAM,CACJC,qBAAqB,EACrBC,eAAe,CAChB,GAAGrB,YAAY,CACdH,KAAK,EAAEI,MAAM,EAAE,QAAQ,CACxB;EACD,IAAImB,qBAAqB,EAAE;IACzB,MAAME,kBAAkB,GAAG,MAAM;MAC/B,IAAI,CAACD,eAAe,EAAE;QACpB,OAAO,KAAK;MACd;MAEA,IACEL,gBAAgB,IAAInB,KAAK,CAAC0B,MAAM,CAAC,WAAW,CAAC,IAC7CR,kBAAkB,IAAIG,iBAAiB,IAAIrB,KAAK,CAAC2B,WAAW,EAAE,EAC9D;QACA,OAAO,IAAI;MACb;MAEA,OAAON,iBAAiB,IAAIrB,KAAK,CAAC2B,WAAW,EAAE,IAAI3B,KAAK,CAAC4B,aAAa,EAAE;IAC1E,CAAC;IAED,IAAIH,kBAAkB,EAAE,EAAE;MACxBrB,MAAM,CAAE,kBAAiBmB,qBAAsB,eAAc,CAAC;IAChE;EACF;EAEA,IAAIR,IAAI,IAAIC,oBAAoB,IAAIC,gBAAgB,EAAE;IACpD,MAAM,CACJY,oBAAoB,EACpBC,cAAc,CACf,GAAG3B,YAAY,CACdH,KAAK,EAAEI,MAAM,EAAE,MAAM,CACtB;IACD,IAAI,CAACyB,oBAAoB,EAAE;MACzB;IACF;IAEA,MAAME,gBAAgB,GAAG,MAAM;MAC7B,IAAI,CAACD,cAAc,EAAE;QACnB,OAAO,KAAK;MACd;MAEA,IACEd,oBAAoB,IAAIhB,KAAK,CAAC0B,MAAM,CAAC,WAAW,CAAC,EAAE;QACnD,OAAO,IAAI;MACb;MAEA,IACE,CAACX,IAAI,IAAI,CAACE,gBAAgB,IAC1B,CAACI,iBAAiB,IAClB,CAACrB,KAAK,CAAC2B,WAAW,EAAE,EACpB;QACA,OAAO,KAAK;MACd;MAEA,OAAOV,gBAAgB,IAAIjB,KAAK,CAACgC,mBAAmB,EAAE;IACxD,CAAC;IAED,IAAID,gBAAgB,EAAE,EAAE;MACtB3B,MAAM,CAAE,kBAAiByB,oBAAqB,eAAc,CAAC;IAC/D;EACF;AACF,CAAC,EAAE;EACDI,eAAe,EAAE,IAAI;EACrBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,iCAAiC;MAC9CC,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVC,QAAQ,EAAE;UACRC,KAAK,EAAE;YACLC,KAAK,EAAE,CACL;cACEC,IAAI,EAAE;YACR,CAAC,EACD;cACEL,oBAAoB,EAAE,KAAK;cAC3BC,UAAU,EAAE;gBACVK,OAAO,EAAE;kBACPD,IAAI,EAAE;gBACR,CAAC;gBACD9B,OAAO,EAAE;kBACP8B,IAAI,EAAE;gBACR;cACF,CAAC;cACDA,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACDE,UAAU,EAAE;UACVJ,KAAK,EAAE;YACLE,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACD3B,gBAAgB,EAAE;UAChB8B,OAAO,EAAE,KAAK;UACdH,IAAI,EAAE;QACR,CAAC;QACD1B,kBAAkB,EAAE;UAClB6B,OAAO,EAAE,KAAK;UACdH,IAAI,EAAE;QACR,CAAC;QACD7B,IAAI,EAAE;UACJgC,OAAO,EAAE,KAAK;UACdH,IAAI,EAAE;QACR,CAAC;QACD5B,oBAAoB,EAAE;UACpB+B,OAAO,EAAE,KAAK;UACdH,IAAI,EAAE;QACR,CAAC;QACDzB,gBAAgB,EAAE;UAChB4B,OAAO,EAAE,IAAI;UACbH,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA;AAAA"}

package/dist/rules/requireYieldsCheck.js

@@ -4,53 +4,44 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const canSkip = (utils, settings) => {
-  const voidingTags = [// An abstract function is by definition incomplete
+  const voidingTags = [
+  // An abstract function is by definition incomplete
   // so it is perfectly fine if a yield is documented but
   // not present within the function.
   // A subclass may inherit the doc and implement the
   // missing yield.
-  'abstract', 'virtual', // Constructor functions do not have a yield value
+  'abstract', 'virtual',
+  // Constructor functions do not have a yield value
   //  so we can bail here, too.
-  'class', 'constructor', // This seems to imply a class as well
+  'class', 'constructor',
+  // This seems to imply a class as well
   'interface'];
-
   if (settings.mode === 'closure') {
     // Structural Interface in GCC terms, equivalent to @interface tag as far as this rule is concerned
     voidingTags.push('record');
   }
-
   return utils.hasATag(voidingTags) || utils.isConstructor() || utils.classHasTag('interface') || settings.mode === 'closure' && utils.classHasTag('record');
 };
-
 const checkTagName = (utils, report, tagName) => {
   const preferredTagName = utils.getPreferredTagName({
     tagName
   });
-
   if (!preferredTagName) {
     return [];
   }
-
   const tags = utils.getTags(preferredTagName);
-
   if (tags.length === 0) {
     return [];
   }
-
   if (tags.length > 1) {
     report(`Found more than one @${preferredTagName} declaration.`);
     return [];
   }
-
   return [preferredTagName, tags[0]];
 };
-
 var _default = (0, _iterateJsdoc.default)(({
   context,
   report,
@@ -60,56 +51,45 @@ var _default = (0, _iterateJsdoc.default)(({
   if (canSkip(utils, settings)) {
     return;
   }
-
   const {
     next = false,
     checkGeneratorsOnly = false
   } = context.options[0] || {};
   const [preferredYieldTagName, yieldTag] = checkTagName(utils, report, 'yields');
-
   if (preferredYieldTagName) {
     const shouldReportYields = () => {
       if (yieldTag.type.trim() === 'never') {
         if (utils.hasYieldValue()) {
           report(`JSDoc @${preferredYieldTagName} declaration set with "never" but yield expression is present in function.`);
         }
-
         return false;
       }
-
       if (checkGeneratorsOnly && !utils.isGenerator()) {
         return true;
       }
-
       return utils.hasDefinedTypeTag(yieldTag) && !utils.hasYieldValue();
-    }; // In case a yield value is declared in JSDoc, we also expect one in the code.
-
+    };
 
+    // In case a yield value is declared in JSDoc, we also expect one in the code.
     if (shouldReportYields()) {
       report(`JSDoc @${preferredYieldTagName} declaration present but yield expression not available in function.`);
     }
   }
-
   if (next) {
     const [preferredNextTagName, nextTag] = checkTagName(utils, report, 'next');
-
     if (preferredNextTagName) {
       const shouldReportNext = () => {
         if (nextTag.type.trim() === 'never') {
           if (utils.hasYieldReturnValue()) {
             report(`JSDoc @${preferredNextTagName} declaration set with "never" but yield expression with return value is present in function.`);
           }
-
           return false;
         }
-
         if (checkGeneratorsOnly && !utils.isGenerator()) {
           return true;
         }
-
         return utils.hasDefinedTypeTag(nextTag) && !utils.hasYieldReturnValue();
       };
-
       if (shouldReportNext()) {
         report(`JSDoc @${preferredNextTagName} declaration present but yield expression with return value not available in function.`);
       }
@@ -163,7 +143,6 @@ var _default = (0, _iterateJsdoc.default)(({
     type: 'suggestion'
   }
 });
-
 exports.default = _default;
 module.exports = exports.default;
 //# sourceMappingURL=requireYieldsCheck.js.map

package/dist/rules/requireYieldsCheck.js.map

@@ -1 +1 @@
-{"version":3,"file":"requireYieldsCheck.js","names":["canSkip","utils","settings","voidingTags","mode","push","hasATag","isConstructor","classHasTag","checkTagName","report","tagName","preferredTagName","getPreferredTagName","tags","getTags","length","iterateJsdoc","context","next","checkGeneratorsOnly","options","preferredYieldTagName","yieldTag","shouldReportYields","type","trim","hasYieldValue","isGenerator","hasDefinedTypeTag","preferredNextTagName","nextTag","shouldReportNext","hasYieldReturnValue","meta","docs","description","url","schema","additionalProperties","properties","default","contexts","items","anyOf","comment","exemptedBy"],"sources":["../../src/rules/requireYieldsCheck.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc';\n\nconst canSkip = (utils, settings) => {\n  const voidingTags = [\n    // An abstract function is by definition incomplete\n    // so it is perfectly fine if a yield is documented but\n    // not present within the function.\n    // A subclass may inherit the doc and implement the\n    // missing yield.\n    'abstract',\n    'virtual',\n\n    // Constructor functions do not have a yield value\n    //  so we can bail here, too.\n    'class',\n    'constructor',\n\n    // This seems to imply a class as well\n    'interface',\n  ];\n\n  if (settings.mode === 'closure') {\n    // Structural Interface in GCC terms, equivalent to @interface tag as far as this rule is concerned\n    voidingTags.push('record');\n  }\n\n  return utils.hasATag(voidingTags) ||\n    utils.isConstructor() ||\n    utils.classHasTag('interface') ||\n    settings.mode === 'closure' && utils.classHasTag('record');\n};\n\nconst checkTagName = (utils, report, tagName) => {\n  const preferredTagName = utils.getPreferredTagName({\n    tagName,\n  });\n  if (!preferredTagName) {\n    return [];\n  }\n\n  const tags = utils.getTags(preferredTagName);\n\n  if (tags.length === 0) {\n    return [];\n  }\n\n  if (tags.length > 1) {\n    report(`Found more than one @${preferredTagName} declaration.`);\n\n    return [];\n  }\n\n  return [\n    preferredTagName, tags[0],\n  ];\n};\n\nexport default iterateJsdoc(({\n  context,\n  report,\n  settings,\n  utils,\n}) => {\n  if (canSkip(utils, settings)) {\n    return;\n  }\n\n  const {\n    next = false,\n    checkGeneratorsOnly = false,\n  } = context.options[0] || {};\n\n  const [\n    preferredYieldTagName,\n    yieldTag,\n  ] = checkTagName(\n    utils, report, 'yields',\n  );\n  if (preferredYieldTagName) {\n    const shouldReportYields = () => {\n      if (yieldTag.type.trim() === 'never') {\n        if (utils.hasYieldValue()) {\n          report(`JSDoc @${preferredYieldTagName} declaration set with \"never\" but yield expression is present in function.`);\n        }\n\n        return false;\n      }\n\n      if (checkGeneratorsOnly && !utils.isGenerator()) {\n        return true;\n      }\n\n      return utils.hasDefinedTypeTag(yieldTag) && !utils.hasYieldValue();\n    };\n\n    // In case a yield value is declared in JSDoc, we also expect one in the code.\n    if (shouldReportYields()) {\n      report(`JSDoc @${preferredYieldTagName} declaration present but yield expression not available in function.`);\n    }\n  }\n\n  if (next) {\n    const [\n      preferredNextTagName,\n      nextTag,\n    ] = checkTagName(\n      utils, report, 'next',\n    );\n    if (preferredNextTagName) {\n      const shouldReportNext = () => {\n        if (nextTag.type.trim() === 'never') {\n          if (utils.hasYieldReturnValue()) {\n            report(`JSDoc @${preferredNextTagName} declaration set with \"never\" but yield expression with return value is present in function.`);\n          }\n\n          return false;\n        }\n\n        if (checkGeneratorsOnly && !utils.isGenerator()) {\n          return true;\n        }\n\n        return utils.hasDefinedTypeTag(nextTag) && !utils.hasYieldReturnValue();\n      };\n\n      if (shouldReportNext()) {\n        report(`JSDoc @${preferredNextTagName} declaration present but yield expression with return value not available in function.`);\n      }\n    }\n  }\n}, {\n  meta: {\n    docs: {\n      description: 'Requires a yield statement in function body if a `@yields` tag is specified in jsdoc comment.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-yields-check',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          checkGeneratorsOnly: {\n            default: false,\n            type: 'boolean',\n          },\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          next: {\n            default: false,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;AAAA;;;;AAEA,MAAMA,OAAO,GAAG,CAACC,KAAD,EAAQC,QAAR,KAAqB;EACnC,MAAMC,WAAW,GAAG,CAClB;EACA;EACA;EACA;EACA;EACA,UANkB,EAOlB,SAPkB,EASlB;EACA;EACA,OAXkB,EAYlB,aAZkB,EAclB;EACA,WAfkB,CAApB;;EAkBA,IAAID,QAAQ,CAACE,IAAT,KAAkB,SAAtB,EAAiC;IAC/B;IACAD,WAAW,CAACE,IAAZ,CAAiB,QAAjB;EACD;;EAED,OAAOJ,KAAK,CAACK,OAAN,CAAcH,WAAd,KACLF,KAAK,CAACM,aAAN,EADK,IAELN,KAAK,CAACO,WAAN,CAAkB,WAAlB,CAFK,IAGLN,QAAQ,CAACE,IAAT,KAAkB,SAAlB,IAA+BH,KAAK,CAACO,WAAN,CAAkB,QAAlB,CAHjC;AAID,CA5BD;;AA8BA,MAAMC,YAAY,GAAG,CAACR,KAAD,EAAQS,MAAR,EAAgBC,OAAhB,KAA4B;EAC/C,MAAMC,gBAAgB,GAAGX,KAAK,CAACY,mBAAN,CAA0B;IACjDF;EADiD,CAA1B,CAAzB;;EAGA,IAAI,CAACC,gBAAL,EAAuB;IACrB,OAAO,EAAP;EACD;;EAED,MAAME,IAAI,GAAGb,KAAK,CAACc,OAAN,CAAcH,gBAAd,CAAb;;EAEA,IAAIE,IAAI,CAACE,MAAL,KAAgB,CAApB,EAAuB;IACrB,OAAO,EAAP;EACD;;EAED,IAAIF,IAAI,CAACE,MAAL,GAAc,CAAlB,EAAqB;IACnBN,MAAM,CAAE,wBAAuBE,gBAAiB,eAA1C,CAAN;IAEA,OAAO,EAAP;EACD;;EAED,OAAO,CACLA,gBADK,EACaE,IAAI,CAAC,CAAD,CADjB,CAAP;AAGD,CAvBD;;eAyBe,IAAAG,qBAAA,EAAa,CAAC;EAC3BC,OAD2B;EAE3BR,MAF2B;EAG3BR,QAH2B;EAI3BD;AAJ2B,CAAD,KAKtB;EACJ,IAAID,OAAO,CAACC,KAAD,EAAQC,QAAR,CAAX,EAA8B;IAC5B;EACD;;EAED,MAAM;IACJiB,IAAI,GAAG,KADH;IAEJC,mBAAmB,GAAG;EAFlB,IAGFF,OAAO,CAACG,OAAR,CAAgB,CAAhB,KAAsB,EAH1B;EAKA,MAAM,CACJC,qBADI,EAEJC,QAFI,IAGFd,YAAY,CACdR,KADc,EACPS,MADO,EACC,QADD,CAHhB;;EAMA,IAAIY,qBAAJ,EAA2B;IACzB,MAAME,kBAAkB,GAAG,MAAM;MAC/B,IAAID,QAAQ,CAACE,IAAT,CAAcC,IAAd,OAAyB,OAA7B,EAAsC;QACpC,IAAIzB,KAAK,CAAC0B,aAAN,EAAJ,EAA2B;UACzBjB,MAAM,CAAE,UAASY,qBAAsB,4EAAjC,CAAN;QACD;;QAED,OAAO,KAAP;MACD;;MAED,IAAIF,mBAAmB,IAAI,CAACnB,KAAK,CAAC2B,WAAN,EAA5B,EAAiD;QAC/C,OAAO,IAAP;MACD;;MAED,OAAO3B,KAAK,CAAC4B,iBAAN,CAAwBN,QAAxB,KAAqC,CAACtB,KAAK,CAAC0B,aAAN,EAA7C;IACD,CAdD,CADyB,CAiBzB;;;IACA,IAAIH,kBAAkB,EAAtB,EAA0B;MACxBd,MAAM,CAAE,UAASY,qBAAsB,sEAAjC,CAAN;IACD;EACF;;EAED,IAAIH,IAAJ,EAAU;IACR,MAAM,CACJW,oBADI,EAEJC,OAFI,IAGFtB,YAAY,CACdR,KADc,EACPS,MADO,EACC,MADD,CAHhB;;IAMA,IAAIoB,oBAAJ,EAA0B;MACxB,MAAME,gBAAgB,GAAG,MAAM;QAC7B,IAAID,OAAO,CAACN,IAAR,CAAaC,IAAb,OAAwB,OAA5B,EAAqC;UACnC,IAAIzB,KAAK,CAACgC,mBAAN,EAAJ,EAAiC;YAC/BvB,MAAM,CAAE,UAASoB,oBAAqB,8FAAhC,CAAN;UACD;;UAED,OAAO,KAAP;QACD;;QAED,IAAIV,mBAAmB,IAAI,CAACnB,KAAK,CAAC2B,WAAN,EAA5B,EAAiD;UAC/C,OAAO,IAAP;QACD;;QAED,OAAO3B,KAAK,CAAC4B,iBAAN,CAAwBE,OAAxB,KAAoC,CAAC9B,KAAK,CAACgC,mBAAN,EAA5C;MACD,CAdD;;MAgBA,IAAID,gBAAgB,EAApB,EAAwB;QACtBtB,MAAM,CAAE,UAASoB,oBAAqB,wFAAhC,CAAN;MACD;IACF;EACF;AACF,CAzEc,EAyEZ;EACDI,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,+FADT;MAEJC,GAAG,EAAE;IAFD,CADF;IAKJC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KADxB;MAEEC,UAAU,EAAE;QACVpB,mBAAmB,EAAE;UACnBqB,OAAO,EAAE,KADU;UAEnBhB,IAAI,EAAE;QAFa,CADX;QAKViB,QAAQ,EAAE;UACRC,KAAK,EAAE;YACLC,KAAK,EAAE,CACL;cACEnB,IAAI,EAAE;YADR,CADK,EAIL;cACEc,oBAAoB,EAAE,KADxB;cAEEC,UAAU,EAAE;gBACVK,OAAO,EAAE;kBACPpB,IAAI,EAAE;gBADC,CADC;gBAIVP,OAAO,EAAE;kBACPO,IAAI,EAAE;gBADC;cAJC,CAFd;cAUEA,IAAI,EAAE;YAVR,CAJK;UADF,CADC;UAoBRA,IAAI,EAAE;QApBE,CALA;QA2BVqB,UAAU,EAAE;UACVH,KAAK,EAAE;YACLlB,IAAI,EAAE;UADD,CADG;UAIVA,IAAI,EAAE;QAJI,CA3BF;QAiCVN,IAAI,EAAE;UACJsB,OAAO,EAAE,KADL;UAEJhB,IAAI,EAAE;QAFF;MAjCI,CAFd;MAwCEA,IAAI,EAAE;IAxCR,CADM,CALJ;IAiDJA,IAAI,EAAE;EAjDF;AADL,CAzEY,C"}
+{"version":3,"file":"requireYieldsCheck.js","names":["canSkip","utils","settings","voidingTags","mode","push","hasATag","isConstructor","classHasTag","checkTagName","report","tagName","preferredTagName","getPreferredTagName","tags","getTags","length","iterateJsdoc","context","next","checkGeneratorsOnly","options","preferredYieldTagName","yieldTag","shouldReportYields","type","trim","hasYieldValue","isGenerator","hasDefinedTypeTag","preferredNextTagName","nextTag","shouldReportNext","hasYieldReturnValue","meta","docs","description","url","schema","additionalProperties","properties","default","contexts","items","anyOf","comment","exemptedBy"],"sources":["../../src/rules/requireYieldsCheck.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc';\n\nconst canSkip = (utils, settings) => {\n  const voidingTags = [\n    // An abstract function is by definition incomplete\n    // so it is perfectly fine if a yield is documented but\n    // not present within the function.\n    // A subclass may inherit the doc and implement the\n    // missing yield.\n    'abstract',\n    'virtual',\n\n    // Constructor functions do not have a yield value\n    //  so we can bail here, too.\n    'class',\n    'constructor',\n\n    // This seems to imply a class as well\n    'interface',\n  ];\n\n  if (settings.mode === 'closure') {\n    // Structural Interface in GCC terms, equivalent to @interface tag as far as this rule is concerned\n    voidingTags.push('record');\n  }\n\n  return utils.hasATag(voidingTags) ||\n    utils.isConstructor() ||\n    utils.classHasTag('interface') ||\n    settings.mode === 'closure' && utils.classHasTag('record');\n};\n\nconst checkTagName = (utils, report, tagName) => {\n  const preferredTagName = utils.getPreferredTagName({\n    tagName,\n  });\n  if (!preferredTagName) {\n    return [];\n  }\n\n  const tags = utils.getTags(preferredTagName);\n\n  if (tags.length === 0) {\n    return [];\n  }\n\n  if (tags.length > 1) {\n    report(`Found more than one @${preferredTagName} declaration.`);\n\n    return [];\n  }\n\n  return [\n    preferredTagName, tags[0],\n  ];\n};\n\nexport default iterateJsdoc(({\n  context,\n  report,\n  settings,\n  utils,\n}) => {\n  if (canSkip(utils, settings)) {\n    return;\n  }\n\n  const {\n    next = false,\n    checkGeneratorsOnly = false,\n  } = context.options[0] || {};\n\n  const [\n    preferredYieldTagName,\n    yieldTag,\n  ] = checkTagName(\n    utils, report, 'yields',\n  );\n  if (preferredYieldTagName) {\n    const shouldReportYields = () => {\n      if (yieldTag.type.trim() === 'never') {\n        if (utils.hasYieldValue()) {\n          report(`JSDoc @${preferredYieldTagName} declaration set with \"never\" but yield expression is present in function.`);\n        }\n\n        return false;\n      }\n\n      if (checkGeneratorsOnly && !utils.isGenerator()) {\n        return true;\n      }\n\n      return utils.hasDefinedTypeTag(yieldTag) && !utils.hasYieldValue();\n    };\n\n    // In case a yield value is declared in JSDoc, we also expect one in the code.\n    if (shouldReportYields()) {\n      report(`JSDoc @${preferredYieldTagName} declaration present but yield expression not available in function.`);\n    }\n  }\n\n  if (next) {\n    const [\n      preferredNextTagName,\n      nextTag,\n    ] = checkTagName(\n      utils, report, 'next',\n    );\n    if (preferredNextTagName) {\n      const shouldReportNext = () => {\n        if (nextTag.type.trim() === 'never') {\n          if (utils.hasYieldReturnValue()) {\n            report(`JSDoc @${preferredNextTagName} declaration set with \"never\" but yield expression with return value is present in function.`);\n          }\n\n          return false;\n        }\n\n        if (checkGeneratorsOnly && !utils.isGenerator()) {\n          return true;\n        }\n\n        return utils.hasDefinedTypeTag(nextTag) && !utils.hasYieldReturnValue();\n      };\n\n      if (shouldReportNext()) {\n        report(`JSDoc @${preferredNextTagName} declaration present but yield expression with return value not available in function.`);\n      }\n    }\n  }\n}, {\n  meta: {\n    docs: {\n      description: 'Requires a yield statement in function body if a `@yields` tag is specified in jsdoc comment.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-yields-check',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          checkGeneratorsOnly: {\n            default: false,\n            type: 'boolean',\n          },\n          contexts: {\n            items: {\n              anyOf: [\n                {\n                  type: 'string',\n                },\n                {\n                  additionalProperties: false,\n                  properties: {\n                    comment: {\n                      type: 'string',\n                    },\n                    context: {\n                      type: 'string',\n                    },\n                  },\n                  type: 'object',\n                },\n              ],\n            },\n            type: 'array',\n          },\n          exemptedBy: {\n            items: {\n              type: 'string',\n            },\n            type: 'array',\n          },\n          next: {\n            default: false,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA;AAA2C;AAE3C,MAAMA,OAAO,GAAG,CAACC,KAAK,EAAEC,QAAQ,KAAK;EACnC,MAAMC,WAAW,GAAG;EAClB;EACA;EACA;EACA;EACA;EACA,UAAU,EACV,SAAS;EAET;EACA;EACA,OAAO,EACP,aAAa;EAEb;EACA,WAAW,CACZ;EAED,IAAID,QAAQ,CAACE,IAAI,KAAK,SAAS,EAAE;IAC/B;IACAD,WAAW,CAACE,IAAI,CAAC,QAAQ,CAAC;EAC5B;EAEA,OAAOJ,KAAK,CAACK,OAAO,CAACH,WAAW,CAAC,IAC/BF,KAAK,CAACM,aAAa,EAAE,IACrBN,KAAK,CAACO,WAAW,CAAC,WAAW,CAAC,IAC9BN,QAAQ,CAACE,IAAI,KAAK,SAAS,IAAIH,KAAK,CAACO,WAAW,CAAC,QAAQ,CAAC;AAC9D,CAAC;AAED,MAAMC,YAAY,GAAG,CAACR,KAAK,EAAES,MAAM,EAAEC,OAAO,KAAK;EAC/C,MAAMC,gBAAgB,GAAGX,KAAK,CAACY,mBAAmB,CAAC;IACjDF;EACF,CAAC,CAAC;EACF,IAAI,CAACC,gBAAgB,EAAE;IACrB,OAAO,EAAE;EACX;EAEA,MAAME,IAAI,GAAGb,KAAK,CAACc,OAAO,CAACH,gBAAgB,CAAC;EAE5C,IAAIE,IAAI,CAACE,MAAM,KAAK,CAAC,EAAE;IACrB,OAAO,EAAE;EACX;EAEA,IAAIF,IAAI,CAACE,MAAM,GAAG,CAAC,EAAE;IACnBN,MAAM,CAAE,wBAAuBE,gBAAiB,eAAc,CAAC;IAE/D,OAAO,EAAE;EACX;EAEA,OAAO,CACLA,gBAAgB,EAAEE,IAAI,CAAC,CAAC,CAAC,CAC1B;AACH,CAAC;AAAC,eAEa,IAAAG,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPR,MAAM;EACNR,QAAQ;EACRD;AACF,CAAC,KAAK;EACJ,IAAID,OAAO,CAACC,KAAK,EAAEC,QAAQ,CAAC,EAAE;IAC5B;EACF;EAEA,MAAM;IACJiB,IAAI,GAAG,KAAK;IACZC,mBAAmB,GAAG;EACxB,CAAC,GAAGF,OAAO,CAACG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,MAAM,CACJC,qBAAqB,EACrBC,QAAQ,CACT,GAAGd,YAAY,CACdR,KAAK,EAAES,MAAM,EAAE,QAAQ,CACxB;EACD,IAAIY,qBAAqB,EAAE;IACzB,MAAME,kBAAkB,GAAG,MAAM;MAC/B,IAAID,QAAQ,CAACE,IAAI,CAACC,IAAI,EAAE,KAAK,OAAO,EAAE;QACpC,IAAIzB,KAAK,CAAC0B,aAAa,EAAE,EAAE;UACzBjB,MAAM,CAAE,UAASY,qBAAsB,4EAA2E,CAAC;QACrH;QAEA,OAAO,KAAK;MACd;MAEA,IAAIF,mBAAmB,IAAI,CAACnB,KAAK,CAAC2B,WAAW,EAAE,EAAE;QAC/C,OAAO,IAAI;MACb;MAEA,OAAO3B,KAAK,CAAC4B,iBAAiB,CAACN,QAAQ,CAAC,IAAI,CAACtB,KAAK,CAAC0B,aAAa,EAAE;IACpE,CAAC;;IAED;IACA,IAAIH,kBAAkB,EAAE,EAAE;MACxBd,MAAM,CAAE,UAASY,qBAAsB,sEAAqE,CAAC;IAC/G;EACF;EAEA,IAAIH,IAAI,EAAE;IACR,MAAM,CACJW,oBAAoB,EACpBC,OAAO,CACR,GAAGtB,YAAY,CACdR,KAAK,EAAES,MAAM,EAAE,MAAM,CACtB;IACD,IAAIoB,oBAAoB,EAAE;MACxB,MAAME,gBAAgB,GAAG,MAAM;QAC7B,IAAID,OAAO,CAACN,IAAI,CAACC,IAAI,EAAE,KAAK,OAAO,EAAE;UACnC,IAAIzB,KAAK,CAACgC,mBAAmB,EAAE,EAAE;YAC/BvB,MAAM,CAAE,UAASoB,oBAAqB,8FAA6F,CAAC;UACtI;UAEA,OAAO,KAAK;QACd;QAEA,IAAIV,mBAAmB,IAAI,CAACnB,KAAK,CAAC2B,WAAW,EAAE,EAAE;UAC/C,OAAO,IAAI;QACb;QAEA,OAAO3B,KAAK,CAAC4B,iBAAiB,CAACE,OAAO,CAAC,IAAI,CAAC9B,KAAK,CAACgC,mBAAmB,EAAE;MACzE,CAAC;MAED,IAAID,gBAAgB,EAAE,EAAE;QACtBtB,MAAM,CAAE,UAASoB,oBAAqB,wFAAuF,CAAC;MAChI;IACF;EACF;AACF,CAAC,EAAE;EACDI,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,+FAA+F;MAC5GC,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVpB,mBAAmB,EAAE;UACnBqB,OAAO,EAAE,KAAK;UACdhB,IAAI,EAAE;QACR,CAAC;QACDiB,QAAQ,EAAE;UACRC,KAAK,EAAE;YACLC,KAAK,EAAE,CACL;cACEnB,IAAI,EAAE;YACR,CAAC,EACD;cACEc,oBAAoB,EAAE,KAAK;cAC3BC,UAAU,EAAE;gBACVK,OAAO,EAAE;kBACPpB,IAAI,EAAE;gBACR,CAAC;gBACDP,OAAO,EAAE;kBACPO,IAAI,EAAE;gBACR;cACF,CAAC;cACDA,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACDqB,UAAU,EAAE;UACVH,KAAK,EAAE;YACLlB,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACDN,IAAI,EAAE;UACJsB,OAAO,EAAE,KAAK;UACdhB,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA;AAAA"}

package/dist/rules/sortTags.js

@@ -4,13 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _defaultTagOrder = _interopRequireDefault(require("../defaultTagOrder"));
-
 var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 var _default = (0, _iterateJsdoc.default)(({
   context,
   jsdoc,
@@ -23,13 +19,11 @@ var _default = (0, _iterateJsdoc.default)(({
   const otherPos = tagSequence.indexOf('-other');
   const endPos = otherPos > -1 ? otherPos : tagSequence.length;
   let ongoingCount = 0;
-
   for (const [idx, tag] of jsdoc.tags.entries()) {
     tag.originalIndex = idx;
     ongoingCount += tag.source.length;
     tag.originalLine = ongoingCount;
   }
-
   let firstChangedTagLine;
   let firstChangedTagIndex;
   const sortedTags = JSON.parse(JSON.stringify(jsdoc.tags));
@@ -44,51 +38,44 @@ var _default = (0, _iterateJsdoc.default)(({
     if (tagNew === tagOld) {
       return 0;
     }
-
     const checkOrSetFirstChanged = () => {
       if (!firstChangedTagLine || originalLine < firstChangedTagLine) {
         firstChangedTagLine = originalLine;
         firstChangedTagIndex = originalIndex;
       }
     };
-
     const newPos = tagSequence.indexOf(tagNew);
     const oldPos = tagSequence.indexOf(tagOld);
     const preferredNewPos = newPos === -1 ? endPos : newPos;
     const preferredOldPos = oldPos === -1 ? endPos : oldPos;
-
     if (preferredNewPos < preferredOldPos) {
       checkOrSetFirstChanged();
       return -1;
     }
-
     if (preferredNewPos > preferredOldPos) {
       return 1;
-    } // preferredNewPos === preferredOldPos
-
+    }
 
-    if (!alphabetizeExtras || // Optimize: If tagNew (or tagOld which is the same) was found in the
+    // preferredNewPos === preferredOldPos
+    if (!alphabetizeExtras ||
+    // Optimize: If tagNew (or tagOld which is the same) was found in the
     //   priority array, it can maintain its relative position—without need
     //   of alphabetizing (secondary sorting)
     newPos >= 0) {
       return 0;
     }
-
     if (tagNew < tagOld) {
       checkOrSetFirstChanged();
       return -1;
-    } // tagNew > tagOld
-
+    }
 
+    // tagNew > tagOld
     return 1;
   });
-
   if (firstChangedTagLine === undefined) {
     return;
   }
-
   const firstLine = utils.getFirstLine();
-
   const fix = () => {
     const itemsToMoveRange = [...Array.from({
       length: jsdoc.tags.length - firstChangedTagIndex
@@ -97,33 +84,35 @@ var _default = (0, _iterateJsdoc.default)(({
       source
     }) => {
       return ct + source.length - 1;
-    }, 0); // This offset includes not only the offset from where the first tag
+    }, 0);
+
+    // This offset includes not only the offset from where the first tag
     //   must begin, and the additional offset of where the first changed
     //   tag begins, but it must also account for prior descriptions
+    const initialOffset = firstLine + firstChangedTagIndex +
+    // May be the first tag, so don't try finding a prior one if so
+    unchangedPriorTagDescriptions;
 
-    const initialOffset = firstLine + firstChangedTagIndex + // May be the first tag, so don't try finding a prior one if so
-    unchangedPriorTagDescriptions; // Use `firstChangedTagLine` for line number to begin reporting/splicing
-
+    // Use `firstChangedTagLine` for line number to begin reporting/splicing
     for (const idx of itemsToMoveRange) {
       utils.removeTag(idx + firstChangedTagIndex);
     }
-
     const changedTags = sortedTags.slice(firstChangedTagIndex);
     let extraTagCount = 0;
-
     for (const idx of itemsToMoveRange) {
       const changedTag = changedTags[idx];
-      utils.addTag(changedTag.tag, extraTagCount + initialOffset + idx, { ...changedTag.source[0].tokens,
+      utils.addTag(changedTag.tag, extraTagCount + initialOffset + idx, {
+        ...changedTag.source[0].tokens,
         // `comment-parser` puts the `end` within the `tags` section, so
         //   avoid adding another to jsdoc.source
         end: ''
       });
-
       for (const {
         tokens
       } of changedTag.source.slice(1)) {
         if (!tokens.end) {
-          utils.addLine(extraTagCount + initialOffset + idx + 1, { ...tokens,
+          utils.addLine(extraTagCount + initialOffset + idx + 1, {
+            ...tokens,
             end: ''
           });
           extraTagCount++;
@@ -131,7 +120,6 @@ var _default = (0, _iterateJsdoc.default)(({
       }
     }
   };
-
   utils.reportJSDoc(`Tags are not in the prescribed order: ${tagSequence.join(', ')}`, jsdoc.tags[firstChangedTagIndex], fix, true);
 }, {
   iterateAllJsdocs: true,
@@ -159,7 +147,6 @@ var _default = (0, _iterateJsdoc.default)(({
     type: 'suggestion'
   }
 });
-
 exports.default = _default;
 module.exports = exports.default;
 //# sourceMappingURL=sortTags.js.map

package/dist/rules/sortTags.js.map

@@ -1 +1 @@
-{"version":3,"file":"sortTags.js","names":["iterateJsdoc","context","jsdoc","utils","tagSequence","defaultTagOrder","alphabetizeExtras","options","otherPos","indexOf","endPos","length","ongoingCount","idx","tag","tags","entries","originalIndex","source","originalLine","firstChangedTagLine","firstChangedTagIndex","sortedTags","JSON","parse","stringify","sort","tagNew","tagOld","checkOrSetFirstChanged","newPos","oldPos","preferredNewPos","preferredOldPos","undefined","firstLine","getFirstLine","fix","itemsToMoveRange","Array","from","keys","unchangedPriorTagDescriptions","slice","reduce","ct","initialOffset","removeTag","changedTags","extraTagCount","changedTag","addTag","tokens","end","addLine","reportJSDoc","join","iterateAllJsdocs","meta","docs","description","url","fixable","schema","additionalProperies","properties","type","items"],"sources":["../../src/rules/sortTags.js"],"sourcesContent":["import defaultTagOrder from '../defaultTagOrder';\nimport iterateJsdoc from '../iterateJsdoc';\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  const {\n    tagSequence = defaultTagOrder,\n    alphabetizeExtras = false,\n  } = context.options[0] || {};\n\n  const otherPos = tagSequence.indexOf('-other');\n  const endPos = otherPos > -1 ? otherPos : tagSequence.length;\n\n  let ongoingCount = 0;\n  for (const [\n    idx,\n    tag,\n  ] of jsdoc.tags.entries()) {\n    tag.originalIndex = idx;\n    ongoingCount += tag.source.length;\n    tag.originalLine = ongoingCount;\n  }\n\n  let firstChangedTagLine;\n  let firstChangedTagIndex;\n  const sortedTags = JSON.parse(JSON.stringify(jsdoc.tags));\n  sortedTags.sort(({\n    tag: tagNew,\n  }, {\n    originalIndex,\n    originalLine,\n    tag: tagOld,\n  }) => {\n    // Optimize: Just keep relative positions if the same tag name\n    if (tagNew === tagOld) {\n      return 0;\n    }\n\n    const checkOrSetFirstChanged = () => {\n      if (!firstChangedTagLine || originalLine < firstChangedTagLine) {\n        firstChangedTagLine = originalLine;\n        firstChangedTagIndex = originalIndex;\n      }\n    };\n\n    const newPos = tagSequence.indexOf(tagNew);\n    const oldPos = tagSequence.indexOf(tagOld);\n\n    const preferredNewPos = newPos === -1 ? endPos : newPos;\n    const preferredOldPos = oldPos === -1 ? endPos : oldPos;\n\n    if (preferredNewPos < preferredOldPos) {\n      checkOrSetFirstChanged();\n      return -1;\n    }\n\n    if (preferredNewPos > preferredOldPos) {\n      return 1;\n    }\n\n    // preferredNewPos === preferredOldPos\n    if (\n      !alphabetizeExtras ||\n\n      // Optimize: If tagNew (or tagOld which is the same) was found in the\n      //   priority array, it can maintain its relative position—without need\n      //   of alphabetizing (secondary sorting)\n      newPos >= 0\n    ) {\n      return 0;\n    }\n\n    if (tagNew < tagOld) {\n      checkOrSetFirstChanged();\n      return -1;\n    }\n\n    // tagNew > tagOld\n    return 1;\n  });\n\n  if (firstChangedTagLine === undefined) {\n    return;\n  }\n\n  const firstLine = utils.getFirstLine();\n\n  const fix = () => {\n    const itemsToMoveRange = [\n      ...Array.from({\n        length: jsdoc.tags.length - firstChangedTagIndex,\n      }).keys(),\n    ];\n\n    const unchangedPriorTagDescriptions = jsdoc.tags.slice(\n      0,\n      firstChangedTagIndex,\n    ).reduce((ct, {\n      source,\n    }) => {\n      return ct + source.length - 1;\n    }, 0);\n\n    // This offset includes not only the offset from where the first tag\n    //   must begin, and the additional offset of where the first changed\n    //   tag begins, but it must also account for prior descriptions\n    const initialOffset = firstLine + firstChangedTagIndex +\n\n      // May be the first tag, so don't try finding a prior one if so\n      unchangedPriorTagDescriptions;\n\n    // Use `firstChangedTagLine` for line number to begin reporting/splicing\n    for (const idx of itemsToMoveRange) {\n      utils.removeTag(idx + firstChangedTagIndex);\n    }\n\n    const changedTags = sortedTags.slice(firstChangedTagIndex);\n    let extraTagCount = 0;\n\n    for (const idx of itemsToMoveRange) {\n      const changedTag = changedTags[idx];\n\n      utils.addTag(\n        changedTag.tag,\n        extraTagCount + initialOffset + idx,\n        {\n          ...changedTag.source[0].tokens,\n\n          // `comment-parser` puts the `end` within the `tags` section, so\n          //   avoid adding another to jsdoc.source\n          end: '',\n        },\n      );\n\n      for (const {\n        tokens,\n      } of changedTag.source.slice(1)) {\n        if (!tokens.end) {\n          utils.addLine(\n            extraTagCount + initialOffset + idx + 1,\n            {\n              ...tokens,\n              end: '',\n            },\n          );\n          extraTagCount++;\n        }\n      }\n    }\n  };\n\n  utils.reportJSDoc(\n    `Tags are not in the prescribed order: ${tagSequence.join(', ')}`,\n    jsdoc.tags[firstChangedTagIndex],\n    fix,\n    true,\n  );\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: '',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-sort-tags',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperies: false,\n        properties: {\n          alphabetizeExtras: {\n            type: 'boolean',\n          },\n          tagSequence: {\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;;;;eAEe,IAAAA,qBAAA,EAAa,CAAC;EAC3BC,OAD2B;EAE3BC,KAF2B;EAG3BC;AAH2B,CAAD,KAItB;EACJ,MAAM;IACJC,WAAW,GAAGC,wBADV;IAEJC,iBAAiB,GAAG;EAFhB,IAGFL,OAAO,CAACM,OAAR,CAAgB,CAAhB,KAAsB,EAH1B;EAKA,MAAMC,QAAQ,GAAGJ,WAAW,CAACK,OAAZ,CAAoB,QAApB,CAAjB;EACA,MAAMC,MAAM,GAAGF,QAAQ,GAAG,CAAC,CAAZ,GAAgBA,QAAhB,GAA2BJ,WAAW,CAACO,MAAtD;EAEA,IAAIC,YAAY,GAAG,CAAnB;;EACA,KAAK,MAAM,CACTC,GADS,EAETC,GAFS,CAAX,IAGKZ,KAAK,CAACa,IAAN,CAAWC,OAAX,EAHL,EAG2B;IACzBF,GAAG,CAACG,aAAJ,GAAoBJ,GAApB;IACAD,YAAY,IAAIE,GAAG,CAACI,MAAJ,CAAWP,MAA3B;IACAG,GAAG,CAACK,YAAJ,GAAmBP,YAAnB;EACD;;EAED,IAAIQ,mBAAJ;EACA,IAAIC,oBAAJ;EACA,MAAMC,UAAU,GAAGC,IAAI,CAACC,KAAL,CAAWD,IAAI,CAACE,SAAL,CAAevB,KAAK,CAACa,IAArB,CAAX,CAAnB;EACAO,UAAU,CAACI,IAAX,CAAgB,CAAC;IACfZ,GAAG,EAAEa;EADU,CAAD,EAEb;IACDV,aADC;IAEDE,YAFC;IAGDL,GAAG,EAAEc;EAHJ,CAFa,KAMV;IACJ;IACA,IAAID,MAAM,KAAKC,MAAf,EAAuB;MACrB,OAAO,CAAP;IACD;;IAED,MAAMC,sBAAsB,GAAG,MAAM;MACnC,IAAI,CAACT,mBAAD,IAAwBD,YAAY,GAAGC,mBAA3C,EAAgE;QAC9DA,mBAAmB,GAAGD,YAAtB;QACAE,oBAAoB,GAAGJ,aAAvB;MACD;IACF,CALD;;IAOA,MAAMa,MAAM,GAAG1B,WAAW,CAACK,OAAZ,CAAoBkB,MAApB,CAAf;IACA,MAAMI,MAAM,GAAG3B,WAAW,CAACK,OAAZ,CAAoBmB,MAApB,CAAf;IAEA,MAAMI,eAAe,GAAGF,MAAM,KAAK,CAAC,CAAZ,GAAgBpB,MAAhB,GAAyBoB,MAAjD;IACA,MAAMG,eAAe,GAAGF,MAAM,KAAK,CAAC,CAAZ,GAAgBrB,MAAhB,GAAyBqB,MAAjD;;IAEA,IAAIC,eAAe,GAAGC,eAAtB,EAAuC;MACrCJ,sBAAsB;MACtB,OAAO,CAAC,CAAR;IACD;;IAED,IAAIG,eAAe,GAAGC,eAAtB,EAAuC;MACrC,OAAO,CAAP;IACD,CA1BG,CA4BJ;;;IACA,IACE,CAAC3B,iBAAD,IAEA;IACA;IACA;IACAwB,MAAM,IAAI,CANZ,EAOE;MACA,OAAO,CAAP;IACD;;IAED,IAAIH,MAAM,GAAGC,MAAb,EAAqB;MACnBC,sBAAsB;MACtB,OAAO,CAAC,CAAR;IACD,CA3CG,CA6CJ;;;IACA,OAAO,CAAP;EACD,CArDD;;EAuDA,IAAIT,mBAAmB,KAAKc,SAA5B,EAAuC;IACrC;EACD;;EAED,MAAMC,SAAS,GAAGhC,KAAK,CAACiC,YAAN,EAAlB;;EAEA,MAAMC,GAAG,GAAG,MAAM;IAChB,MAAMC,gBAAgB,GAAG,CACvB,GAAGC,KAAK,CAACC,IAAN,CAAW;MACZ7B,MAAM,EAAET,KAAK,CAACa,IAAN,CAAWJ,MAAX,GAAoBU;IADhB,CAAX,EAEAoB,IAFA,EADoB,CAAzB;IAMA,MAAMC,6BAA6B,GAAGxC,KAAK,CAACa,IAAN,CAAW4B,KAAX,CACpC,CADoC,EAEpCtB,oBAFoC,EAGpCuB,MAHoC,CAG7B,CAACC,EAAD,EAAK;MACZ3B;IADY,CAAL,KAEH;MACJ,OAAO2B,EAAE,GAAG3B,MAAM,CAACP,MAAZ,GAAqB,CAA5B;IACD,CAPqC,EAOnC,CAPmC,CAAtC,CAPgB,CAgBhB;IACA;IACA;;IACA,MAAMmC,aAAa,GAAGX,SAAS,GAAGd,oBAAZ,GAEpB;IACAqB,6BAHF,CAnBgB,CAwBhB;;IACA,KAAK,MAAM7B,GAAX,IAAkByB,gBAAlB,EAAoC;MAClCnC,KAAK,CAAC4C,SAAN,CAAgBlC,GAAG,GAAGQ,oBAAtB;IACD;;IAED,MAAM2B,WAAW,GAAG1B,UAAU,CAACqB,KAAX,CAAiBtB,oBAAjB,CAApB;IACA,IAAI4B,aAAa,GAAG,CAApB;;IAEA,KAAK,MAAMpC,GAAX,IAAkByB,gBAAlB,EAAoC;MAClC,MAAMY,UAAU,GAAGF,WAAW,CAACnC,GAAD,CAA9B;MAEAV,KAAK,CAACgD,MAAN,CACED,UAAU,CAACpC,GADb,EAEEmC,aAAa,GAAGH,aAAhB,GAAgCjC,GAFlC,EAGE,EACE,GAAGqC,UAAU,CAAChC,MAAX,CAAkB,CAAlB,EAAqBkC,MAD1B;QAGE;QACA;QACAC,GAAG,EAAE;MALP,CAHF;;MAYA,KAAK,MAAM;QACTD;MADS,CAAX,IAEKF,UAAU,CAAChC,MAAX,CAAkByB,KAAlB,CAAwB,CAAxB,CAFL,EAEiC;QAC/B,IAAI,CAACS,MAAM,CAACC,GAAZ,EAAiB;UACflD,KAAK,CAACmD,OAAN,CACEL,aAAa,GAAGH,aAAhB,GAAgCjC,GAAhC,GAAsC,CADxC,EAEE,EACE,GAAGuC,MADL;YAEEC,GAAG,EAAE;UAFP,CAFF;UAOAJ,aAAa;QACd;MACF;IACF;EACF,CA9DD;;EAgEA9C,KAAK,CAACoD,WAAN,CACG,yCAAwCnD,WAAW,CAACoD,IAAZ,CAAiB,IAAjB,CAAuB,EADlE,EAEEtD,KAAK,CAACa,IAAN,CAAWM,oBAAX,CAFF,EAGEgB,GAHF,EAIE,IAJF;AAMD,CA7Jc,EA6JZ;EACDoB,gBAAgB,EAAE,IADjB;EAEDC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,EADT;MAEJC,GAAG,EAAE;IAFD,CADF;IAKJC,OAAO,EAAE,MALL;IAMJC,MAAM,EAAE,CACN;MACEC,mBAAmB,EAAE,KADvB;MAEEC,UAAU,EAAE;QACV3D,iBAAiB,EAAE;UACjB4D,IAAI,EAAE;QADW,CADT;QAIV9D,WAAW,EAAE;UACX+D,KAAK,EAAE;YACLD,IAAI,EAAE;UADD,CADI;UAIXA,IAAI,EAAE;QAJK;MAJH,CAFd;MAaEA,IAAI,EAAE;IAbR,CADM,CANJ;IAuBJA,IAAI,EAAE;EAvBF;AAFL,CA7JY,C"}
+{"version":3,"file":"sortTags.js","names":["iterateJsdoc","context","jsdoc","utils","tagSequence","defaultTagOrder","alphabetizeExtras","options","otherPos","indexOf","endPos","length","ongoingCount","idx","tag","tags","entries","originalIndex","source","originalLine","firstChangedTagLine","firstChangedTagIndex","sortedTags","JSON","parse","stringify","sort","tagNew","tagOld","checkOrSetFirstChanged","newPos","oldPos","preferredNewPos","preferredOldPos","undefined","firstLine","getFirstLine","fix","itemsToMoveRange","Array","from","keys","unchangedPriorTagDescriptions","slice","reduce","ct","initialOffset","removeTag","changedTags","extraTagCount","changedTag","addTag","tokens","end","addLine","reportJSDoc","join","iterateAllJsdocs","meta","docs","description","url","fixable","schema","additionalProperies","properties","type","items"],"sources":["../../src/rules/sortTags.js"],"sourcesContent":["import defaultTagOrder from '../defaultTagOrder';\nimport iterateJsdoc from '../iterateJsdoc';\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  const {\n    tagSequence = defaultTagOrder,\n    alphabetizeExtras = false,\n  } = context.options[0] || {};\n\n  const otherPos = tagSequence.indexOf('-other');\n  const endPos = otherPos > -1 ? otherPos : tagSequence.length;\n\n  let ongoingCount = 0;\n  for (const [\n    idx,\n    tag,\n  ] of jsdoc.tags.entries()) {\n    tag.originalIndex = idx;\n    ongoingCount += tag.source.length;\n    tag.originalLine = ongoingCount;\n  }\n\n  let firstChangedTagLine;\n  let firstChangedTagIndex;\n  const sortedTags = JSON.parse(JSON.stringify(jsdoc.tags));\n  sortedTags.sort(({\n    tag: tagNew,\n  }, {\n    originalIndex,\n    originalLine,\n    tag: tagOld,\n  }) => {\n    // Optimize: Just keep relative positions if the same tag name\n    if (tagNew === tagOld) {\n      return 0;\n    }\n\n    const checkOrSetFirstChanged = () => {\n      if (!firstChangedTagLine || originalLine < firstChangedTagLine) {\n        firstChangedTagLine = originalLine;\n        firstChangedTagIndex = originalIndex;\n      }\n    };\n\n    const newPos = tagSequence.indexOf(tagNew);\n    const oldPos = tagSequence.indexOf(tagOld);\n\n    const preferredNewPos = newPos === -1 ? endPos : newPos;\n    const preferredOldPos = oldPos === -1 ? endPos : oldPos;\n\n    if (preferredNewPos < preferredOldPos) {\n      checkOrSetFirstChanged();\n      return -1;\n    }\n\n    if (preferredNewPos > preferredOldPos) {\n      return 1;\n    }\n\n    // preferredNewPos === preferredOldPos\n    if (\n      !alphabetizeExtras ||\n\n      // Optimize: If tagNew (or tagOld which is the same) was found in the\n      //   priority array, it can maintain its relative position—without need\n      //   of alphabetizing (secondary sorting)\n      newPos >= 0\n    ) {\n      return 0;\n    }\n\n    if (tagNew < tagOld) {\n      checkOrSetFirstChanged();\n      return -1;\n    }\n\n    // tagNew > tagOld\n    return 1;\n  });\n\n  if (firstChangedTagLine === undefined) {\n    return;\n  }\n\n  const firstLine = utils.getFirstLine();\n\n  const fix = () => {\n    const itemsToMoveRange = [\n      ...Array.from({\n        length: jsdoc.tags.length - firstChangedTagIndex,\n      }).keys(),\n    ];\n\n    const unchangedPriorTagDescriptions = jsdoc.tags.slice(\n      0,\n      firstChangedTagIndex,\n    ).reduce((ct, {\n      source,\n    }) => {\n      return ct + source.length - 1;\n    }, 0);\n\n    // This offset includes not only the offset from where the first tag\n    //   must begin, and the additional offset of where the first changed\n    //   tag begins, but it must also account for prior descriptions\n    const initialOffset = firstLine + firstChangedTagIndex +\n\n      // May be the first tag, so don't try finding a prior one if so\n      unchangedPriorTagDescriptions;\n\n    // Use `firstChangedTagLine` for line number to begin reporting/splicing\n    for (const idx of itemsToMoveRange) {\n      utils.removeTag(idx + firstChangedTagIndex);\n    }\n\n    const changedTags = sortedTags.slice(firstChangedTagIndex);\n    let extraTagCount = 0;\n\n    for (const idx of itemsToMoveRange) {\n      const changedTag = changedTags[idx];\n\n      utils.addTag(\n        changedTag.tag,\n        extraTagCount + initialOffset + idx,\n        {\n          ...changedTag.source[0].tokens,\n\n          // `comment-parser` puts the `end` within the `tags` section, so\n          //   avoid adding another to jsdoc.source\n          end: '',\n        },\n      );\n\n      for (const {\n        tokens,\n      } of changedTag.source.slice(1)) {\n        if (!tokens.end) {\n          utils.addLine(\n            extraTagCount + initialOffset + idx + 1,\n            {\n              ...tokens,\n              end: '',\n            },\n          );\n          extraTagCount++;\n        }\n      }\n    }\n  };\n\n  utils.reportJSDoc(\n    `Tags are not in the prescribed order: ${tagSequence.join(', ')}`,\n    jsdoc.tags[firstChangedTagIndex],\n    fix,\n    true,\n  );\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: '',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-sort-tags',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperies: false,\n        properties: {\n          alphabetizeExtras: {\n            type: 'boolean',\n          },\n          tagSequence: {\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;AAA2C;AAAA,eAE5B,IAAAA,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,KAAK;EACLC;AACF,CAAC,KAAK;EACJ,MAAM;IACJC,WAAW,GAAGC,wBAAe;IAC7BC,iBAAiB,GAAG;EACtB,CAAC,GAAGL,OAAO,CAACM,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,MAAMC,QAAQ,GAAGJ,WAAW,CAACK,OAAO,CAAC,QAAQ,CAAC;EAC9C,MAAMC,MAAM,GAAGF,QAAQ,GAAG,CAAC,CAAC,GAAGA,QAAQ,GAAGJ,WAAW,CAACO,MAAM;EAE5D,IAAIC,YAAY,GAAG,CAAC;EACpB,KAAK,MAAM,CACTC,GAAG,EACHC,GAAG,CACJ,IAAIZ,KAAK,CAACa,IAAI,CAACC,OAAO,EAAE,EAAE;IACzBF,GAAG,CAACG,aAAa,GAAGJ,GAAG;IACvBD,YAAY,IAAIE,GAAG,CAACI,MAAM,CAACP,MAAM;IACjCG,GAAG,CAACK,YAAY,GAAGP,YAAY;EACjC;EAEA,IAAIQ,mBAAmB;EACvB,IAAIC,oBAAoB;EACxB,MAAMC,UAAU,GAAGC,IAAI,CAACC,KAAK,CAACD,IAAI,CAACE,SAAS,CAACvB,KAAK,CAACa,IAAI,CAAC,CAAC;EACzDO,UAAU,CAACI,IAAI,CAAC,CAAC;IACfZ,GAAG,EAAEa;EACP,CAAC,EAAE;IACDV,aAAa;IACbE,YAAY;IACZL,GAAG,EAAEc;EACP,CAAC,KAAK;IACJ;IACA,IAAID,MAAM,KAAKC,MAAM,EAAE;MACrB,OAAO,CAAC;IACV;IAEA,MAAMC,sBAAsB,GAAG,MAAM;MACnC,IAAI,CAACT,mBAAmB,IAAID,YAAY,GAAGC,mBAAmB,EAAE;QAC9DA,mBAAmB,GAAGD,YAAY;QAClCE,oBAAoB,GAAGJ,aAAa;MACtC;IACF,CAAC;IAED,MAAMa,MAAM,GAAG1B,WAAW,CAACK,OAAO,CAACkB,MAAM,CAAC;IAC1C,MAAMI,MAAM,GAAG3B,WAAW,CAACK,OAAO,CAACmB,MAAM,CAAC;IAE1C,MAAMI,eAAe,GAAGF,MAAM,KAAK,CAAC,CAAC,GAAGpB,MAAM,GAAGoB,MAAM;IACvD,MAAMG,eAAe,GAAGF,MAAM,KAAK,CAAC,CAAC,GAAGrB,MAAM,GAAGqB,MAAM;IAEvD,IAAIC,eAAe,GAAGC,eAAe,EAAE;MACrCJ,sBAAsB,EAAE;MACxB,OAAO,CAAC,CAAC;IACX;IAEA,IAAIG,eAAe,GAAGC,eAAe,EAAE;MACrC,OAAO,CAAC;IACV;;IAEA;IACA,IACE,CAAC3B,iBAAiB;IAElB;IACA;IACA;IACAwB,MAAM,IAAI,CAAC,EACX;MACA,OAAO,CAAC;IACV;IAEA,IAAIH,MAAM,GAAGC,MAAM,EAAE;MACnBC,sBAAsB,EAAE;MACxB,OAAO,CAAC,CAAC;IACX;;IAEA;IACA,OAAO,CAAC;EACV,CAAC,CAAC;EAEF,IAAIT,mBAAmB,KAAKc,SAAS,EAAE;IACrC;EACF;EAEA,MAAMC,SAAS,GAAGhC,KAAK,CAACiC,YAAY,EAAE;EAEtC,MAAMC,GAAG,GAAG,MAAM;IAChB,MAAMC,gBAAgB,GAAG,CACvB,GAAGC,KAAK,CAACC,IAAI,CAAC;MACZ7B,MAAM,EAAET,KAAK,CAACa,IAAI,CAACJ,MAAM,GAAGU;IAC9B,CAAC,CAAC,CAACoB,IAAI,EAAE,CACV;IAED,MAAMC,6BAA6B,GAAGxC,KAAK,CAACa,IAAI,CAAC4B,KAAK,CACpD,CAAC,EACDtB,oBAAoB,CACrB,CAACuB,MAAM,CAAC,CAACC,EAAE,EAAE;MACZ3B;IACF,CAAC,KAAK;MACJ,OAAO2B,EAAE,GAAG3B,MAAM,CAACP,MAAM,GAAG,CAAC;IAC/B,CAAC,EAAE,CAAC,CAAC;;IAEL;IACA;IACA;IACA,MAAMmC,aAAa,GAAGX,SAAS,GAAGd,oBAAoB;IAEpD;IACAqB,6BAA6B;;IAE/B;IACA,KAAK,MAAM7B,GAAG,IAAIyB,gBAAgB,EAAE;MAClCnC,KAAK,CAAC4C,SAAS,CAAClC,GAAG,GAAGQ,oBAAoB,CAAC;IAC7C;IAEA,MAAM2B,WAAW,GAAG1B,UAAU,CAACqB,KAAK,CAACtB,oBAAoB,CAAC;IAC1D,IAAI4B,aAAa,GAAG,CAAC;IAErB,KAAK,MAAMpC,GAAG,IAAIyB,gBAAgB,EAAE;MAClC,MAAMY,UAAU,GAAGF,WAAW,CAACnC,GAAG,CAAC;MAEnCV,KAAK,CAACgD,MAAM,CACVD,UAAU,CAACpC,GAAG,EACdmC,aAAa,GAAGH,aAAa,GAAGjC,GAAG,EACnC;QACE,GAAGqC,UAAU,CAAChC,MAAM,CAAC,CAAC,CAAC,CAACkC,MAAM;QAE9B;QACA;QACAC,GAAG,EAAE;MACP,CAAC,CACF;MAED,KAAK,MAAM;QACTD;MACF,CAAC,IAAIF,UAAU,CAAChC,MAAM,CAACyB,KAAK,CAAC,CAAC,CAAC,EAAE;QAC/B,IAAI,CAACS,MAAM,CAACC,GAAG,EAAE;UACflD,KAAK,CAACmD,OAAO,CACXL,aAAa,GAAGH,aAAa,GAAGjC,GAAG,GAAG,CAAC,EACvC;YACE,GAAGuC,MAAM;YACTC,GAAG,EAAE;UACP,CAAC,CACF;UACDJ,aAAa,EAAE;QACjB;MACF;IACF;EACF,CAAC;EAED9C,KAAK,CAACoD,WAAW,CACd,yCAAwCnD,WAAW,CAACoD,IAAI,CAAC,IAAI,CAAE,EAAC,EACjEtD,KAAK,CAACa,IAAI,CAACM,oBAAoB,CAAC,EAChCgB,GAAG,EACH,IAAI,CACL;AACH,CAAC,EAAE;EACDoB,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,EAAE;MACfC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,mBAAmB,EAAE,KAAK;MAC1BC,UAAU,EAAE;QACV3D,iBAAiB,EAAE;UACjB4D,IAAI,EAAE;QACR,CAAC;QACD9D,WAAW,EAAE;UACX+D,KAAK,EAAE;YACLD,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA;AAAA"}