npm
npmjs.com › package › eslint-plugin-jsdoc
eslint-plugin-jsdoc - npm
5 days 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
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
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
How do I configure ESLint to check for TypeScript class property JSDoc comments? - Stack Overflow
What ESLint rule(s) am I missing that would report missing JSDocs on TypeScript properties? ... Save this answer. Show activity on this post. Firstly, I should note that eslint-plugin-jsdoc's rules are incremental. More on stackoverflow.com
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
Do you use JSDoc in Vue and how?
Yep, I personally prefer jsdoc’s intellisense hints in vscode & it also makes you think about everything when writing it out. Typescript isn’t supported that easily with vue2, compared to Vue 3, either. I would suggest getting Vue 3 setup now rather than later More on reddit.com
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"
}jsDocs.io
jsdocs.io › package › eslint-plugin-jsdoc
eslint-plugin-jsdoc@62.8.0 - jsDocs.io
3 weeks ago - 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[]> }}
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", }, }, ]); 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 Copy code to clipboard ... If you import a plugin and get an error such as “TypeError: context.getScope is not a function”, then that means the plugin has not yet been updated to the ESLint v9.x rule API. While you should file an issue with the particular plugin, you can manually patch the plugin to work in ESLint v9.x using the compatibility utilities.
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
TypeScript Analyzer
rich-newman.github.io › typescript-analyzer-eslint-prettier › setupjsdoc.html
Set Up for JSDoc Plugin | TypeScript Analyzer (ESLint, Prettier)
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. Test the rules work. Open app.js, and replace the code with the code below. This is taken from the plugin docs, and is the first example of code that fails with the plugin enabled. ... You should get a jsdoc/check-access warning ‘Missing valid JSDoc @access level’ in the Error List, along with other errors and warnings.
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.
ESLint
eslint.org › docs › latest › rules › valid-jsdoc
valid-jsdoc - ESLint - Pluggable JavaScript Linter
Note: This rule does not support all of the Google Closure documentation tool’s use cases. As such, some code such as (/**number*/ n => n * 2); will be flagged as missing appropriate function JSDoc comments even though /**number*/ is intended to be a type hint and not a documentation block for the function.
UNPKG
unpkg.com › browse › eslint-plugin-jsdoc@35.1.3 › README.md
eslint-plugin-jsdoc
JSDoc linting rules for ESLint. ... <a name="eslint-plugin-jsdoc"></a> # eslint-plugin-jsdoc [](https://gitspo.com/mentions/gajus/eslint-plugin-jsdoc) [](https://www.npmjs.org/package/eslint-plugin-jsdoc) [](https://travis-ci.org/gajus/eslint-plugin-jsdoc) [](https://github.com/gajus/canonical) [](https://discord.gg/kFFy3nc) JSDoc linting rules for ESLint.
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
GitHub
github.com › gajus › eslint-plugin-jsdoc › blob › main › docs › rules › informative-docs.md
eslint-plugin-jsdoc/docs/rules/informative-docs.md at main · 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
Issues · gajus/eslint-plugin-jsdoc
jsdoc-pratt-parser-blocked · Status: Open. #1615 In gajus/eslint-plugin-jsdoc; · alexander-akait opened · on Dec 15, 2025 · chore · Status: Open. #1578 In gajus/eslint-plugin-jsdoc; · Cevan00 opened · on Oct 22, 2025 · bug · help wanted · Status: Open.
Author gajus
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.