eslint-plugin-require-jsdoc

1.0.4 verified Sat Apr 25 auth: no javascript deprecated

An ESLint plugin (v1.0.4, last updated circa 2015) that enforces JSDoc comments on all functions. Unlike ESLint's built-in valid-jsdoc rule which validates JSDoc syntax, this plugin ensures every function has a JSDoc block. It was designed to be used alongside valid-jsdoc for best results. No longer actively maintained; users should consider using the built-in require-jsdoc rule introduced in ESLint 3.x or modern alternatives like eslint-plugin-jsdoc.

Common errors

error ESLint configuration error: "require-jsdoc" plugin cannot be found. ↓

cause Plugin not installed or referenced incorrectly in ESLint config.

fix

Run npm install eslint-plugin-require-jsdoc and ensure the plugin name in your config is 'require-jsdoc' (not 'eslint-plugin-require-jsdoc').

error Failed to load plugin 'require-jsdoc': Cannot find module 'eslint-plugin-require-jsdoc' ↓

cause Plugin required but not in node_modules.

fix

Install the plugin via npm install eslint-plugin-require-jsdoc --save-dev.

Warnings

deprecated This plugin is no longer maintained. ESLint's built-in require-jsdoc rule (added in ESLint 3.0.0) provides similar functionality. ↓

fix Use ESLint's built-in require-jsdoc rule or adopt eslint-plugin-jsdoc for more comprehensive JSDoc enforcement.

gotcha The plugin requires ESLint >=0.8.0 and is not compatible with ESLint 2.x or later due to configuration changes. ↓

fix Use with ESLint 1.x only. For ESLint 2+, use built-in require-jsdoc or eslint-plugin-jsdoc.

gotcha Plugin only enforces JSDoc presence, not validity. Always pair with valid-jsdoc rule. ↓

fix Add "valid-jsdoc": 2 to your ESLint rules to validate JSDoc syntax.

Install

npm install eslint-plugin-require-jsdoc

yarn add eslint-plugin-require-jsdoc

pnpm add eslint-plugin-require-jsdoc

Imports

plugin
wrong
```
plugins: ['eslint-plugin-require-jsdoc']
```
correct
```
plugins: ['require-jsdoc']
```
In ESLint config, omit the 'eslint-plugin-' prefix when referencing the plugin.
require-jsdoc rule
wrong
```
"require-jsdoc": "error"
```
correct
```
"require-jsdoc": 2
```
ESLint 0.x and 1.x used numeric severity levels. The string 'error' is supported in later versions but this plugin predates that.
valid-jsdoc rule
```
"valid-jsdoc": 2
```
Recommended to combine with require-jsdoc for full JSDoc enforcement.

Quickstart

Configures ESLint to require JSDoc on all functions using both the require-jsdoc and valid-jsdoc rules.

// .eslintrc
{
  "plugins": ["require-jsdoc"],
  "rules": {
    "require-jsdoc": 2,
    "valid-jsdoc": 2
  }
}

// Functions without JSDoc will now trigger an error:
function foo() {} // Error: Missing JSDoc comment

// Functions with JSDoc pass:
/**
 * Does something.
 */
function bar() {} // OK