1869678 - Improve JSDocs to help with type inference

Status: RESOLVED FIXED

(WebExtensions :: General, task, P3)

Description

[Tomislav Jovanovic :zombie]

We have documented many of our functions and classes using JSDocs, but because no system actually tries to use (or test) those types, many of them are often slightly "wrong".

Comment 1

[Tomislav Jovanovic :zombie]

Attachment: Bug 1869678 - Fixup and improve JSDocs for better type inference r?rpl,robwu

Comment 2

[Tomislav Jovanovic :zombie]

Attachment: Bug 1869678 - Use more idiomatic code patterns for better type inference r?rpl,robwu

These fall under 5 main categories:

1. Declare and/or initialize all class fiels in the constructor.
   (general good practise)

2. Use real getters and redefineLazyGetter instead of defineLazyGetter.
   (also keeps related code closer together)

3. When subclassing, don't override class fields with getters (or vice versa).
   https://github.com/microsoft/TypeScript/pull/33509

4. Declare and assign object literals at the same time, not separatelly.
   (don't use let foo; at the top of the file, use var foo = {)

5. Don't re-use local variables unnecesarily with different types.
   (general good practise, local variables are "free")

Depends on D196385

Comment 3

[Tomislav Jovanovic :zombie]

Attachment: Bug 1869678 - Fix misc bugs identified by type inference r?rpl,robwu

Depends on D196386

Comment 4

[Tomislav Jovanovic :zombie]

Attachment: Bug 1869678 - Add tsconfig, basic types, and fix or ignore remaining type errors r?rpl,robwu

Depends on D196387

Comment 5

[Phabricator Automation]

Comment on attachment 9368580 [details]
Bug 1869678 - Add tsconfig, basic types, and fix or ignore remaining type errors r?rpl,robwu

Revision D196388 was moved to bug 1871127. Setting attachment 9368580 [details] to obsolete.

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/1c6e48c2b096
Fixup and improve JSDocs for better type inference r=robwu
https://hg.mozilla.org/integration/autoland/rev/8e768446e17c
Use more idiomatic code patterns for better type inference r=robwu
https://hg.mozilla.org/integration/autoland/rev/81e9c0d20939
Fix misc bugs identified by type inference r=robwu

Comment 7

[Natalia Csoregi [:nataliaCs]]

https://hg.mozilla.org/mozilla-central/rev/1c6e48c2b096
https://hg.mozilla.org/mozilla-central/rev/8e768446e17c
https://hg.mozilla.org/mozilla-central/rev/81e9c0d20939

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/3b127f7cce0f
adjust Thunderbird jsdoc to be valid after bug 1869678. rs=eslint