github-pages-deploy-action/node_modules/eslint-plugin-jsdoc/dist/rules/requirePropertyDescription.js

30 lines
738 B
JavaScript
Raw Normal View History

2020-03-31 20:40:00 +08:00
"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('property', (jsdoc, targetTagName) => {
if (!jsdoc.description) {
report(`Missing JSDoc @${targetTagName} "${jsdoc.name}" description.`, null, jsdoc);
}
});
}, {
iterateAllJsdocs: true,
meta: {
type: 'suggestion'
}
});
exports.default = _default;
module.exports = exports.default;
//# sourceMappingURL=requirePropertyDescription.js.map