eslint-plugin-jsdoc 63.3.3 → 64.0.0

package/dist/rules/noTypes.cjs

@@ -1,101 +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 }; }
-/**
- * @param {import('comment-parser').Line} line
- */
-const removeType = ({
-  tokens
-}) => {
-  tokens.postTag = '';
-  tokens.type = '';
-};
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  node,
-  utils
-}) => {
-  if (!utils.isIteratingFunctionOrVariable() && !utils.isVirtualFunction()) {
-    return;
-  }
-  const tags = utils.getPresentTags(['param', 'arg', 'argument', 'returns', 'return']);
-  for (const tag of tags) {
-    if (tag.type) {
-      utils.reportJSDoc(`Types are not permitted on @${tag.tag}.`, tag, () => {
-        for (const source of tag.source) {
-          removeType(source);
-        }
-      });
-    }
-  }
-  if (node?.type === 'ClassDeclaration') {
-    const propertyTags = utils.getPresentTags(['prop', 'property']);
-    for (const tag of propertyTags) {
-      if (tag.type) {
-        utils.reportJSDoc(`Types are not permitted on @${tag.tag} in the supplied context.`, tag, () => {
-          for (const source of tag.source) {
-            removeType(source);
-          }
-        });
-      }
-    }
-  }
-}, {
-  contextDefaults: ['ArrowFunctionExpression', 'FunctionDeclaration', 'FunctionExpression', 'TSDeclareFunction',
-  // Add this to above defaults
-  'TSMethodSignature', 'ClassDeclaration'],
-  meta: {
-    docs: {
-      description: 'This rule reports types being used on `@param` or `@returns` (redundant with TypeScript).',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-types.md#repos-sticky-header'
-    },
-    fixable: 'code',
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        contexts: {
-          description: `Set this to an array of strings representing the AST context (or an object with
-optional \`context\` and \`comment\` properties) where you wish the rule to be applied.
-
-\`context\` defaults to \`any\` and \`comment\` defaults to no specific comment context.
-
-Overrides the default contexts (\`ArrowFunctionExpression\`, \`FunctionDeclaration\`,
-\`FunctionExpression\`, \`TSDeclareFunction\`, \`TSMethodSignature\`,
-\`ClassDeclaration\`). Set to \`"any"\` if you want
-the rule to apply to any JSDoc block throughout your files (as is necessary
-for finding function blocks not attached to a function declaration or
-expression, i.e., \`@callback\` or \`@function\` (or its aliases \`@func\` or
-\`@method\`) (including those associated with an \`@interface\`).
-
-See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
-section of our Advanced docs for more on the expected format.`,
-          items: {
-            anyOf: [{
-              type: 'string'
-            }, {
-              additionalProperties: false,
-              properties: {
-                comment: {
-                  type: 'string'
-                },
-                context: {
-                  type: 'string'
-                }
-              },
-              type: 'object'
-            }]
-          },
-          type: 'array'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'suggestion'
-  }
-});
-module.exports = exports.default;
-//# sourceMappingURL=noTypes.cjs.map

