138 lines
3.6 KiB
JavaScript
Executable file
138 lines
3.6 KiB
JavaScript
Executable file
"use strict";
|
|
|
|
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 return value, in case the documentation is inherited
|
|
* or the method is either a constructor or an abstract method.
|
|
*
|
|
* In either of these cases the return value is optional or not defined.
|
|
*
|
|
* @param {*} 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 an error if it declares a return value but does not implement it.
|
|
'abstract', 'virtual', // Constructors do not have a return value by definition (https://jsdoc.app/tags-class.html)
|
|
// So we can bail out here, too.
|
|
'class', 'constructor', // Return type is specified by type in @type
|
|
'type', // This seems to imply a class as well
|
|
'interface']) || utils.avoidDocs();
|
|
};
|
|
|
|
var _default = (0, _iterateJsdoc.default)(({
|
|
report,
|
|
utils,
|
|
context
|
|
}) => {
|
|
const {
|
|
forceRequireReturn = false,
|
|
forceReturnsWithAsync = false
|
|
} = context.options[0] || {}; // A preflight check. We do not need to run a deep check
|
|
// in case the @returns comment is optional or undefined.
|
|
|
|
if (canSkip(utils)) {
|
|
return;
|
|
}
|
|
|
|
const tagName = utils.getPreferredTagName({
|
|
tagName: 'returns'
|
|
});
|
|
|
|
if (!tagName) {
|
|
return;
|
|
}
|
|
|
|
const tags = utils.getTags(tagName);
|
|
|
|
if (tags.length > 1) {
|
|
report(`Found more than one @${tagName} declaration.`);
|
|
}
|
|
|
|
const iteratingFunction = utils.isIteratingFunction(); // In case the code returns something, we expect a return value in JSDoc.
|
|
|
|
const [tag] = tags;
|
|
const missingReturnTag = typeof tag === 'undefined' || tag === null;
|
|
|
|
const shouldReport = () => {
|
|
if (!missingReturnTag) {
|
|
return false;
|
|
}
|
|
|
|
if (forceRequireReturn && (iteratingFunction || utils.isVirtualFunction())) {
|
|
return true;
|
|
}
|
|
|
|
const isAsync = !iteratingFunction && utils.hasTag('async') || iteratingFunction && utils.isAsync();
|
|
|
|
if (forceReturnsWithAsync && isAsync) {
|
|
return true;
|
|
}
|
|
|
|
return iteratingFunction && utils.hasReturnValue();
|
|
};
|
|
|
|
if (shouldReport()) {
|
|
report(`Missing JSDoc @${tagName} declaration.`);
|
|
}
|
|
}, {
|
|
contextDefaults: true,
|
|
meta: {
|
|
docs: {
|
|
description: 'Requires returns are documented.',
|
|
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns'
|
|
},
|
|
schema: [{
|
|
additionalProperties: false,
|
|
properties: {
|
|
checkConstructors: {
|
|
default: false,
|
|
type: 'boolean'
|
|
},
|
|
checkGetters: {
|
|
default: true,
|
|
type: 'boolean'
|
|
},
|
|
contexts: {
|
|
items: {
|
|
type: 'string'
|
|
},
|
|
type: 'array'
|
|
},
|
|
exemptedBy: {
|
|
items: {
|
|
type: 'string'
|
|
},
|
|
type: 'array'
|
|
},
|
|
forceRequireReturn: {
|
|
default: false,
|
|
type: 'boolean'
|
|
},
|
|
forceReturnsWithAsync: {
|
|
default: false,
|
|
type: 'boolean'
|
|
}
|
|
},
|
|
type: 'object'
|
|
}],
|
|
type: 'suggestion'
|
|
}
|
|
});
|
|
|
|
exports.default = _default;
|
|
module.exports = exports.default;
|
|
//# sourceMappingURL=requireReturns.js.map
|