requirePropertyDescription.js 968 B

1234567891011121314151617181920212223242526272829
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.default = void 0;
  6. var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.js"));
  7. function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
  8. var _default = exports.default = (0, _iterateJsdoc.default)(({
  9. report,
  10. utils
  11. }) => {
  12. utils.forEachPreferredTag('property', (jsdoc, targetTagName) => {
  13. if (!jsdoc.description.trim()) {
  14. report(`Missing JSDoc @${targetTagName} "${jsdoc.name}" description.`, null, jsdoc);
  15. }
  16. });
  17. }, {
  18. iterateAllJsdocs: true,
  19. meta: {
  20. docs: {
  21. description: 'Requires that each `@property` tag has a `description` value.',
  22. url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-description.md#repos-sticky-header'
  23. },
  24. type: 'suggestion'
  25. }
  26. });
  27. module.exports = exports.default;
  28. //# sourceMappingURL=requirePropertyDescription.js.map