jsdoc/no-blank-blocks Style

🛠️ An auto-fix is available for this rule for some violations.

Reports and optionally removes blocks with whitespace only.

Blank JSDoc blocks add noise without providing any documentation.

Examples of incorrect code for this rule:

/** */

/**
 *
 */

Examples of correct code for this rule:

/** @tag */

/**
 * Text
 */

/**
 * @tag
 */

Configuration

This rule accepts a configuration object with the following properties:

type: boolean

default: false

Whether to automatically remove blank JSDoc blocks.

To enable this rule using the config file or in the CLI, you can use:

Config (.oxlintrc.json)Config (oxlint.config.ts)CLI

json

{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/no-blank-blocks": "error"
  }
}

import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["jsdoc"],
  rules: {
    "jsdoc/no-blank-blocks": "error",
  },
});

bash

oxlint --deny jsdoc/no-blank-blocks --jsdoc-plugin

This rule was added in vnext.