JSDoc specific linting rules for ESLint.
This table maps the rules between eslint-plugin-jsdoc
and jscs-jsdoc
.
Install ESLint either locally or globally.
$ npm install eslint
If you have installed ESLint
globally, you have to install JSDoc plugin globally too. Otherwise, install it locally.
$ npm install eslint-plugin-jsdoc
Add plugins
section and specify eslint-plugin-jsdoc as a plugin.
{
"plugins": [
"jsdoc"
]
}
Finally, enable all of the rules that you would like to use.
{
"rules": {
"jsdoc/check-param-names": 1,
"jsdoc/check-tag-names": 1,
"jsdoc/check-types": 1,
"jsdoc/newline-after-description": 1,
"jsdoc/require-hyphen-before-description": 1,
"jsdoc/require-param": 1,
"jsdoc/require-param-description": 1,
"jsdoc/require-param-type": 1,
"jsdoc/require-returns-description": 1,
"jsdoc/require-returns-type": 1
}
}
Ensures that parameters names in JSDoc and in function declaration are equal.
The following patterns are considered problems:
/**
* @param foo
* @param bar
*/
function quux (bar, foo) {
}
/**
* @param foo
* @param bar
*/
function quux (foo) {
}
The following patterns are not considered problems:
/**
*
*/
function quux (foo) {
}
/**
* @param foo
*/
function quux (foo) {
}
/**
* @param foo
* @param bar
*/
function quux (foo, bar) {
}
/**
* @param foo
* @param bar
*/
function quux (foo, bar, baz) {
}
/**
* @param foo
* @param foo.foo
* @param bar
*/
function quux (foo, bar) {
}
Reports invalid block tag names.
Valid JSDoc 3 Block Tags are:
abstract
access
alias
augments
author
borrows
callback
class
classdesc
constant
constructs
copyright
default
deprecated
description
enum
event
example
exports
external
file
fires
function
global
ignore
implements
inheritdoc
inner
instance
interface
kind
lends
license
listens
member
memberof
mixes
mixin
module
name
namespace
override
param
private
property
protected
public
readonly
requires
returns
see
since
static
summary
this
throws
todo
tutorial
type
typedef
variation
version
The following patterns are considered problems:
/**
* @Param
*/
function quux () {
}
/**
* @foo
*/
function quux () {
}
The following patterns are not considered problems:
/**
* @param {number} foo
*/
function quux (foo) {
}
Reports invalid types.
Ensures that case of native types is the same as in this list:
boolean
number
string
Object
Array
Date
RegExp
Affected tags:
class
constant
enum
member
module
namespace
param
property
returns
throws
type
typede
The following patterns are considered problems:
/**
* @param {Number} foo
*/
function quux (foo) {
}
The following patterns are not considered problems:
/**
* @param {number} foo
* @param {Bar} bar
* @param {*} baz
*/
function quux (foo, bar, baz) {
}
Enforces a consistent padding of the block description.
This rule takes one argument. If it is "always"
then a problem is raised when there is a newline after the description. If it is "never"
then a problem is raised when there is no newline after the description. The default value is "always"
.
The following patterns are considered problems:
/**
* Foo.
*
* Foo.
* @foo
*/
function quux () {
}
/**
* Bar.
*
* Bar.
*
* @bar
*/
function quux () {
}
The following patterns are not considered problems:
/**
* Foo.
*/
function quux () {
}
/**
* Bar.
*/
function quux () {
}
/**
* Foo.
*
* @foo
*/
function quux () {
}
/**
* Bar.
* @bar
*/
function quux () {
}
Requires that @param
tag has description
value.
The following patterns are considered problems:
/**
* @param foo
*/
function quux (foo) {
}
The following patterns are not considered problems:
/**
*
*/
function quux (foo) {
}
/**
* @param foo Foo.
*/
function quux (foo) {
}
Requires that all function parameters are documented.
The following patterns are considered problems:
/**
*
*/
function quux (foo) {
}
/**
* @param foo
*/
function quux (foo, bar) {
}
The following patterns are not considered problems:
/**
* @param foo
*/
function quux (foo) {
}
Requires that @param
tag has description
value.
The following patterns are considered problems:
/**
* @param foo
*/
function quux (foo) {
}
The following patterns are not considered problems:
/**
*
*/
function quux (foo) {
}
/**
* @param foo Foo.
*/
function quux (foo) {
}
Requires that @param
tag has type
value.
The following patterns are considered problems:
/**
* @param foo
*/
function quux (foo) {
}
The following patterns are not considered problems:
/**
*
*/
function quux (foo) {
}
/**
* @param {number} foo
*/
function quux (foo) {
}
Requires that @returns
tag has description
value.
The following patterns are considered problems:
/**
* @returns
*/
function quux (foo) {
}
The following patterns are not considered problems:
/**
*
*/
function quux () {
}
/**
* @returns Foo.
*/
function quux () {
}
Requires that @returns
tag has type
value.
The following patterns are considered problems:
/**
* @returns
*/
function quux () {
}
/**
* @returns Foo.
*/
function quux () {
}
The following patterns are not considered problems:
/**
* @returns {number}
*/
function quux () {
}