1994217 - Enable ESLint rule jsdoc/no-bad-blocks

Status: RESOLVED FIXED

(Developer Infrastructure :: Lint and Formatting, task, P3)

Description

[Mark Banner (:standard8)]

I spotted that eslint-plugin-jsdoc has a no-bad-blocks rule. This will catch issues where the first line of a comment has only one (or more than two) asterisk, and has @ included in it:

/*
 * @param foo
 */

There's some examples across the tree where we clearly should be jsdoc, but we haven't marked it correctly, so it isn't being picked up correctly by the relevant tools. Hence, I think we should enable this everywhere.

Comment 1

[Mark Banner (:standard8)]

Attachment: Bug 1994217 - Fix various JSDoc issues that prevent ESLint running correctly. r?#frontend-codestyle-reviewers!

These seem to cause an issues with automatically fixing JSDoc where it hits a circular cycle of fixes.

Comment 2

[Mark Banner (:standard8)]

Attachment: Bug 1994217 - Enable ESLint rule jsdoc/no-bad-blocks. r?#frontend-codestyle-reviewers!

Mainly manual fixes to fix issues found in the jsdoc comments now that they're recognised correctly.

Also removes some configuration that is no longer needed as it is now the default.

Comment 3

[Mark Banner (:standard8)]

Attachment: Bug 1994217 - Enable ESLint rule jsdoc/no-bad-blocks on the rest of the tree. r?#frontend-codestyle-reviewers!

This is mainly automatic changes, with some manual fixes to move text off of the first line.

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/0a9a458465ba
https://hg.mozilla.org/integration/autoland/rev/f087a7a5ae6d
Fix various JSDoc issues that prevent ESLint running correctly. r=frontend-codestyle-reviewers,credential-management-reviewers,devtools-reviewers,sessionstore-reviewers,omc-reviewers,toolkit-telemetry-reviewers,nsharpley,jdescottes,Gijs,mtigley,nchevobbe,emcminn,janerik
https://github.com/mozilla-firefox/firefox/commit/1c5b20a293a7
https://hg.mozilla.org/integration/autoland/rev/41d25adcf808
Enable ESLint rule jsdoc/no-bad-blocks. r=frontend-codestyle-reviewers,webdriver-reviewers,credential-management-reviewers,search-reviewers,fxview-reviewers,places-reviewers,whimboo,nsharpley,scunnane,Gijs,mtigley,daisuke
https://github.com/mozilla-firefox/firefox/commit/987c3ad13094
https://hg.mozilla.org/integration/autoland/rev/79ea8a727df1
Enable ESLint rule jsdoc/no-bad-blocks on the rest of the tree. r=frontend-codestyle-reviewers,Gijs

Comment 5

[Cristina Horotan [:chorotan]]

https://hg.mozilla.org/mozilla-central/rev/f087a7a5ae6d
https://hg.mozilla.org/mozilla-central/rev/41d25adcf808
https://hg.mozilla.org/mozilla-central/rev/79ea8a727df1

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/89c0ffec7c0a
https://hg.mozilla.org/integration/autoland/rev/2980ddd553df
Revert "Bug 1994217 - Enable ESLint rule jsdoc/no-bad-blocks on the rest of the tree. r=frontend-codestyle-reviewers,Gijs" for causing Documentation opt failure

Comment 7

[Narcis Beleuzu [:NarcisB]]

Backed out for causing Documentation opt failure

Backout link: https://hg-edge.mozilla.org/integration/autoland/rev/2980ddd553dff774d89e82275d6a2172ae2dd062
Log link: https://treeherder.mozilla.org/logviewer?job_id=531704209&repo=autoland&task=eaFHPdriTaOpYXLvNlyN5Q.0&lineNumber=2695

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/dcb9158c5254
https://hg.mozilla.org/integration/autoland/rev/fa596741af38
Fix various JSDoc issues that prevent ESLint running correctly. r=frontend-codestyle-reviewers,credential-management-reviewers,devtools-reviewers,sessionstore-reviewers,omc-reviewers,toolkit-telemetry-reviewers,nsharpley,jdescottes,Gijs,mtigley,nchevobbe,emcminn,janerik
https://github.com/mozilla-firefox/firefox/commit/fde74f7d411e
https://hg.mozilla.org/integration/autoland/rev/f231d17d6ee6
Enable ESLint rule jsdoc/no-bad-blocks. r=frontend-codestyle-reviewers,webdriver-reviewers,credential-management-reviewers,search-reviewers,fxview-reviewers,places-reviewers,whimboo,nsharpley,scunnane,Gijs,mtigley,daisuke
https://github.com/mozilla-firefox/firefox/commit/dde0952bd6f4
https://hg.mozilla.org/integration/autoland/rev/5eae8d9d60a6
Enable ESLint rule jsdoc/no-bad-blocks on the rest of the tree. r=frontend-codestyle-reviewers,Gijs

Comment 9

[pstanciu]

https://hg.mozilla.org/mozilla-central/rev/fa596741af38
https://hg.mozilla.org/mozilla-central/rev/f231d17d6ee6
https://hg.mozilla.org/mozilla-central/rev/5eae8d9d60a6