import jsdoc from 'eslint-plugin-jsdoc';
const config = [
  // configuration included in plugin
  jsdoc.configs['flat/recommended'],
  // other configuration objects...
    files: ['**/*.js'],
    plugins: {
      jsdoc,
    rules: {
      'jsdoc/require-description': 'warn'
export default config;

// `.eslintrc.js`
  rules: {
    'jsdoc/require-example': [
        // The Error level should be `error`, `warn`, or `off` (or 2, 1, or 0)
        'error',
        // The options vary by rule, but are generally added to an options
        //  object as follows:
          checkConstructors: true,
          exemptedBy: ['type']
Settings

See Settings.
Advanced

See Advanced.
Rules

Problems reported by rules which have a wrench 🔧 below can be fixed automatically by running ESLint on the command line with --fix option.
Note that a number of fixable rules have an enableFixer option which can
be set to false to disable the fixer (or in the case of check-param-names,
check-property-names, and no-blank-blocks, set to true to enable a
non-default-recommended fixer).
recommended
fixable
description
check-param-names
Checks for dupe @param names, that nested param names have roots, and that parameter names in function declarations match jsdoc param names.
check-property-names
Checks for dupe @property names, that nested property names have roots
check-syntax
Reports use against current mode (currently only prohibits Closure-specific syntax)
check-tag-names
Reports invalid jsdoc (block) tag names
check-types
Reports types deemed invalid (customizable and with defaults, for preventing and/or recommending replacements)
check-values
Checks for expected content within some miscellaneous tags (@version, @since, @license, @author)
empty-tags
Checks tags that are expected to be empty (e.g., @abstract or @async), reporting if they have content
implements-on-classes
Prohibits use of @implements on non-constructor functions (to enforce the tag only being used on classes/constructors)
match-name
Reports the name portion of a JSDoc tag if matching or not matching a given regular expression
multiline-blocks
Controls how and whether jsdoc blocks can be expressed as single or multiple line blocks
no-bad-blocks
This rule checks for multi-line-style comments which fail to meet the criteria of a jsdoc block
no-blank-block-descriptions
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.
no-blank-blocks
Reports and optionally removes blocks with whitespace only
no-defaults
This rule reports defaults being used on the relevant portion of @param or @default
no-missing-syntax
This rule lets you report if certain always expected comment structures are missing.
no-multi-asterisks
Prevents use of multiple asterisks at the beginning of lines
require-hyphen-before-param-description
Requires a hyphen before @param descriptions (and optionally before @property descriptions)
require-jsdoc
Checks for presence of jsdoc comments, on functions and potentially other contexts (optionally limited to exports).
require-param
Requires that all function parameters are documented with a @param tag.
require-param-description
Requires that each @param tag has a description value.
require-param-name
Requires that all @param tags have names.
✔️ (off in TS)
require-param-type
Requires that each @param tag has a type value (within curly brackets).
require-property
Requires that all @typedef and @namespace tags have @property tags when their type is a plain object, Object, or PlainObject.
require-property-description
Requires that each @property tag has a description value.
require-property-name
Requires that all @property tags have names.
✔️ (off in TS)
require-property-type
Requires that each @property tag has a type value (within curly brackets).
require-returns
Requires that return statements are documented.
require-returns-check
Requires a return statement be present in a function body if a @returns tag is specified in the jsdoc comment block (and reports if multiple @returns tags are present).
require-returns-description
Requires that the @returns tag has a description value (not including void/undefined type returns).
✔️ (off in TS)
require-returns-type
Requires that @returns tag has a type value (in curly brackets).
sort-tags
Sorts tags by a specified sequence according to tag name, optionally adding line breaks between tag groups
tag-lines
Enforces lines (or no lines) between tags
text-escaping
This rule can auto-escape certain characters that are input within block and tag descriptions
valid-types
Requires all types/namepaths to be valid JSDoc, Closure compiler, or TypeScript types (configurable in settings)