1870226 - Update eslint-plugin-jsdoc

Status: RESOLVED FIXED

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

Description

[Mark Banner (:standard8)]

We've not updated eslint-plugin-jsdoc for a while, and it looks like there's various improvements and other fixes that would be good for us to get.

Additionally this changes the defaults for enabling TypeScript within JSDoc which will mean that we can remove the configuration parts we are adding in bug 1862464, as they will be the default.

Comment 1

[Mark Banner (:standard8)]

Attachment: Bug 1870226 - Fix missing jsdoc @returns for search code. r?#search-reviewers!

Comment 2

[Mark Banner (:standard8)]

Attachment: Bug 1870226 - Fix missing jsdoc @returns for Urlbar code. r?#urlbar-reviewers!

Comment 3

[Mark Banner (:standard8)]

Attachment: Bug 1870226 - Fix missing jsdoc @returns for places code. r?#places-reviewers!

Comment 4

[Mark Banner (:standard8)]

Attachment: Bug 1870226 - Fix missing jsdoc @returns for other browser code. r?#firefox-desktop-core-reviewers!.

Comment 5

[Mark Banner (:standard8)]

Attachment: Bug 1870226 - Use typescript Record definitions rather than Object<> generic forms for jsdoc. r?zombie!

Comment 6

[Mark Banner (:standard8)]

Attachment: Bug 1870226 - Upgrade eslint-plugin-jsdoc to version 43.2.0. r?#frontend-codestyle-reviewers!

This switches from the deprecated/removed jsdoc/newline-after-description rule to using the replacement jsdoc/tag-lines rule.

Comment 7

[Mark Banner (:standard8)]

Attachment: Bug 1870226 - Upgrade eslint-plugin-jsdoc to version 50.2.2. r?#frontend-codestyle-reviewers!,zombie!

Also fixes a few issues found with the newer versions of eslint-plugin-jsdoc.

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/f64ad89c2406
Fix missing jsdoc @returns for search code. r=search-reviewers,jteow
https://hg.mozilla.org/integration/autoland/rev/7a98dfef087f
Fix missing jsdoc @returns for Urlbar code. r=urlbar-reviewers,daisuke
https://hg.mozilla.org/integration/autoland/rev/77c78201a206
Fix missing jsdoc @returns for places code. r=places-reviewers,daisuke
https://hg.mozilla.org/integration/autoland/rev/a506c0f0ce28
Fix missing jsdoc @returns for other browser code. r=firefox-desktop-core-reviewers ,backup-reviewers,kpatenio.
https://hg.mozilla.org/integration/autoland/rev/21ea9baf83ea
Use typescript Record definitions rather than Object<> generic forms for jsdoc. r=zombie,webdriver-reviewers,omc-reviewers,aminomancer,kpatenio
https://hg.mozilla.org/integration/autoland/rev/e85a5647cae4
Upgrade eslint-plugin-jsdoc to version 43.2.0. r=frontend-codestyle-reviewers,credential-management-reviewers,issammani
https://hg.mozilla.org/integration/autoland/rev/619244623dba
Upgrade eslint-plugin-jsdoc to version 50.2.2. r=zombie,frontend-codestyle-reviewers,translations-reviewers,backup-reviewers,kpatenio

Comment 9

[Atila Butkovits]

Backed out for causing build bustages.

Backout link: https://hg.mozilla.org/integration/autoland/rev/b10b7638354475aa89e4b88fc4ced87da0c24302

Push with failures: https://treeherder.mozilla.org/jobs?repo=autoland&resultStatus=testfailed%2Cbusted%2Cexception%2Cretry%2Cusercancel&revision=619244623dba7d799f48e1f3007a0d464788a0f5&selectedTaskRun=Bh9aW9HCTsuC0hghZLSltw.0

Failure log: https://treeherder.mozilla.org/logviewer?job_id=471467541&repo=autoland&lineNumber=2712

Comment 10

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/872610d57385
Fix missing jsdoc @returns for search code. r=search-reviewers,jteow
https://hg.mozilla.org/integration/autoland/rev/1fff22df3ec5
Fix missing jsdoc @returns for Urlbar code. r=urlbar-reviewers,daisuke
https://hg.mozilla.org/integration/autoland/rev/f0571370f80b
Fix missing jsdoc @returns for places code. r=places-reviewers,daisuke
https://hg.mozilla.org/integration/autoland/rev/35ce6a27b1a3
Fix missing jsdoc @returns for other browser code. r=firefox-desktop-core-reviewers ,backup-reviewers,kpatenio.
https://hg.mozilla.org/integration/autoland/rev/06d1e6e91857
Use typescript Record definitions rather than Object<> generic forms for jsdoc. r=zombie,webdriver-reviewers,omc-reviewers,aminomancer,kpatenio
https://hg.mozilla.org/integration/autoland/rev/73c403373b21
Upgrade eslint-plugin-jsdoc to version 43.2.0. r=frontend-codestyle-reviewers,credential-management-reviewers,issammani
https://hg.mozilla.org/integration/autoland/rev/f613379763f7
Upgrade eslint-plugin-jsdoc to version 50.2.2. r=zombie,frontend-codestyle-reviewers,translations-reviewers,backup-reviewers,kpatenio

Comment 11

[Serban Stanca [:SerbanS]]

https://hg.mozilla.org/mozilla-central/rev/872610d57385
https://hg.mozilla.org/mozilla-central/rev/1fff22df3ec5
https://hg.mozilla.org/mozilla-central/rev/f0571370f80b
https://hg.mozilla.org/mozilla-central/rev/35ce6a27b1a3
https://hg.mozilla.org/mozilla-central/rev/06d1e6e91857
https://hg.mozilla.org/mozilla-central/rev/73c403373b21
https://hg.mozilla.org/mozilla-central/rev/f613379763f7