# eslint-config-jsdoc-essential

> Essential rules for eslint-plugin-jsdoc

Latest version **0.1.1** (published 2018-05-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-config-jsdoc-essential
pnpm add eslint-config-jsdoc-essential
yarn add eslint-config-jsdoc-essential
bun add eslint-config-jsdoc-essential
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2018-05-06 |
| First published | 2018-05-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 46.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | sobolevn |
| Maintainers | sobolevn |
| Keywords | eslint-config, eslint-plugin-jsdoc, jsdoc, eslint, documentation |

## Links

- npm: https://www.npmjs.com/package/eslint-config-jsdoc-essential
- Repository: https://github.com/wemake-services/eslint-config-jsdoc-essential
- Homepage: https://github.com/wemake-services/eslint-config-jsdoc-essential#readme
- Issues: https://github.com/wemake-services/eslint-config-jsdoc-essential/issues
- npm.io page: https://npm.io/package/eslint-config-jsdoc-essential

## Dependencies (1)

- [eslint-plugin-jsdoc](https://npm.io/package/eslint-plugin-jsdoc.md) ^3.6.3

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2018-05-06
- 0.1.0 — 2018-05-06

## README

# eslint-config-jsdoc-essential

[![wemake.services](https://img.shields.io/badge/style-wemake.services-green.svg?label=&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAABGdBTUEAALGPC%2FxhBQAAAAFzUkdCAK7OHOkAAAAbUExURQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAP%2F%2F%2F5TvxDIAAAAIdFJOUwAjRA8xXANAL%2Bv0SAAAADNJREFUGNNjYCAIOJjRBdBFWMkVQeGzcHAwksJnAPPZGOGAASzPzAEHEGVsLExQwE7YswCb7AFZSF3bbAAAAABJRU5ErkJggg%3D%3D)](http://wemake.services) [![Build Status](https://travis-ci.org/wemake-services/eslint-config-jsdoc-essential.svg?branch=master)](https://travis-ci.org/wemake-services/eslint-config-jsdoc-essential)

Shareable configuration for [`eslint-plugin-jsdoc`](https://github.com/gajus/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

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

Then, modify your `eslint` configuration:

```json
{
  "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):

```js
/**
* 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.

---
_Source: https://npm.io/package/eslint-config-jsdoc-essential · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._