requireExample.js 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.default = void 0;
  6. var _lodash = _interopRequireDefault(require("lodash"));
  7. var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc"));
  8. function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
  9. var _default = (0, _iterateJsdoc.default)(function (_ref) {
  10. var jsdoc = _ref.jsdoc,
  11. report = _ref.report,
  12. utils = _ref.utils;
  13. var targetTagName = utils.getPreferredTagName('example');
  14. var functionExamples = _lodash.default.filter(jsdoc.tags, {
  15. tag: targetTagName
  16. });
  17. if (_lodash.default.isEmpty(functionExamples)) {
  18. return report('Missing JSDoc @' + targetTagName + ' declaration.');
  19. }
  20. return _lodash.default.forEach(functionExamples, function (example) {
  21. var exampleContent = _lodash.default.compact((example.name + ' ' + example.description).trim().split('\n'));
  22. if (_lodash.default.isEmpty(exampleContent)) {
  23. report('Missing JSDoc @' + targetTagName + ' description.');
  24. }
  25. });
  26. });
  27. exports.default = _default;
  28. module.exports = exports.default;
  29. //# sourceMappingURL=requireExample.js.map