🌐
npm
npmjs.com › package › eslint-plugin-jsdoc
eslint-plugin-jsdoc - npm
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   Feb 24, 2026
Version   62.7.1
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...
Author   gajus
🌐
jsDocs.io
jsdocs.io › package › eslint-plugin-jsdoc
eslint-plugin-jsdoc@62.7.1 - jsDocs.io
JSDoc linting rules for ESLint. ... {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups {"" | "-typescript" | "-typescript-flavor"} ConfigVariants {"" | "-error"} ErrorLevelVariants {import('eslint').ESLint.Plugin & { configs: Record< flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}, import('eslint').Linter.Config > & Record< "examples"|"default-expressions"|"examples-and-default-expressions", import('eslint').Linter.Config[] > & Record<"flat/recommended-mixed", import('eslint').Linter.Config[]> }}
🌐
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.
🌐
Socket
socket.dev › npm › package › eslint-plugin-jsdoc
eslint-plugin-jsdoc - npm Package Security Analysis - Socket
It reads TypeScript source files and JSDoc comments to produce documentation. While eslint-plugin-jsdoc focuses on linting JSDoc comments, TypeDoc uses them to generate documentation websites or markdown files.
🌐
TypeScript Analyzer
rich-newman.github.io › typescript-analyzer-eslint-prettier › setupjsdoc.html
Set Up for JSDoc Plugin | TypeScript Analyzer (ESLint, Prettier)
If there is one there already you need to update it as below. If the package.json contains an empty eslintConfig section you can remove this entire section. The dependencies below are those that the TypeScript Analyzer needs locally, plus the new plugin, eslint-plugin-jsdoc:
🌐
ESLint
eslint.org › docs › latest › rules › require-jsdoc
require-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.
🌐
GitHub
github.com › gajus › eslint-plugin-jsdoc › releases
Releases · gajus/eslint-plugin-jsdoc
JSDoc specific linting rules for ESLint. Contribute to gajus/eslint-plugin-jsdoc development by creating an account on GitHub.
Author   gajus
🌐
UNPKG
unpkg.com › browse › eslint-plugin-jsdoc@32.3.0 › README.md
eslint-plugin-jsdoc
```sh npm install --save-dev eslint-plugin-jsdoc ``` <a name="eslint-plugin-jsdoc-configuration"></a> ## Configuration Add `plugins` section to [.eslintrc.*](https://eslint.org/docs/user-guide/configuring#configuration-file-formats) and specify `eslint-plugin-jsdoc` as a plugin.
🌐
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 ...
Find elsewhere
🌐
npm
npmjs.com › package › eslint-plugin-jsdoc-typescript
eslint-plugin-jsdoc-typescript - npm
This plugin adds new `jsdoc` rules specifically for using typescript with `checkJs` & jsdoc comments.. Latest version: 2.1.0, last published: 5 years ago. Start using eslint-plugin-jsdoc-typescript in your project by running `npm i ...
      » npm install eslint-plugin-jsdoc-typescript
Published   Jan 16, 2021
Version   2.1.0
🌐
ESLint
eslint.org › blog › 2018 › 11 › jsdoc-end-of-life
End-of-Life for Built-in JSDoc Support in ESLint - ESLint - Pluggable JavaScript Linter
With nearly 7 million weekly downloads on npm, it seemed like the best option for existing users was to end-of-life the Doctrine project rather than try to find a new maintainer. We believe a better option for an interested new maintainer would be to fork Doctrine and start fresh rather than try to take over the way Doctrine had already been maintained. We are keeping the existing JSDoc rules to give users plenty of time to transition to using eslint-plugin-jsdoc.
🌐
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.
🌐
Medium
medium.com › @psiphi75 › using-typescript-typechecker-eslint-jsdoc-and-prettier-to-write-javascript-205a2f07a4f3
Writing JavaScript better and faster using TypeScript TypeChecker, ESLint, JSDoc and Prettier | by Simon Werner | Medium
April 2, 2019 - Because JSDoc is contained in your ... You can use jsdoc to create documentation for your project. Install jsdoc using npm install --save-dev jsdoc, then run it using ./node_modules/.bin/jsdoc yourJavaScriptFile.js....
🌐
ESLint
eslint.org › docs › latest › use › configure › migration-guide
Configuration Migration Guide - ESLint - Pluggable JavaScript Linter
For example, this eslintrc config file loads eslint-plugin-jsdoc and configures rules from that plugin:
🌐
Stack Overflow
stackoverflow.com › questions › 76561691 › issue-with-eslint
npm - Issue with ESLint - Stack Overflow
node_modules/eslint-plugin-jsdoc/dist/rules/informativeDocs.js:95 descriptionReported ||= tag.description === description && /** @type {import('comment-parser').Spec & {line: import('../iterateJsdoc.js').Integer}} */
🌐
GitHub
github.com › gajus › eslint-plugin-jsdoc › blob › main › package.json
eslint-plugin-jsdoc/package.json at main · gajus/eslint-plugin-jsdoc
"@es-joy/jsdoc-eslint-parser": "^0.27.0", "@eslint/core": "^1.1.0", "@hkdobrev/run-if-changed": "^0.6.3", "@rollup/plugin-node-resolve": "^16.0.3", "@semantic-release/commit-analyzer": "^13.0.1", "@semantic-release/github": "^12.0.3", "@semantic-release/npm": "^13.1.3", "@types/chai": "^5.2.3", "@types/debug": "^4.1.12", "@types/espree": "^10.1.0", "@types/esquery": "^1.5.4", "@types/estree": "^1.0.8", "@types/json-schema": "^7.0.15", "@types/mocha": "^10.0.10", "@types/node": "^25.2.0", "@types/semver": "^7.7.1", "@types/spdx-exp
Author   gajus
🌐
Lightrun
lightrun.com › answers › hosseinmd-prettier-plugin-jsdoc-feature-request-eslint--eslint-plugin-jsdoc-integration
Feature Request: eslint & eslint-plugin-jsdoc integration
ESLint shareable config for JSDoc-related rules: ESLint require-jsdoc and valid-jsdoc rules,; All eslint-plugin-jsdoc plugin ...Read more > Configuration Files (New) - ESLint - Pluggable JavaScript Linter · This is an experimental feature. To opt-in, place an eslint.config.js file in the root of your project or set the ESLINT_USE_FLAT_CONFIG environment ...Read more > @eslint-recommended/eslint-config-typescript - NPM Package ...
🌐
Npm
npm.io › package › eslint-plugin-jsdoc
Eslint-plugin-jsdoc NPM | npm.io
Problems reported by rules which have a wrench :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). ... @es-joy/jsdoccommentare-docs-informativecomment-parserdebugescape-string-regexpespreeesqueryparse-importssemverspdx-expression-parsesynckit
🌐
DEV Community
dev.to › thejaredwilcurt › comment › 1of4e
Everything TS is trying to do is done better with eslint-plugin-jsdoc. It let... - DEV Community
Everything TS is trying to do is done better with eslint-plugin-jsdoc. It lets you document the types, and as you write your code your editor will do the exact same thing it would with TS types.