Registry / testing / eslint-plugin-require-jsdoc

eslint-plugin-require-jsdoc

library1.0.4jsnpmunverified

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.

testing

npm install eslint-plugin-require-jsdoc

github ↗package ↗

INSTALL

IMPORT

SIG · ESLINT-PLUGIN-REQU

eslint-plugin-require-jsdoc

testingjavascriptv1.0.4

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

plugin

✓ plugins: ['require-jsdoc']

✗ plugins: ['eslint-plugin-require-jsdoc']

In ESLint config, omit the 'eslint-plugin-' prefix when referencing the plugin.

require-jsdoc rule

✓ "require-jsdoc": 2

✗ "require-jsdoc": "error"

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.

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

Debug

Known issues

deprecatedThis 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.

affects: >=1.0.4

gotchaThe 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.

affects: >=0.8.0 <2.0.0

gotchaPlugin 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.

affects: *

Errors

Common errors & fixes

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

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').

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

Plugin required but not in node_modules.

fix

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

Upgrade

Version history

1.0.4latest on npm

Audit

Dependencies

eslintrequiredpeer dependency required to function as an ESLint plugin

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/nrsedat/eslint-plugin-require-jsdoc ↗

packagehttps://www.npmjs.com/package/eslint-plugin-require-jsdoc ↗