eslint-plugin-jsdoc/dist/rules/checkTemplateNames.cjs.map

JSDoc linting rules for ESLint.

{"version":3,"file":"checkTemplateNames.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","_jsdoccomment","e","__esModule","default","_default","exports","iterateJsdoc","node","report","settings","utils","mode","templateTags","getTags","usedNames","Set","checkForUsedTypes","potentialType","parsedType","tryParseType","parseType","traverse","nde","type","value","add","checkParamsAndReturnsTags","paramName","getPreferredTagName","tagName","paramTags","paramTag","returnsName","returnsTags","returnsTag","checkTemplateTags","tag","name","names","split","nme","has","checkParameters","aliasDeclaration","checkParamsAndReturns","params","typeParameters","handleTypeAliases","declaration","callbackTags","functionTags","length","typedefTags","potentialTypedefType","propertyName","propertyTags","propertyTag","iterateAllJsdocs","meta","docs","description","url","schema","module"],"sources":["../../src/rules/checkTemplateNames.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  parse as parseType,\n  traverse,\n  tryParse as tryParseType,\n} from '@es-joy/jsdoccomment';\n\nexport default iterateJsdoc(({\n  node,\n  report,\n  settings,\n  utils,\n}) => {\n  const {\n    mode,\n  } = settings;\n\n  const templateTags = utils.getTags('template');\n\n  const usedNames = new Set();\n  /**\n   * @param {string} potentialType\n   */\n  const checkForUsedTypes = (potentialType) => {\n    let parsedType;\n    try {\n      parsedType = mode === 'permissive' ?\n        tryParseType(/** @type {string} */ (potentialType)) :\n        parseType(/** @type {string} */ (potentialType), mode);\n    } catch {\n      return;\n    }\n\n    traverse(parsedType, (nde) => {\n      const {\n        type,\n        value,\n      } = /** @type {import('jsdoc-type-pratt-parser').NameResult} */ (nde);\n      if (type === 'JsdocTypeName') {\n        usedNames.add(value);\n      }\n    });\n  };\n\n  const checkParamsAndReturnsTags = () => {\n    const paramName = /** @type {string} */ (utils.getPreferredTagName({\n      tagName: 'param',\n    }));\n    const paramTags = utils.getTags(paramName);\n    for (const paramTag of paramTags) {\n      checkForUsedTypes(paramTag.type);\n    }\n\n    const returnsName = /** @type {string} */ (utils.getPreferredTagName({\n      tagName: 'returns',\n    }));\n    const returnsTags = utils.getTags(returnsName);\n    for (const returnsTag of returnsTags) {\n      checkForUsedTypes(returnsTag.type);\n    }\n  };\n\n  const checkTemplateTags = () => {\n    for (const tag of templateTags) {\n      const {\n        name,\n      } = tag;\n      const names = name.split(/,\\s*/u);\n      for (const nme of names) {\n        if (!usedNames.has(nme)) {\n          report(`@template ${nme} not in use`, null, tag);\n        }\n      }\n    }\n  };\n\n  /**\n   * @param {import('@typescript-eslint/types').TSESTree.FunctionDeclaration|\n   *   import('@typescript-eslint/types').TSESTree.ClassDeclaration|\n   *   import('@typescript-eslint/types').TSESTree.TSInterfaceDeclaration|\n   *   import('@typescript-eslint/types').TSESTree.TSTypeAliasDeclaration} aliasDeclaration\n   * @param {boolean} [checkParamsAndReturns]\n   */\n  const checkParameters = (aliasDeclaration, checkParamsAndReturns) => {\n    /* c8 ignore next -- Guard */\n    const {\n      params,\n    } = aliasDeclaration.typeParameters ?? {\n      params: [],\n    };\n    for (const {\n      name: {\n        name,\n      },\n    } of params) {\n      usedNames.add(name);\n    }\n\n    if (checkParamsAndReturns) {\n      checkParamsAndReturnsTags();\n    }\n\n    checkTemplateTags();\n  };\n\n  const handleTypeAliases = () => {\n    const nde = /** @type {import('@typescript-eslint/types').TSESTree.Node} */ (\n      node\n    );\n    if (!nde) {\n      return;\n    }\n\n    switch (nde.type) {\n      case 'ClassDeclaration':\n      case 'TSInterfaceDeclaration':\n      case 'TSTypeAliasDeclaration':\n        checkParameters(nde);\n        break;\n      case 'ExportDefaultDeclaration':\n      case 'ExportNamedDeclaration':\n        switch (nde.declaration?.type) {\n          case 'ClassDeclaration':\n          case 'TSInterfaceDeclaration':\n          case 'TSTypeAliasDeclaration':\n            checkParameters(nde.declaration);\n            break;\n          case 'FunctionDeclaration':\n            checkParameters(nde.declaration, true);\n            break;\n        }\n\n        break;\n      case 'FunctionDeclaration':\n        checkParameters(nde, true);\n        break;\n    }\n  };\n\n  const callbackTags = utils.getTags('callback');\n  const functionTags = utils.getTags('function');\n  if (callbackTags.length || functionTags.length) {\n    checkParamsAndReturnsTags();\n    checkTemplateTags();\n    return;\n  }\n\n  const typedefTags = utils.getTags('typedef');\n  if (!typedefTags.length || typedefTags.length >= 2) {\n    handleTypeAliases();\n    return;\n  }\n\n  const potentialTypedefType = typedefTags[0].type;\n  checkForUsedTypes(potentialTypedefType);\n\n  const propertyName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'property',\n  }));\n  const propertyTags = utils.getTags(propertyName);\n  for (const propertyTag of propertyTags) {\n    checkForUsedTypes(propertyTag.type);\n  }\n\n  for (const tag of templateTags) {\n    const {\n      name,\n    } = tag;\n    const names = name.split(/,\\s*/u);\n    for (const nme of names) {\n      if (!usedNames.has(nme)) {\n        report(`@template ${nme} not in use`, null, tag);\n      }\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Checks that any `@template` names are actually used in the connected `@typedef` or type alias.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-template-names.md#repos-sticky-header',\n    },\n    schema: [],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAI8B,SAAAD,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GAEf,IAAAG,qBAAY,EAAC,CAAC;EAC3BC,IAAI;EACJC,MAAM;EACNC,QAAQ;EACRC;AACF,CAAC,KAAK;EACJ,MAAM;IACJC;EACF,CAAC,GAAGF,QAAQ;EAEZ,MAAMG,YAAY,GAAGF,KAAK,CAACG,OAAO,CAAC,UAAU,CAAC;EAE9C,MAAMC,SAAS,GAAG,IAAIC,GAAG,CAAC,CAAC;EAC3B;AACF;AACA;EACE,MAAMC,iBAAiB,GAAIC,aAAa,IAAK;IAC3C,IAAIC,UAAU;IACd,IAAI;MACFA,UAAU,GAAGP,IAAI,KAAK,YAAY,GAChC,IAAAQ,sBAAY,EAAC,qBAAuBF,aAAc,CAAC,GACnD,IAAAG,mBAAS,EAAC,qBAAuBH,aAAa,EAAGN,IAAI,CAAC;IAC1D,CAAC,CAAC,MAAM;MACN;IACF;IAEA,IAAAU,sBAAQ,EAACH,UAAU,EAAGI,GAAG,IAAK;MAC5B,MAAM;QACJC,IAAI;QACJC;MACF,CAAC,GAAG,2DAA6DF,GAAI;MACrE,IAAIC,IAAI,KAAK,eAAe,EAAE;QAC5BT,SAAS,CAACW,GAAG,CAACD,KAAK,CAAC;MACtB;IACF,CAAC,CAAC;EACJ,CAAC;EAED,MAAME,yBAAyB,GAAGA,CAAA,KAAM;IACtC,MAAMC,SAAS,GAAG,qBAAuBjB,KAAK,CAACkB,mBAAmB,CAAC;MACjEC,OAAO,EAAE;IACX,CAAC,CAAE;IACH,MAAMC,SAAS,GAAGpB,KAAK,CAACG,OAAO,CAACc,SAAS,CAAC;IAC1C,KAAK,MAAMI,QAAQ,IAAID,SAAS,EAAE;MAChCd,iBAAiB,CAACe,QAAQ,CAACR,IAAI,CAAC;IAClC;IAEA,MAAMS,WAAW,GAAG,qBAAuBtB,KAAK,CAACkB,mBAAmB,CAAC;MACnEC,OAAO,EAAE;IACX,CAAC,CAAE;IACH,MAAMI,WAAW,GAAGvB,KAAK,CAACG,OAAO,CAACmB,WAAW,CAAC;IAC9C,KAAK,MAAME,UAAU,IAAID,WAAW,EAAE;MACpCjB,iBAAiB,CAACkB,UAAU,CAACX,IAAI,CAAC;IACpC;EACF,CAAC;EAED,MAAMY,iBAAiB,GAAGA,CAAA,KAAM;IAC9B,KAAK,MAAMC,GAAG,IAAIxB,YAAY,EAAE;MAC9B,MAAM;QACJyB;MACF,CAAC,GAAGD,GAAG;MACP,MAAME,KAAK,GAAGD,IAAI,CAACE,KAAK,CAAC,OAAO,CAAC;MACjC,KAAK,MAAMC,GAAG,IAAIF,KAAK,EAAE;QACvB,IAAI,CAACxB,SAAS,CAAC2B,GAAG,CAACD,GAAG,CAAC,EAAE;UACvBhC,MAAM,CAAC,aAAagC,GAAG,aAAa,EAAE,IAAI,EAAEJ,GAAG,CAAC;QAClD;MACF;IACF;EACF,CAAC;;EAED;AACF;AACA;AACA;AACA;AACA;AACA;EACE,MAAMM,eAAe,GAAGA,CAACC,gBAAgB,EAAEC,qBAAqB,KAAK;IACnE;IACA,MAAM;MACJC;IACF,CAAC,GAAGF,gBAAgB,CAACG,cAAc,IAAI;MACrCD,MAAM,EAAE;IACV,CAAC;IACD,KAAK,MAAM;MACTR,IAAI,EAAE;QACJA;MACF;IACF,CAAC,IAAIQ,MAAM,EAAE;MACX/B,SAAS,CAACW,GAAG,CAACY,IAAI,CAAC;IACrB;IAEA,IAAIO,qBAAqB,EAAE;MACzBlB,yBAAyB,CAAC,CAAC;IAC7B;IAEAS,iBAAiB,CAAC,CAAC;EACrB,CAAC;EAED,MAAMY,iBAAiB,GAAGA,CAAA,KAAM;IAC9B,MAAMzB,GAAG,GAAG;IACVf,IACD;IACD,IAAI,CAACe,GAAG,EAAE;MACR;IACF;IAEA,QAAQA,GAAG,CAACC,IAAI;MACd,KAAK,kBAAkB;MACvB,KAAK,wBAAwB;MAC7B,KAAK,wBAAwB;QAC3BmB,eAAe,CAACpB,GAAG,CAAC;QACpB;MACF,KAAK,0BAA0B;MAC/B,KAAK,wBAAwB;QAC3B,QAAQA,GAAG,CAAC0B,WAAW,EAAEzB,IAAI;UAC3B,KAAK,kBAAkB;UACvB,KAAK,wBAAwB;UAC7B,KAAK,wBAAwB;YAC3BmB,eAAe,CAACpB,GAAG,CAAC0B,WAAW,CAAC;YAChC;UACF,KAAK,qBAAqB;YACxBN,eAAe,CAACpB,GAAG,CAAC0B,WAAW,EAAE,IAAI,CAAC;YACtC;QACJ;QAEA;MACF,KAAK,qBAAqB;QACxBN,eAAe,CAACpB,GAAG,EAAE,IAAI,CAAC;QAC1B;IACJ;EACF,CAAC;EAED,MAAM2B,YAAY,GAAGvC,KAAK,CAACG,OAAO,CAAC,UAAU,CAAC;EAC9C,MAAMqC,YAAY,GAAGxC,KAAK,CAACG,OAAO,CAAC,UAAU,CAAC;EAC9C,IAAIoC,YAAY,CAACE,MAAM,IAAID,YAAY,CAACC,MAAM,EAAE;IAC9CzB,yBAAyB,CAAC,CAAC;IAC3BS,iBAAiB,CAAC,CAAC;IACnB;EACF;EAEA,MAAMiB,WAAW,GAAG1C,KAAK,CAACG,OAAO,CAAC,SAAS,CAAC;EAC5C,IAAI,CAACuC,WAAW,CAACD,MAAM,IAAIC,WAAW,CAACD,MAAM,IAAI,CAAC,EAAE;IAClDJ,iBAAiB,CAAC,CAAC;IACnB;EACF;EAEA,MAAMM,oBAAoB,GAAGD,WAAW,CAAC,CAAC,CAAC,CAAC7B,IAAI;EAChDP,iBAAiB,CAACqC,oBAAoB,CAAC;EAEvC,MAAMC,YAAY,GAAG,qBAAuB5C,KAAK,CAACkB,mBAAmB,CAAC;IACpEC,OAAO,EAAE;EACX,CAAC,CAAE;EACH,MAAM0B,YAAY,GAAG7C,KAAK,CAACG,OAAO,CAACyC,YAAY,CAAC;EAChD,KAAK,MAAME,WAAW,IAAID,YAAY,EAAE;IACtCvC,iBAAiB,CAACwC,WAAW,CAACjC,IAAI,CAAC;EACrC;EAEA,KAAK,MAAMa,GAAG,IAAIxB,YAAY,EAAE;IAC9B,MAAM;MACJyB;IACF,CAAC,GAAGD,GAAG;IACP,MAAME,KAAK,GAAGD,IAAI,CAACE,KAAK,CAAC,OAAO,CAAC;IACjC,KAAK,MAAMC,GAAG,IAAIF,KAAK,EAAE;MACvB,IAAI,CAACxB,SAAS,CAAC2B,GAAG,CAACD,GAAG,CAAC,EAAE;QACvBhC,MAAM,CAAC,aAAagC,GAAG,aAAa,EAAE,IAAI,EAAEJ,GAAG,CAAC;MAClD;IACF;EACF;AACF,CAAC,EAAE;EACDqB,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,gGAAgG;MAC7GC,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,EAAE;IACVvC,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAwC,MAAA,CAAA1D,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}