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

JSDoc linting rules for ESLint.

{"version":3,"file":"emptyTags.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/emptyTags.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nconst defaultEmptyTags = new Set([\n  'abstract', 'async', 'generator', 'global', 'hideconstructor',\n\n  // jsdoc doesn't use this form in its docs, but allow for compatibility with\n  //  TypeScript which allows and Closure which requires\n  'ignore',\n\n  // jsdoc doesn't use but allow for TypeScript\n  'inheritDoc', 'inner', 'instance',\n  'internal',\n\n  'overload',\n\n  'override',\n  'readonly',\n]);\n\nconst emptyIfNotClosure = new Set([\n  // Closure doesn't allow with this casing\n  'inheritdoc', 'package', 'private', 'protected', 'public',\n\n  'static',\n]);\n\nconst emptyIfClosure = new Set([\n  'interface',\n]);\n\nexport default iterateJsdoc(({\n  jsdoc,\n  settings,\n  utils,\n}) => {\n  const emptyTags = utils.filterTags(({\n    tag: tagName,\n  }) => {\n    return defaultEmptyTags.has(tagName) ||\n      utils.hasOptionTag(tagName) && jsdoc.tags.some(({\n        tag,\n      }) => {\n        return tag === tagName;\n      }) ||\n      settings.mode === 'closure' && emptyIfClosure.has(tagName) ||\n      settings.mode !== 'closure' && emptyIfNotClosure.has(tagName);\n  });\n\n  for (const [\n    key,\n    tag,\n  ] of emptyTags.entries()) {\n    const content = tag.name || tag.description || tag.type;\n    if (content.trim() && (\n      // Allow for JSDoc-block final asterisks\n      key !== emptyTags.length - 1 || !(/^\\s*\\*+$/v).test(content)\n    )) {\n      const {\n        tokens: {\n          delimiter,\n          end,\n          postName,\n          start,\n        },\n      } = tag.source[0];\n      const fix = () => {\n        // By time of call in fixer, `tag` will have `line` added\n        utils.setTag(\n          /**\n           * @type {import('comment-parser').Spec & {\n           *   line: import('../iterateJsdoc.js').Integer\n           * }}\n           */ (tag),\n          {\n            delimiter,\n            end,\n            postName: end ? postName : '',\n            start,\n          },\n        );\n      };\n\n      utils.reportJSDoc(`@${tag.tag} should be empty.`, tag, fix, true);\n    }\n  }\n}, {\n  checkInternal: true,\n  checkPrivate: true,\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Checks tags that are expected to be empty (e.g., `@abstract` or `@async`), reporting if they have content',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/empty-tags.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          tags: {\n            description: `If you want additional tags to be checked for their descriptions, you may\nadd them within this option.\n\n\\`\\`\\`js\n{\n  'jsdoc/empty-tags': ['error', {tags: ['event']}]\n}\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;AAA8C;AAE9C,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,CAC/B,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,iBAAiB;AAE7D;AACA;AACA,QAAQ;AAER;AACA,YAAY,EAAE,OAAO,EAAE,UAAU,EACjC,UAAU,EAEV,UAAU,EAEV,UAAU,EACV,UAAU,CACX,CAAC;AAEF,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC;AAChC;AACA,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,EAEzD,QAAQ,CACT,CAAC;AAEF,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,CAC7B,WAAW,CACZ,CAAC;AAAC,iCAEY,IAAAA,qBAAY,EAAC,CAAC;EAC3B,KAAK;EACL,QAAQ;EACR;AACF,CAAC,KAAK;EACJ,MAAM,SAAS,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IAClC,GAAG,EAAE;EACP,CAAC,KAAK;IACJ,OAAO,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,IAClC,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;MAC9C;IACF,CAAC,KAAK;MACJ,OAAO,GAAG,KAAK,OAAO;IACxB,CAAC,CAAC,IACF,QAAQ,CAAC,IAAI,KAAK,SAAS,IAAI,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,IAC1D,QAAQ,CAAC,IAAI,KAAK,SAAS,IAAI,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC;EACjE,CAAC,CAAC;EAEF,KAAK,MAAM,CACT,GAAG,EACH,GAAG,CACJ,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,EAAE;IACxB,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,IAAI;IACvD,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAChB;IACA,GAAG,KAAK,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,CAAE,WAAW,CAAE,IAAI,CAAC,OAAO,CAAC,CAC7D,EAAE;MACD,MAAM;QACJ,MAAM,EAAE;UACN,SAAS;UACT,GAAG;UACH,QAAQ;UACR;QACF;MACF,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;MACjB,MAAM,GAAG,GAAG,MAAM;QAChB;QACA,KAAK,CAAC,MAAM;QACV;AACV;AACA;AACA;AACA;QAAe,GAAG,EACR;UACE,SAAS;UACT,GAAG;UACH,QAAQ,EAAE,GAAG,GAAG,QAAQ,GAAG,EAAE;UAC7B;QACF,CACF,CAAC;MACH,CAAC;MAED,KAAK,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,GAAG,mBAAmB,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC;IACnE;EACF;AACF,CAAC,EAAE;EACD,aAAa,EAAE,IAAI;EACnB,YAAY,EAAE,IAAI;EAClB,gBAAgB,EAAE,IAAI;EACtB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,2GAA2G;MACxH,GAAG,EAAE;IACP,CAAC;IACD,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,IAAI,EAAE;UACJ,WAAW,EAAE;AACzB;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":[]}