package/dist/rules/noTypes.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"noTypes.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/noTypes.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {import('comment-parser').Line} line\n */\nconst removeType = ({\n  tokens,\n}) => {\n  tokens.postTag = '';\n  tokens.type = '';\n};\n\nexport default iterateJsdoc(({\n  node,\n  utils,\n}) => {\n  if (!utils.isIteratingFunctionOrVariable() && !utils.isVirtualFunction()) {\n    return;\n  }\n\n  const tags = utils.getPresentTags([\n    'param', 'arg', 'argument', 'returns', 'return',\n  ]);\n\n  for (const tag of tags) {\n    if (tag.type) {\n      utils.reportJSDoc(`Types are not permitted on @${tag.tag}.`, tag, () => {\n        for (const source of tag.source) {\n          removeType(source);\n        }\n      });\n    }\n  }\n\n  if (node?.type === 'ClassDeclaration') {\n    const propertyTags = utils.getPresentTags([\n      'prop', 'property',\n    ]);\n    for (const tag of propertyTags) {\n      if (tag.type) {\n        utils.reportJSDoc(`Types are not permitted on @${tag.tag} in the supplied context.`, tag, () => {\n          for (const source of tag.source) {\n            removeType(source);\n          }\n        });\n      }\n    }\n  }\n}, {\n  contextDefaults: [\n    'ArrowFunctionExpression', 'FunctionDeclaration', 'FunctionExpression', 'TSDeclareFunction',\n    // Add this to above defaults\n    'TSMethodSignature', 'ClassDeclaration',\n  ],\n  meta: {\n    docs: {\n      description: 'This rule reports types being used on `@param` or `@returns` (redundant with TypeScript).',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-types.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          contexts: {\n            description: `Set this to an array of strings representing the AST context (or an object with\noptional \\`context\\` and \\`comment\\` properties) where you wish the rule to be applied.\n\n\\`context\\` defaults to \\`any\\` and \\`comment\\` defaults to no specific comment context.\n\nOverrides the default contexts (\\`ArrowFunctionExpression\\`, \\`FunctionDeclaration\\`,\n\\`FunctionExpression\\`, \\`TSDeclareFunction\\`, \\`TSMethodSignature\\`,\n\\`ClassDeclaration\\`). Set to \\`\"any\"\\` if you want\nthe rule to apply to any JSDoc block throughout your files (as is necessary\nfor finding function blocks not attached to a function declaration or\nexpression, i.e., \\`@callback\\` or \\`@function\\` (or its aliases \\`@func\\` or\n\\`@method\\`) (including those associated with an \\`@interface\\`).\n\nSee the [\"AST and Selectors\"](../advanced.md#ast-and-selectors)\nsection of our Advanced docs for more on the expected format.`,\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        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA;AAA8C;AAE9C;AACA;AACA;AACA,MAAM,UAAU,GAAG,CAAC;EAClB;AACF,CAAC,KAAK;EACJ,MAAM,CAAC,OAAO,GAAG,EAAE;EACnB,MAAM,CAAC,IAAI,GAAG,EAAE;AAClB,CAAC;AAAC,iCAEa,IAAAA,qBAAY,EAAC,CAAC;EAC3B,IAAI;EACJ;AACF,CAAC,KAAK;EACJ,IAAI,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,EAAE;IACxE;EACF;EAEA,MAAM,IAAI,GAAG,KAAK,CAAC,cAAc,CAAC,CAChC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,CAChD,CAAC;EAEF,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;IACtB,IAAI,GAAG,CAAC,IAAI,EAAE;MACZ,KAAK,CAAC,WAAW,CAAC,+BAA+B,GAAG,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM;QACtE,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE;UAC/B,UAAU,CAAC,MAAM,CAAC;QACpB;MACF,CAAC,CAAC;IACJ;EACF;EAEA,IAAI,IAAI,EAAE,IAAI,KAAK,kBAAkB,EAAE;IACrC,MAAM,YAAY,GAAG,KAAK,CAAC,cAAc,CAAC,CACxC,MAAM,EAAE,UAAU,CACnB,CAAC;IACF,KAAK,MAAM,GAAG,IAAI,YAAY,EAAE;MAC9B,IAAI,GAAG,CAAC,IAAI,EAAE;QACZ,KAAK,CAAC,WAAW,CAAC,+BAA+B,GAAG,CAAC,GAAG,2BAA2B,EAAE,GAAG,EAAE,MAAM;UAC9F,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE;YAC/B,UAAU,CAAC,MAAM,CAAC;UACpB;QACF,CAAC,CAAC;MACJ;IACF;EACF;AACF,CAAC,EAAE;EACD,eAAe,EAAE,CACf,yBAAyB,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,mBAAmB;EAC3F;EACA,mBAAmB,EAAE,kBAAkB,CACxC;EACD,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,2FAA2F;MACxG,GAAG,EAAE;IACP,CAAC;IACD,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,QAAQ,EAAE;UACR,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,8DAA8D;UAClD,KAAK,EAAE;YACL,KAAK,EAAE,CACL;cACE,IAAI,EAAE;YACR,CAAC,EACD;cACE,oBAAoB,EAAE,KAAK;cAC3B,UAAU,EAAE;gBACV,OAAO,EAAE;kBACP,IAAI,EAAE;gBACR,CAAC;gBACD,OAAO,EAAE;kBACP,IAAI,EAAE;gBACR;cACF,CAAC;cACD,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACD,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}