1460100 - Add ESLint rule to prevent use of nsIScriptableUnicodeConverter

Status: RESOLVED FIXED

(Developer Infrastructure :: Lint and Formatting, enhancement)

Description

[Kris Maglione [:kmag]]

nsIScriptableUnicodeConverter is going away, but that fact unfortunately does not stop people from cargo culting existing uses of it for new code.

We should add a rule to point people who try to use it to TextEncoder().

Comment 1

[Mark Banner (:standard8)]

I'm happy to mentor this. Here's what I think we should do:

• Create a new rule, i.e. reject-scriptableunicodeconverter, this can be based on the existing reject-osfile rule. This should largely be duplicating the existing references to reject-osfile and then updating the rule & test.
  • The rule should pick up on the use of Ci.nsIScriptableUnicodeConverter in code.
• The rule can be tested via the unit tests
• The rule should also be tested against the full tree using ./mach eslint --warnings (note there are currently other warnings output as well at the moment.
• Ensure documentation is added similar to the existing .rst file, documentation can be checked via ./mach doc

Comment 2

[onuohaoluebube05]

Hello,

Should the rules be in the same files with the "reject-osfile" or in the a separate file in the same folder.

Thanks

Comment 3

[Mark Banner (:standard8)]

As discussed on Matrix, these should be a separate file in the same folder.

Comment 4

[onuohaoluebube05]

Attachment: Bug 1460100 - Added ESLint rule to prevent use of nsIScriptableUnicodeConverter r?Standard8

Comment 5

[onuohaoluebube05]

I just submitted a patch for this bug. Please review and guide me on the next step forward.

Thanks.

Comment 6

[onuohaoluebube05]

Hello,

I actually forgot to do hg add

Have done that.

Thanks

Comment 7

[Mark Banner (:standard8)]

No need to request info / comment when submitting a patch - review requests are automatically notified to us.

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/3c2ab42e8391
Added ESLint rule to prevent use of nsIScriptableUnicodeConverter r=Standard8

Comment 9

[Sebastian Hengst [:aryx] (needinfo me if it's about an intermittent or backout)]

https://hg.mozilla.org/mozilla-central/rev/3c2ab42e8391