1814289 - Apply the new jsdoc eslint rules to the new translations component

Status: RESOLVED FIXED

(Firefox :: Translations, task, P2)

Description

[Greg Tatum [:gregtatum]]

In the review for the about:translations prototype, :mconley said:

Along with adding a new folder, now is a really good time to make sure that anything new that gets added in here abides by some stricter linting codes that are still coming down the pike.

An ESLint rule for requiring valid jsdoc is something I can recommend, for example: https://searchfox.org/mozilla-central/rev/8e9b4484408154b80d7ede9e1b035819fda48fd2/browser/components/migration/.eslintrc.js#8

I enabled the rule, but had some feedback. Rather than doing that in the initial prototype, this bug tracks that action.

Comment 1

[bikid475]

@Greg Tantum would like to work on this issue, as part of the translation task, i have setup the Firefox Project locally.

Comment 2

[nzai]

Attachment: I created a simple eslint rule for the translation. any reviews or changes requests will be highly appreaciated. thank you

Comment 3

[Greg Tatum [:gregtatum]]

Attachment: Bug 1814289 - Enable the jsdoc lint rule for translations and run auto-fix; r?#translations-reviewers!

There will be lint errors reported, as the following patch will manually
fix the remaining errors.

Comment 4

[Greg Tatum [:gregtatum]]

Attachment: Bug 1814289 - Manually fix jsdoc lint violations; r?#translations-reviewers!

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/5a7c7d576a78
Enable the jsdoc lint rule for translations and run auto-fix; r=translations-reviewers,nordzilla
https://hg.mozilla.org/integration/autoland/rev/9f4bfb69a2bd
Manually fix jsdoc lint violations; r=translations-reviewers,nordzilla

Comment 6

[Atila Butkovits]

https://hg.mozilla.org/mozilla-central/rev/5a7c7d576a78
https://hg.mozilla.org/mozilla-central/rev/9f4bfb69a2bd