52 lines
1.3 KiB
JavaScript
Executable file
52 lines
1.3 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 }; }
|
|
|
|
var _default = (0, _iterateJsdoc.default)(({
|
|
report,
|
|
utils
|
|
}) => {
|
|
utils.forEachPreferredTag('returns', (jsdocTag, targetTagName) => {
|
|
const type = jsdocTag.type && jsdocTag.type.trim();
|
|
|
|
if (['void', 'undefined', 'Promise<void>', 'Promise<undefined>'].includes(type)) {
|
|
return;
|
|
}
|
|
|
|
if (!jsdocTag.description) {
|
|
report(`Missing JSDoc @${targetTagName} description.`, null, jsdocTag);
|
|
}
|
|
});
|
|
}, {
|
|
contextDefaults: true,
|
|
meta: {
|
|
docs: {
|
|
description: 'Requires that the `@returns` tag has a `description` value.',
|
|
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-description'
|
|
},
|
|
schema: [{
|
|
additionalProperties: false,
|
|
properties: {
|
|
contexts: {
|
|
items: {
|
|
type: 'string'
|
|
},
|
|
type: 'array'
|
|
}
|
|
},
|
|
type: 'object'
|
|
}],
|
|
type: 'suggestion'
|
|
}
|
|
});
|
|
|
|
exports.default = _default;
|
|
module.exports = exports.default;
|
|
//# sourceMappingURL=requireReturnsDescription.js.map
|