112 lines
2.9 KiB
JavaScript
112 lines
2.9 KiB
JavaScript
import iterateJsdoc from '../iterateJsdoc.js';
|
|
|
|
/**
|
|
* We can skip checking for a throws value, in case the documentation is inherited
|
|
* or the method is either a constructor or an abstract method.
|
|
* @param {import('../iterateJsdoc.js').Utils} utils a reference to the utils which are used to probe if a tag is present or not.
|
|
* @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
|
|
// see https://jsdoc.app/tags-inheritdoc.html
|
|
//
|
|
// Abstract methods are by definition incomplete,
|
|
// so it is not necessary to document that they throw an error.
|
|
'abstract',
|
|
'virtual',
|
|
|
|
// The designated type can itself document `@throws`
|
|
'type',
|
|
]) ||
|
|
utils.avoidDocs();
|
|
};
|
|
|
|
export default iterateJsdoc(({
|
|
report,
|
|
utils,
|
|
}) => {
|
|
// A preflight check. We do not need to run a deep check for abstract
|
|
// functions.
|
|
if (canSkip(utils)) {
|
|
return;
|
|
}
|
|
|
|
const tagName = /** @type {string} */ (utils.getPreferredTagName({
|
|
tagName: 'throws',
|
|
}));
|
|
if (!tagName) {
|
|
return;
|
|
}
|
|
|
|
const tags = utils.getTags(tagName);
|
|
const iteratingFunction = utils.isIteratingFunction();
|
|
|
|
// In case the code returns something, we expect a return value in JSDoc.
|
|
const [
|
|
tag,
|
|
] = tags;
|
|
const missingThrowsTag = typeof tag === 'undefined' || tag === null;
|
|
|
|
const shouldReport = () => {
|
|
if (!missingThrowsTag) {
|
|
if (tag.type.trim() === 'never' && iteratingFunction && utils.hasThrowValue()) {
|
|
report(`JSDoc @${tagName} declaration set to "never" but throw value found.`);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
return iteratingFunction && utils.hasThrowValue();
|
|
};
|
|
|
|
if (shouldReport()) {
|
|
report(`Missing JSDoc @${tagName} declaration.`);
|
|
}
|
|
}, {
|
|
contextDefaults: true,
|
|
meta: {
|
|
docs: {
|
|
description: 'Requires that throw statements are documented.',
|
|
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws.md#repos-sticky-header',
|
|
},
|
|
schema: [
|
|
{
|
|
additionalProperties: false,
|
|
properties: {
|
|
contexts: {
|
|
items: {
|
|
anyOf: [
|
|
{
|
|
type: 'string',
|
|
},
|
|
{
|
|
additionalProperties: false,
|
|
properties: {
|
|
comment: {
|
|
type: 'string',
|
|
},
|
|
context: {
|
|
type: 'string',
|
|
},
|
|
},
|
|
type: 'object',
|
|
},
|
|
],
|
|
},
|
|
type: 'array',
|
|
},
|
|
exemptedBy: {
|
|
items: {
|
|
type: 'string',
|
|
},
|
|
type: 'array',
|
|
},
|
|
},
|
|
type: 'object',
|
|
},
|
|
],
|
|
type: 'suggestion',
|
|
},
|
|
});
|