eslint-plugin-jsdoc/src/rules/noBlankBlocks.js

JSDoc linting rules for ESLint.

import iterateJsdoc from '../iterateJsdoc.js';

export default iterateJsdoc(({
  context,
  jsdoc,
  utils,
}) => {
  if (jsdoc.tags.length) {
    return;
  }

  const {
    description,
    lastDescriptionLine,
  } = utils.getDescription();
  if (description.trim()) {
    return;
  }

  const {
    enableFixer,
  } = context.options[0] || {};

  utils.reportJSDoc(
    'No empty blocks',
    {
      line: lastDescriptionLine,
    },
    enableFixer ? () => {
      jsdoc.source.splice(0);
    } : null,
  );
}, {
  iterateAllJsdocs: true,
  meta: {
    docs: {
      description: 'Removes empty blocks with nothing but possibly line breaks',
      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-blank-blocks.md#repos-sticky-header',
    },
    fixable: 'code',
    schema: [
      {
        additionalProperties: false,
        properties: {
          enableFixer: {
            description: 'Whether or not to auto-remove the blank block. Defaults to `false`.',
            type: 'boolean',
          },
        },
        type: 'object',
      },
    ],
    type: 'suggestion',
  },
});