# eslint-plugin-require-jsdoc-focus

> require jsdoc eslint plugin

Latest version **0.1.0** (published 2015-07-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-plugin-require-jsdoc-focus
pnpm add eslint-plugin-require-jsdoc-focus
yarn add eslint-plugin-require-jsdoc-focus
bun add eslint-plugin-require-jsdoc-focus
```

## 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.0 |
| Published | 2015-07-31 |
| First published | 2015-07-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ratheesh Naithalath |
| Maintainers | focusjs |
| Keywords | eslint, eslint-plugin, eslintplugin, plugin |

## Links

- npm: https://www.npmjs.com/package/eslint-plugin-require-jsdoc-focus
- Repository: https://github.com/Bernardstanislas/eslint-plugin-require-jsdoc
- Homepage: https://github.com/Bernardstanislas/eslint-plugin-require-jsdoc#readme
- Issues: https://github.com/Bernardstanislas/eslint-plugin-require-jsdoc/issues
- npm.io page: https://npm.io/package/eslint-plugin-require-jsdoc-focus

## 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.0 (latest) — 2015-07-31

## README

# eslint-plugin-require-jsdoc
This is a plugin for [eslint](http://eslint.org/) for enforcing all FUNCTIONS should have jsdoc.   
I had to write this because the (valid-jsdoc)(http://eslint.org/docs/rules/valid-jsdoc) rule in eslint did not help me to enforce that the functions MSUT have a jsdoc.Instead it validated the jsdoc. So for the best results **use both together** to make sure **jsdoc is a must** for all methods and **they are valid**.

##usage
Follow the instructions [here](http://eslint.org/docs/user-guide/configuring#configuring-plugins)

eg:   
(in your eslintrc)   
```json
  "plugins": [   
    "require-jsdoc"   
  ],
  "rules": {   
    "require-jsdoc": 2,  
    "valid-jsdoc": 2   
  }   
```  

##future
In future I hope to add jsdoc validation as well. Hence two rules can be avoided.   
Please let me know your feedbacks.

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