🌐
npm
npmjs.com › package › eslint-plugin-jsdoc
eslint-plugin-jsdoc - npm
1 week ago - A plugins property can also be supplied to merge with the resulting jsdoc plugin. Other config properties such as files, ignores, etc. are also copied over, though noting that if the specified config produces an array, they will not currently function. There is also a extraRuleDefinitions.forbid option, the details of which are explained in the Advanced docs (under creating your own rules and forbidding structures). import jsdoc from 'eslint-plugin-jsdoc'; const config = [ // configuration included in plugin jsdoc.configs['flat/recommended'], // other configuration objects...
      » npm install eslint-plugin-jsdoc
Published   Mar 12, 2026
Version   62.8.0
Author   Gajus Kuizinas
Repository   https://github.com/gajus/eslint-plugin-jsdoc
Homepage   https://github.com/gajus/eslint-plugin-jsdoc#readme
🌐
GitHub
github.com › gajus › eslint-plugin-jsdoc
GitHub - gajus/eslint-plugin-jsdoc: JSDoc specific linting rules for ESLint. · GitHub
A plugins property can also be supplied to merge with the resulting jsdoc plugin. Other config properties such as files, ignores, etc. are also copied over, though noting that if the specified config produces an array, they will not currently function. There is also a extraRuleDefinitions.forbid option, the details of which are explained in the Advanced docs (under creating your own rules and forbidding structures). import jsdoc from 'eslint-plugin-jsdoc'; const config = [ // configuration included in plugin jsdoc.configs['flat/recommended'], // other configuration objects...
Starred by 1.2K users
Forked by 171 users
Languages   JavaScript
Discussions
Setting up eslint-plugin-jsdoc
Have you actually declared the rules from the plugin? Looking at the docs, that seems to be required. More on reddit.com
🌐 r/typescript
6
1
October 13, 2024
Overly strict node versions specified in engine
JSDoc specific linting rules for ESLint. Contribute to gajus/eslint-plugin-jsdoc development by creating an account on GitHub. More on github.com
🌐 github.com
18
August 5, 2021
Newest 'eslint-plugin-jsdoc' Questions - Stack Overflow
But whenever we export a TS type (or interface), we're warned if we don't have a jsdoc block on not only the type itself, but also on each ... ... I am writing a TypeScript project, which is meant to be run on Node (after transpilation). I have ESLint with plugins: @typescript-eslint and ... More on stackoverflow.com
🌐 stackoverflow.com
Unsupported Node.js engine error for @es-joy/jsdoccomment and eslint-plugin-jsdoc - Stack Overflow
I'm trying to install or update the npm packages @es-joy/jsdoccomment and eslint-plugin-jsdoc, but I'm encountering "Unsupported engine" warnings related to the required Node.js versions.... More on stackoverflow.com
🌐 stackoverflow.com
🌐
ESLint
eslint.org › docs › latest › rules › require-jsdoc
require-jsdoc - ESLint - Pluggable JavaScript Linter
This rule requires JSDoc comments for specified nodes.
🌐
ESLint
eslint.org › docs › latest › use › migrate-to-9.0.0
Migrate to v9.x - ESLint - Pluggable JavaScript Linter
To address: Make sure you upgrade to at least Node.js v18.18.0 when using ESLint v9.0.0. One important thing to double check is the Node.js version supported by your editor when using ESLint via editor integrations.
🌐
GitHub
github.com › gajus › eslint-plugin-jsdoc › releases
Releases · gajus/eslint-plugin-jsdoc
default-expressions and examples configs: avoid applying deprecated rules now that ESLint warns against them; fixes #1651 (a252868) ... There was an error while loading. Please reload this page. ... There was an error while loading. Please reload this page. ... There was an error while loading. Please reload this page. ... There was an error while loading. Please reload this page. ... require-template: stop treating type parameters names as unknown template names; fixes #1648 (dfc662e) type-formatting: update jsdoccomment and devDeps.; fixes #1647 (19f36b6)
Author   gajus
🌐
Mozilla Bugzilla
bugzilla.mozilla.org › show_bug.cgi
1510561 - Investigate switching to eslint-plugin-jsdoc
I don't think the new plugin has as valid controls as the old system, so I can't replicate require-jsdoc. Attached file Bug 1510561 - Part 1: Move `browser/components/places` to `eslint-plugin-jsdoc`. r?standard8 (obsolete) — Details
🌐
jsDocs.io
jsdocs.io › package › eslint-plugin-jsdoc
eslint-plugin-jsdoc@62.8.0 - jsDocs.io
3 weeks ago - JSDoc linting rules for ESLint.
🌐
Npmpeer
npmpeer.dev › packages › eslint-plugin-jsdoc › compatibility
eslint-plugin-jsdoc versions and peer dependencies
The table below has a list of all versions of eslint-plugin-jsdoc with compatible (peer) dependencies.
🌐
UNPKG
unpkg.com › browse › eslint-plugin-jsdoc@32.3.0 › README.md
eslint-plugin-jsdoc
* `node/no-missing-import` - See `import/no-unresolved`. * `node/no-missing-require` - See `import/no-unresolved`. For `checkDefaults`, `checkParams`, and `checkProperties`, the following expression-oriented rules will be used by default as well: * `quotes` - Will insist on "double". * `semi` - Will insist on "never" * `strict` - Disabled. * `no-new` - Disabled. * `no-unused-expressions` - Disabled. <a name="eslint-plugin-jsdoc-rules-check-examples-options-for-determining-eslint-rule-applicability-allowinlineconfig-nodefaultexamplerules-matchingfilename-configfile-checkeslintrc-and-baseconfig-
Find elsewhere
🌐
GitHub
github.com › gajus › eslint-plugin-jsdoc › issues
Issues · gajus/eslint-plugin-jsdoc
#770 In gajus/eslint-plugin-jsdoc; · RunDevelopment opened · on Jul 18, 2021 ·
Author   gajus
🌐
Reddit
reddit.com › r/typescript › setting up eslint-plugin-jsdoc
r/typescript on Reddit: Setting up eslint-plugin-jsdoc
October 13, 2024 -

I'm trying to set up eslint-plugin-jsdoc to enforce JSDoc in my TS project, but for some reason the linter is not complaining at all when I don't add JSDoc above a function. My config file is as follows:

{
  "extends": ["eslint:recommended", "plugin:jsdoc/recommended"],
  "env": {
    "node": true,
    "es6": true
  },
  "parserOptions": {
    "ecmaVersion": 2021
  },
  "plugins": ["jsdoc"],
  "rules": {
    ...
  }
}

To my (limited) knowledge, as long as I have the recommended rules, the linter should enforce JSDocs for every function. Could someone please help me understand why this isn't working? I do have both ESLint and eslint-plugin-jsdoc installed:

  "devDependencies": {
    "@eslint/js": "^9.12.0",
    "@types/eslint__js": "^8.42.3",
    "@types/node": "^22.7.4",
    "eslint": "^9.12.0",
    "eslint-plugin-jsdoc": "^50.3.2",
    "globals": "^15.11.0",
    "tsx": "^4.19.1",
    "typescript": "^5.6.3",
    "typescript-eslint": "^8.8.1"
  }
Top answer
1 of 3
1
Have you actually declared the rules from the plugin? Looking at the docs, that seems to be required.
2 of 3
1
eslint v9 does not support the config style anymore. You need to either move down to v8, or upgrade to use flat configs.
🌐
ESLint
eslint.org › docs › latest › use › configure › migration-guide
Configuration Migration Guide - ESLint - Pluggable JavaScript Linter
// eslint.config.js import { defineConfig } from "eslint/config"; import jsdoc from "eslint-plugin-jsdoc"; export default defineConfig([ { files: ["**/*.js"], plugins: { jsdoc: jsdoc, }, rules: { "jsdoc/require-description": "error", "jsdoc/check-values": "error", }, }, ]);
🌐
GitHub
github.com › gajus › eslint-plugin-jsdoc › issues › 774
gajus/eslint-plugin-jsdoc
August 5, 2021 - JSDoc specific linting rules for ESLint. Contribute to gajus/eslint-plugin-jsdoc development by creating an account on GitHub.
Author   macsj200
🌐
TypeScript Analyzer
rich-newman.github.io › typescript-analyzer-eslint-prettier › setupjsdoc.html
Set Up for JSDoc Plugin | TypeScript Analyzer (ESLint, Prettier)
ESLint has a plugin to lint JSDoc comments in JavaScript code. The instructions below show how to set this up so it can be used in the TypeScript Analyzer. These instructions work in Visual Studio 2017, Visual Studio 2019 and Visual Studio 2022. Create a new Blank Node.js Console Application ...
🌐
Stack Overflow
stackoverflow.com › questions › tagged › eslint-plugin-jsdoc
Newest 'eslint-plugin-jsdoc' Questions - Stack Overflow
But whenever we export a TS type (or interface), we're warned if we don't have a jsdoc block on not only the type itself, but also on each ... ... I am writing a TypeScript project, which is meant to be run on Node (after transpilation). I have ESLint with plugins: @typescript-eslint and ...
🌐
ESLint
eslint.org › docs › latest › rules › valid-jsdoc
valid-jsdoc - ESLint - Pluggable JavaScript Linter
A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript. Maintain your code quality with ease.
🌐
Stack Overflow
stackoverflow.com › questions › 77321188 › unsupported-node-js-engine-error-for-es-joy-jsdoccomment-and-eslint-plugin-jsdo
Unsupported Node.js engine error for @es-joy/jsdoccomment and eslint-plugin-jsdoc - Stack Overflow
Top answer
1 of 1
3

Use --force command line flag to install packages within current node version

npm install package_name --force
🌐
Yarn
yarnpkg.com › package
eslint-plugin-jsdoc
Yarn is a package manager that doubles down as project manager. Whether you work on simple projects or industry monorepos, whether you're an open source developer or an enterprise user, Yarn has your back · First package manager built specifically around workspaces, Yarn lets you split your ...
🌐
Npm
npm.io › package › eslint-plugin-jsdoc
Eslint-plugin-jsdoc NPM | npm.io
Add plugins section to .eslintrc.* and specify eslint-plugin-jsdoc as a plugin.
🌐
Stack Overflow
stackoverflow.com › questions › 76391063 › eslint-error-failed-to-load-eslint-plugin-jsdoc-in-intellij-on-ubuntu-troub
typescript - ESLint error: Failed to load 'eslint-plugin-jsdoc' in IntelliJ on Ubuntu - troubleshooting tips? - Stack Overflow
The global node version was right, it was 18.14.2. but the one in the IDE was not set up correctly. 2023-06-02T15:25:40.613Z+00:00 ... Find the answer to your question by asking. Ask question ... See similar questions with these tags. ... New site design and philosophy for Stack Overflow: Starting February 24, 2026... ... I’m Jody, the Chief Product and Technology Officer at Stack Overflow, let’s... ... 1 Upgrading @vue/eslint-config-prettier 7.0.0 causes compile error - Error: Failed to load config "@vue/prettier/@typescript-eslint" to extend from
Related queries
eslint-plugin-prefer-arrow
failed to load plugin 'eslint-plugin-jsdoc'
eslint-plugin-jsdoc not working
cannot find module 'eslint-plugin-jsdoc'
eslint-plugin-import
npm angular eslint eslint plugin template
eslint-plugin-tsdoc
eslint plugin jsdoc