README.md

Standard JSDoc - ESLint Shareable Config

An ESLint Shareable Config for JSDoc support

Install

npm install eslint-config-standard-jsdoc

Notice: This plugin doesn't depend on standard style and can be used with any other style guide, like as Airbnb Style

Usage

Shareable configs are designed to work with the extends feature of .eslintrc files. You can learn more about Shareable Configs on the official ESLint website.

This Shareable Config adds JSDoc to the baseline JavaScript Standard Style rules provided in eslint-config-standard.

Here's how to install everything you need:

npm install eslint-config-standard-jsdoc eslint-plugin-jsdoc

Then, add this to your .eslintrc file, if you use vanila js or TypeScript with JSDOC :

{
  "extends": [ "standard-jsdoc"]
}

Or, if you use pure TypeScript

{
  "extends": [ "standard-jsdoc/ts"]
}

Note: We omitted the eslint-config- prefix since it is automatically assumed by ESLint.

You can override settings from the shareable config by adding them directly into your .eslintrc file.

License

MIT