npm
npmjs.com › package › eslint-plugin-jsdoc
eslint-plugin-jsdoc - npm
If you have installed ESLint globally, you have to install JSDoc plugin globally too.
» npm install eslint-plugin-jsdoc
Published Feb 24, 2026
Version 62.7.1
Author Gajus Kuizinas
Repository https://github.com/gajus/eslint-plugin-jsdoc
GitHub
github.com › gajus › eslint-plugin-jsdoc › issues › 774
gajus/eslint-plugin-jsdoc
August 5, 2021 - The engine "node" is incompatible with this module. Expected version "^12.20 || ^14.14.0 || ^16".
Published Aug 05, 2021
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-
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"
}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.
jsDocs.io
jsdocs.io › package › eslint-plugin-jsdoc
eslint-plugin-jsdoc@62.7.1 - jsDocs.io
@types/node · @types/semver · @types/spdx-expression-parse · @typescript-eslint/types · babel-plugin-add-module-exports · babel-plugin-istanbul · babel-plugin-transform-import-meta · c8 · camelcase · chai · decamelize · eslint · eslint-config-canonical ·
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
Recent versions of eslint-plugin-jsdoc depend on Node 16 as a minimum version.
TypeScript Analyzer
rich-newman.github.io › typescript-analyzer-eslint-prettier › setupjsdoc.html
Set Up for JSDoc Plugin | TypeScript Analyzer (ESLint, Prettier)
This is the usual default configuration file for the TypeScript Analyzer modified to enable the JSDoc plugin. The actual changes made are detailed at the end of this article. On the Tools/Options/TypeScript Analyzer/ESLint screen, check that both ‘Enable local config (.eslintrc.js)’ and ‘Enable local node_modules’ are set to True, which is the default.
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
GitHub
github.com › gajus › eslint-plugin-jsdoc › issues › 917
Support node 19 · Issue #917 · gajus/eslint-plugin-jsdoc
April 12, 2022 - Installing eslint-plugin-jsdoc when using node 19 should work. We could use something like yarn install --ignore-engines as a workaround but that opens us up to compatibility errors that will only show up at runtime.
Published Oct 18, 2022
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 ...
GitHub
github.com › dotnet › aspnetcore › issues › 48146
Build fails with node 20 · Issue #48146 · dotnet/aspnetcore
March 22, 2023 - error eslint-plugin-jsdoc@39.9.1: The engine "node" is incompatible with this module. Expected version "^14 || ^16 || ^17 || ^18 || ^19". Got "20.1.0" Node 20 is supported from eslint-plugin-jsdoc 43.0.5+. cc @BrennanConroy
Published May 09, 2023
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 { includeIgnoreFile } from "@eslint/compat"; import { fileURLToPath } from "node:url"; const gitignorePath = fileURLToPath(new URL(".gitignore", import.meta.url)); export default defineConfig([ includeIgnoreFile(gitignorePath, "Imported .gitignore patterns"), // other configs ]); ... The --no-eslintrc flag has been replaced with --no-config-lookup. The --resolve-plugins-relative-to flag was used to indicate which directory plugin references in your configuration file should be resolved relative to.
ESLint
eslint.org › docs › latest › use › migrate-to-9.0.0
Migrate to v9.x - ESLint - Pluggable JavaScript Linter
The changes you’ll need to make to satisfy RuleTester are compatible with ESLint v8.x. ... As announced in our blog post, the temporary FlatESLint class has been renamed to ESLint, while the ESLint class from v8.x has been renamed to LegacyESLint. To address: If you are currently using the ESLint class, verify that your tests pass using the new ESLint class. Not all of the old options are supported, so you may need to update the arguments passed to the constructor. See the Node.js API Reference for details.
Stack Overflow
stackoverflow.com › questions › 55378746 › eslint-plugin-jsdoc-does-not-get-executed
eslint-plugin-jsdoc does not get executed
4 Resolve eslint(node/no-unsupported-features/es-syntax) - How to support JavaScript modules in ESLint? 0 Eslint wont work because of eslint plugin error? 2 How do I configure ESLint to check for TypeScript class property JSDoc comments?
UNPKG
unpkg.com › browse › eslint-plugin-jsdoc@35.0.0 › README.md
eslint-plugin-jsdoc/README.md
* `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-
Npm
npm.io › package › eslint-plugin-jsdoc
Eslint-plugin-jsdoc NPM | npm.io
If you have installed ESLint globally, you have to install JSDoc plugin globally too.