summaryrefslogtreecommitdiff
path: root/tools/node_modules/eslint/node_modules/eslint-plugin-jsdoc/dist/rules/noBlankBlockDescriptions.js
blob: 9bcc132648d7f0729d9b8318c602e20c469e59b3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
"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 }; }
const anyWhitespaceLines = /^\s*$/u;
const atLeastTwoLinesWhitespace = /^[ \t]*\n[ \t]*\n\s*$/u;
var _default = (0, _iterateJsdoc.default)(({
  jsdoc,
  utils
}) => {
  const {
    description,
    descriptions,
    lastDescriptionLine
  } = utils.getDescription();
  const regex = jsdoc.tags.length ? anyWhitespaceLines : atLeastTwoLinesWhitespace;
  if (descriptions.length && regex.test(description)) {
    if (jsdoc.tags.length) {
      utils.reportJSDoc('There should be no blank lines in block descriptions followed by tags.', {
        line: lastDescriptionLine
      }, () => {
        utils.setBlockDescription(() => {
          // Remove all lines
          return [];
        });
      });
    } else {
      utils.reportJSDoc('There should be no extra blank lines in block descriptions not followed by tags.', {
        line: lastDescriptionLine
      }, () => {
        utils.setBlockDescription((info, seedTokens) => {
          return [
          // Keep the starting line
          {
            tokens: seedTokens({
              ...info,
              description: ''
            })
          }];
        });
      });
    }
  }
}, {
  iterateAllJsdocs: true,
  meta: {
    docs: {
      description: 'Detects and removes extra lines of a blank block description',
      url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-blank-block-descriptions'
    },
    fixable: 'whitespace',
    schema: [],
    type: 'layout'
  }
});
exports.default = _default;
module.exports = exports.default;
//# sourceMappingURL=noBlankBlockDescriptions.js.map