1319786 - Add eslint for JSDocs in DevTools

Status: NEW

(DevTools :: General, enhancement, P3)

Description

[Gabriel Luong [:gl] (ΦωΦ)]

The purpose of this bug is to look into adding eslint rules for reinforcing consistent JSDocs.

Comment 1

[Patrick Brosset <:pbro>]

Thanks for filing. I'd very much like us to have this in place.
When we put eslint in place, I tried to enable the jsdoc rule, but it was failing then.

My comment from back then in https://old.etherpad-mozilla.org/eslint-devtools :

valid-jsdoc
http://eslint.org/docs/rules/valid-jsdoc
Ensure JSDoc comments are valid (off by default)
requireReturn: false, requireParamDescription: false, requireReturnDescription: false
The rule has a known bug that makes the eslint command fail on some of our files:
https://github.com/eslint/eslint/issues/2270
Fails with browser/devtools/webconsole/console-output.js

Things might have changed since, so it's worth trying again.
I'm just worried about the amount of changes enabling this rule will require, especially on files that are not currently excluded in .eslintignore.

Comment 2

[Mark Banner (:standard8) (afk until 21st July)]

Adding dependency on bug 1510561 - as jsdoc validation got moved out of ESLint into a separate plug-in, we'd want to have that bug install the module & set up standard settings before enabling here.

Comment 3

[Mark Banner (:standard8) (afk until 21st July)]

There's now two roll-out sections where devtools could be removed for enabling our jsdoc collections of rules: valid-jsdoc and require-jsdoc.

As these are exclusions, they could also be altered to progressively exclude less code & hence enable a gradual roll-out.