@wemake-services/eslint-config-jsdoc

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

1npm install --save-dev @wemake-services/eslint-config-jsdoc

Then, modify your eslint configuration:

1{
2  "extends": [
3    "@wemake-services/jsdoc"
4  ]
5}

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

Code example

This code is considered valid (and beautiful):

1/**
2 * Imaginary function to take same slices from imaginary pizza.
3 * This function is created, because we love pizza.
4 *
5 * @param pizza - {Array} List of slices.
6 * @param numberOfSlices - Number of slices to take away.
7 * @returns {Array} What is left of our pizza.
8 */
9function takeSlices (pizza, numberOfSlices) {
10  return pizza.splice(0, numberOfSlices)
11}

License

MIT.