eslint-plugin-jsdoc
Advanced tools
Package description
The eslint-plugin-jsdoc package is a plugin for ESLint that provides linting rules for JSDoc comments. JSDoc is a markup language used to annotate JavaScript source code files. Using eslint-plugin-jsdoc, developers can ensure that their JSDoc comments are consistent and follow best practices.
Check alignment
Ensures that JSDoc blocks are aligned properly.
/* eslint jsdoc/check-alignment: "error" */
/**
* Function description.
*
* @param {string} name - The name of the person.
* @return {string} - The greeting message.
*/
function greet(name) {
return `Hello, ${name}!`;
}Check indentation
Ensures that JSDoc blocks have consistent indentation.
/* eslint jsdoc/check-indentation: "error" */
/**
* Function description.
*
* @param {string} name - The name of the person.
* @return {string} - The greeting message.
*/
function greet(name) {
return `Hello, ${name}!`;
}Check types
Validates JSDoc comments for type correctness.
/* eslint jsdoc/check-types: "error" */
/**
* Function description.
*
* @param {String} name - The name of the person.
* @return {String} - The greeting message.
*/
function greet(name) {
return `Hello, ${name}!`;
}Require JSDoc
Requires JSDoc comments for certain nodes in the code.
/* eslint jsdoc/require-jsdoc: "error" */
/**
* Function description.
*/
function greet(name) {
return `Hello, ${name}!`;
}TSDoc is a documentation comment format used for TypeScript source files. It is similar to JSDoc but tailored for the TypeScript language, providing a standardized way to document TypeScript APIs. Unlike eslint-plugin-jsdoc, TSDoc does not provide linting rules but focuses on the comment format itself.
The 'documentation' package is a documentation generator that uses JSDoc comments to produce documentation for JavaScript code. It is similar to eslint-plugin-jsdoc in that it processes JSDoc comments, but its primary purpose is to generate documentation rather than lint code.
TypeDoc is a documentation generator for TypeScript projects. It reads TypeScript source files and JSDoc comments to produce documentation. While eslint-plugin-jsdoc focuses on linting JSDoc comments, TypeDoc uses them to generate documentation websites or markdown files.
Readme
JSDoc specific linting rules for ESLint.
Unusual, but I want to start the documentation with attribution to JSCS: JavaScript Code Style checker. This ESLint plugin is a wrapper around JSCS and the jscs-jsdoc plugin.
The reason for writing this plugin is to have all the linting rules in a consistent, plugin driven setup, that ESLint provides.
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-redundant-params": 1,
"jsdoc/check-redundant-returns": 1,
"jsdoc/require-return-types": 1,
"jsdoc/newline-after-description": 1,
"jsdoc/require-description-complete-sentence": 1,
"jsdoc/require-param-description": 1,
"jsdoc/require-param-types": 1,
"jsdoc/require-return-types": 1
}
}
check-param-namesEnsures param 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
*/
function quux (bar) {
}
The following patterns are not considered problems:
/**
* @param foo
* @param bar
*/
function quux (foo, bar) {
}
/**
* @param foo
*/
function quux (foo) {
}
check-redundant-paramsReports redundant params in JSDoc.
The following patterns are considered problems:
/**
* @param {String} foo
*/
function quux () {
}
The following patterns are not considered problems:
/**
* @param {String} foo
*/
function quux (foo) {
}
check-redundant-returnsReport statements for functions with no return.
The following patterns are considered problems:
/**
* @returns {String}
*/
function quux () {
}
The following patterns are not considered problems:
/**
* @returns {String}
*/
function quux () {
return 'corge';
}
require-return-typesEnsures returns in JSDoc contains type.
The following patterns are considered problems:
/**
* @returns
*/
function quux () {
}
The following patterns are not considered problems:
/**
* @returns {String}
*/
function quux () {
}
/**
* no @return
*/
function quux () {
}
newline-after-descriptionEnforces consistent padding of doc comment description.
This rule takes one argument. If it is "always" then a problem is raised when there is a newline after 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 when configured "never":
/**
* Description
*
* @param {String} foo
*/
function quux (foo) {
}
The following patterns are not considered problems when configured "never":
/**
* @param {String} foo
*/
function quux (foo) {
}
/**
* Description
*/
function quux () {
}
/**
* Description
* @param {String} foo
*/
function quux (foo) {
}
The following patterns are considered problems when configured "always":
/**
* Description
* @param {String} foo
*/
function quux (foo) {
}
The following patterns are not considered problems when configured "always":
/**
* @param {String} foo
*/
function quux (foo) {
}
/**
* Description
*/
function quux () {
}
/**
* Description
*
* @param {String} foo
*/
function quux (foo) {
}
require-description-complete-sentenceEnsures a doc comment description is a complete sentence.
A complete sentence is defined as starting with an upper case letter and ending with a period.
The following patterns are considered problems:
/**
* Description
* On multiple lines.
*
* @param {String} foo
*/
function quux (foo) {
}
/**
* Description
* @param {String} foo
*/
function quux (foo) {
}
/**
* description starting with a lower case letter.
* @param {String} foo
*/
function quux (foo) {
}
/**
* Description period is offset .
* @param {String} foo
*/
function quux (foo) {
}
/**
* Description!
* @param {String} foo
*/
function quux (foo) {
}
The following patterns are not considered problems:
/**
* @param {String} foo
*/
function quux (foo) {
}
/**
* Description.
*/
function quux () {
}
/**
* (Description).
*/
function quux () {
}
/**
* Description.
*
* @param {String} foo
*/
function quux (foo) {
}
require-param-descriptionEnsures a param description exists.
The following patterns are considered problems:
/**
* @param {String} foo
*/
function quux (foo) {}
/**
* @param foo
*/
function quux (foo) {
}
The following patterns are not considered problems:
/**
* @param {String} foo Foo.
*/
function quux (foo) {
}
/**
* @param foo Foo.
*/
function quux (foo) {
}
require-param-typesThe following patterns are considered problems:
/**
* @param foo
*/
function quux () {
}
The following patterns are not considered problems:
/**
* @param {String} foo
*/
function quux () {
}
check-return-typesReports discrepancies between the claimed in JSDoc and actual type if both exist (code scan).
The following patterns are considered problems:
/**
* @returns {String}
*/
function quux () {
return true;
}
The following patterns are not considered problems:
/**
* @returns {String}
*/
function quux () {
return 'corge';
}
FAQs
JSDoc linting rules for ESLint.
We found that eslint-plugin-jsdoc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.