canonical/node_modules/eslint-plugin-jsdoc/dist/rules/requireReturnsDescription.js

Canonical code style linter and formatter for JavaScript, SCSS, CSS and JSON.

'use strict';

Object.defineProperty(exports, "__esModule", {
    value: true
});

var _forEach2 = require('lodash/collection/forEach');

var _forEach3 = _interopRequireDefault(_forEach2);

var _filter2 = require('lodash/collection/filter');

var _filter3 = _interopRequireDefault(_filter2);

var _iterateJsdoc = require('./../iterateJsdoc');

var _iterateJsdoc2 = _interopRequireDefault(_iterateJsdoc);

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

exports.default = (0, _iterateJsdoc2.default)(function (_ref) {
    var jsdoc = _ref.jsdoc;
    var report = _ref.report;
    var utils = _ref.utils;

    var jsdocTags = undefined,
        targetTagName = undefined;

    targetTagName = utils.getPreferredTagName('returns');

    jsdocTags = (0, _filter3.default)(jsdoc.tags, {
        tag: targetTagName
    });

    (0, _forEach3.default)(jsdocTags, function (jsdocTag) {
        if (!jsdocTag.description) {
            report('Missing JSDoc @' + targetTagName + ' description.');
        }
    });
});
module.exports = exports['default'];
//# sourceMappingURL=requireReturnsDescription.js.map