| import iterateJsdoc from '../iterateJsdoc.js'; |
| |
| const anyWhitespaceLines = /^\s*$/v; |
| const atLeastTwoLinesWhitespace = /^[ \t]*\n[ \t]*\n\s*$/v; |
| |
| export default iterateJsdoc(({ |
| 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 |
| { |
| number: 0, |
| source: '', |
| tokens: seedTokens({ |
| ...info, |
| description: '', |
| }), |
| }, |
| ]; |
| }); |
| }, |
| ); |
| } |
| } |
| }, { |
| iterateAllJsdocs: true, |
| meta: { |
| docs: { |
| description: 'If tags are present, this rule will prevent empty lines in the block description. If no tags are present, this rule will prevent extra empty lines in the block description.', |
| url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-blank-block-descriptions.md#repos-sticky-header', |
| }, |
| fixable: 'whitespace', |
| schema: [], |
| type: 'layout', |
| }, |
| }); |