eslint-config-jsdoc-essential

Shareable configuration for eslint-plugin-jsdoc.

The main idea of this configuration is to be:

1. Strict about syntax
2. Permissive about types (because we use flow for type annotations)
3. Opened for further extensions

Installation

npm install --save-dev eslint-config-jsdoc-essential

Then, modify your eslint configuration:

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

Done! Later you can modify your configuration to include any extra rules you need.

Code example

This code is considered valid (and beautiful):

/**
* Sums two numbers.
* This is just an example.
*
* @param a - First number.
* @param b - Second number.
* @returns Sum of the numbers, obviously.
*/
function sum (a, b) {
  return proxyRequest(value)
}

License

MIT.