Version 23.0.2

Patch

• Updated dev dependencies.
• Updated the ESLint parserOptions.ecmaVersion config from 2021 to "latest".
• Removed a comment in the .editorconfig file.

Version 23.0.1

Patch

• Updated dev dependencies.
• Simplified package scripts.
• Configured Prettier option singleQuote to the default, false.
• Configured the jsdoc/require-description rule option checkConstructors to false.

Version 23.0.0

Major

• Updated Node.js support to ^12.20.0 || ^14.13.1 || >= 16.0.0.

Patch

• Updated the eslint peer dependency to 7.5 - 8.
• Updated the eslint-plugin-jsdoc peer dependency to 34 - 37.
• Also run GitHub Actions CI with Node.js v17.
• Disabled the jsdoc/check-examples rule as it doesn’t work yet in ESLint v8 (see eslint/eslint#14745).
• Disabled the react/prop-types rule.

Version 22.0.0

Major

• Updated Node.js support to >= 12.20.
• Updated dev dependencies, some of which require newer Node.js versions than previously supported.

Patch

• Updated the eslint-plugin-jsdoc peer dependency to 34 - 36.
• Added a link to ESLint configuration documentation in the readme.

Version 21.0.0

Major

• Next.js projects must now have the @next/eslint-plugin-next dev dependency installed.
• Enabled @next/eslint-plugin-next recommended rules for Next.js projects, except for the @next/next/no-img-element rule as there are many valid uses for the vanilla img element in JSX.

Patch

• Updated dev dependencies.
• Amended the changelog entry for v20.0.0.

Version 20.0.1

Patch

• Updated the eslint-plugin-jsdoc peer dependency to 34 - 35.
• Updated dev dependencies.

Version 20.0.0

Major

• Updated Node.js support to >= 12.
• Updated the eslint-plugin-jsdoc peer dependency to ^34.0.0, via #4.
• Updated dev dependencies, some of which require newer Node.js versions than previously supported.

Patch

• Updated the GitHub Actions CI config to test Node.js versions v12, v14, v16.
• Readme tweaks.
• The file changelog.md is no longer published.

Version 19.0.2

Patch

• Updated the eslint-plugin-jsdoc peer dependency to 25 - 33.
• Updated dev dependencies.
• Updated GitHub Actions CI config to also test Node.js v16.

Version 19.0.1

Patch

• Updated dev dependencies.
• Removed the semver dependency and some package.json engines.node field checks that are no longer necessary for the currently supported Node.js versions.

Version 19.0.0

Major

• Configured the ESLint env to be es2021, instead of es6.

• Support eslint-config-prettier v8, fixing #3.

• Enabled eslint-plugin-jsdoc rules:

  • jsdoc/check-property-names
  • jsdoc/empty-tags
  • jsdoc/require-property
  • jsdoc/require-property-description
  • jsdoc/require-property-name
  • jsdoc/require-property-type

• Configured eslint-plugin-jsdoc to assume @example JSDoc tag content (following the caption) is markdown, and Prettier lint the contents of markdown code blocks fenced with these labels (case-insensitive):

  • JS
  • JSX
  • JavaScript

  If your example JS code has deliberate parse errors (e.g. due to custom escapes for */ used within the code, see gajus/eslint-plugin-jsdoc#710), use a /* eslint-disable jsdoc/check-examples */ comment.

• Configured eslint-plugin-jsdoc preferred JSDoc types via settings.jsdoc.preferredTypes:

  • Dots in .<> types aren’t preferred, e.g. Array.<string> now auto-fixes to Array<string>.
  • [] types aren’t preferred, e.g. string[] now auto-fixes to Array<string>.

Patch

• Updated the eslint-plugin-jsdoc peer dependency to 25 - 32.
• Updated dependencies.
• Removed rules that conflict with eslint-plugin-prettier (see prettier/eslint-plugin-prettier#65) and are disabled via the plugin:prettier/recommended config anyway:
  • arrow-body-style
  • prefer-arrow-callback